mirror of
https://github.com/JetBrains/intellij-platform-plugin-template.git
synced 2024-10-27 20:44:05 +00:00
52 lines
3.3 KiB
Markdown
52 lines
3.3 KiB
Markdown
# %NAME%
|
|
|
|
|
|
[](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)
|
|
[](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)
|
|
|
|
## Template ToDo list
|
|
- [x] Create a new [IntelliJ Platform Plugin Template][template] project.
|
|
- [ ] Get familiar with the [template documentation][template].
|
|
- [ ] Adjust the [pluginGroup](./gradle.properties) and [pluginName](./gradle.properties), as well as the [id](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin).
|
|
- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description])
|
|
- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate).
|
|
- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.
|
|
- [ ] Set the `MARKETPLACE_ID` in the above README badges. You can obtain it once the plugin is published to JetBrains Marketplace.
|
|
- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables).
|
|
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate).
|
|
- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.
|
|
|
|
<!-- Plugin description -->
|
|
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
|
|
|
|
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
|
|
|
|
To keep everything working, do not remove `<!-- ... -->` sections.
|
|
<!-- Plugin description end -->
|
|
|
|
## Installation
|
|
|
|
- Using the IDE built-in plugin system:
|
|
|
|
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "%NAME%"</kbd> >
|
|
<kbd>Install</kbd>
|
|
|
|
- Using JetBrains Marketplace:
|
|
|
|
Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID) and install it by clicking the <kbd>Install to ...</kbd> button in case your IDE is running.
|
|
|
|
You can also download the [latest release](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID/versions) from JetBrains Marketplace and install it manually using
|
|
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
|
|
|
|
- Manually:
|
|
|
|
Download the [latest release](https://github.com/%REPOSITORY%/releases/latest) and install it manually using
|
|
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
|
|
|
|
|
|
---
|
|
Plugin based on the [IntelliJ Platform Plugin Template][template].
|
|
|
|
[template]: https://github.com/JetBrains/intellij-platform-plugin-template
|
|
[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation
|