hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

notes about installing Plugin DevKit manually in 2023.3+

Browse Source
This commit is contained in:
Yann Cébron 2023-10-23 17:12:00 +02:00
parent fc8e64fe8e
commit f105fb0586
5 changed files with 31 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
topics/_shared/snippets.md
View File

@ -22,6 +22,15 @@
</snippet>
<snippet id="pluginDevKitAvailability">
> When using IntelliJ IDEA 2023.3 or later, the <control>Plugin DevKit</control> plugin must be installed from JetBrains Marketplace ([Plugin Homepage](https://plugins.jetbrains.com/plugin/22851-plugin-devkit))
> as it is no longer bundled with the IDE.
>
{title="Plugin DevKit Availability" style="warning"}
</snippet>
<snippet id="jetbrainsProductOpenSourceLicense">
> Qualifying Open Source projects can [apply for free licenses](https://www.jetbrains.com/community/opensource/) of JetBrains products.

15
topics/basics/getting_started/plugin/developing_plugins.md
View File

@ -1,26 +1,27 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Developing a Plugin
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Develop an IntelliJ Platform plugin using Gradle and Gradle IntelliJ Plugin.</link-summary>
IntelliJ Platform plugins can be developed by using either [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) or [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/) as your IDE.
Both include the complete set of plugin development tools.
It is highly recommended to always use the latest available version, as the plugin development tooling support from bundled <control>Plugin DevKit</control> continues supporting new features.
To become more familiar with IntelliJ IDEA, please refer to the [IntelliJ IDEA Web Help](https://www.jetbrains.com/idea/help/).
It is highly recommended to always use the latest available version, as the plugin development tooling support from <control>Plugin DevKit</control> continues supporting new features.
Before starting with the actual development, make sure to understand all requirements to achieve best [](plugin_user_experience.md).
> In some cases, implementing an actual IntelliJ Platform plugin might not be necessary, as [alternative solutions](plugin_alternatives.md) exist.
>
{title="Plugin Alternatives"}
## Gradle IntelliJ Plugin
The recommended solution for building IntelliJ Platform plugins is [](tools_gradle_intellij_plugin.md).
The IntelliJ IDEA Ultimate and Community editions bundle the necessary plugins to support Gradle-based plugin development: _Gradle_ and _Plugin DevKit_.
The IntelliJ IDEA Ultimate and Community editions provide the necessary plugins to support Gradle-based plugin development: _Gradle_ and _Plugin DevKit_.
To verify these plugins are installed and enabled, see the help section about [Managing Plugins](https://www.jetbrains.com/help/idea/managing-plugins.html).
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
Gradle IntelliJ Plugin manages the dependencies of a plugin project - both the base IDE and other [plugin dependencies](plugin_dependencies.md).
It provides tasks to run the IDE with your plugin and to package and [publish](publishing_plugin.md#publishing-plugin-with-gradle) your plugin to the [JetBrains Marketplace](https://plugins.jetbrains.com).
To make sure that a plugin is not affected by [API changes](api_changes_list.md), which may happen between major releases of the platform, you can quickly verify your plugin against other IDEs and releases.

8
topics/basics/getting_started/theme/creating_theme_project.md
View File

@ -1,14 +1,14 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Creating a Theme Project
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Creating a theme plugin project with Plugin DevKit wizard and generated project overview.</link-summary>
This documentation page describes a DevKit-based theme project generated with the [New Project Wizard](https://www.jetbrains.com/help/idea/new-project-wizard.html).
## Creating a Theme with New Project Wizard
Before creating a theme project, make sure that [development environment is set up](setting_up_theme_environment.md).
> Before creating a theme project, make sure that [development environment is set up](setting_up_theme_environment.md).
<procedure title="Create Theme Plugin" id="create-theme">
@ -51,7 +51,7 @@ See [](theme_structure.md) for more details.
Theme plugin project [created with the new project wizard](#create-theme) contains a single theme description file by default.
In case a plugin needs to provide multiple themes (e.g., dark and light variants), it is possible to add them with the dedicated action.
Additional plugin themes can be added using the DevKit Theme Wizard, which is a part of the Plugin DevKit bundled in IntelliJ IDEA.
Additional plugin themes can be added using the DevKit Theme Wizard, which is a part of the <control>Plugin DevKit</control> plugin.
The wizard can be used for both DevKit-based and Gradle-based plugins.
<procedure title="Add Theme" id="add-theme">

7
topics/basics/getting_started/theme/setting_up_theme_environment.md
View File

@ -1,7 +1,7 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Setting Up a Development Environment
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Setting up a development environment required for developing a theme.</link-summary>
<procedure title="Preliminary Steps">
@ -9,7 +9,8 @@
Use the following checklist to ensure that you are ready to develop your custom theme:
1. **[IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/)** or **[IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/)** is installed.
2. **Plugin DevKit** plugin is [enabled in IntelliJ IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html).
2. **Plugin DevKit** plugin is installed and [enabled in IntelliJ IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html).
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
3. **IntelliJ IDEA CE source code** is checked-out. _(Optional)_
This step is needed only when you plan to debug the IntelliJ Platform code.

9
topics/tutorials/custom_language_support/prerequisites.md
View File

@ -1,7 +1,7 @@
# 1. Prerequisites
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 1. Prerequisites
<link-summary>Steps required before starting implementation of a sample custom language support.</link-summary>
<include from="language_and_filetype.md" element-id="custom_language_tutorial_header"></include>
@ -20,7 +20,10 @@ Download the IntelliJ IDEA Community Edition source files as described in the In
## Install Required Plugins
Make sure that the bundled *Plugin DevKit* and *Gradle* plugins are enabled.
Make sure that the _Plugin DevKit_ and _Gradle_ plugins are enabled.
<include from="snippets.md" element-id="pluginDevKitAvailability"/>
Install and enable [Grammar-Kit](https://plugins.jetbrains.com/plugin/6606-grammar-kit) and [PsiViewer](https://plugins.jetbrains.com/plugin/227-psiviewer) plugins.
## Create a Project