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

new page: code_samples.md

Browse Source
This commit is contained in:
Yann Cébron 2021-06-03 15:24:41 +02:00
parent 89fa711c18
commit 6d762e7a4e
2 changed files with 30 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ijs.tree
View File

@ -16,6 +16,7 @@
</toc-element> </toc-element>
<toc-element id="intellij-sdk-docs-original_CODE_OF_CONDUCT.md"/> <toc-element id="intellij-sdk-docs-original_CODE_OF_CONDUCT.md"/>
</toc-element> </toc-element>
<toc-element id="code_samples.md"/>
<toc-element id="getting_help.md"/> <toc-element id="getting_help.md"/>
<toc-element id="content_updates.md" accepts-web-file-names="recently_updated.html"/> <toc-element id="content_updates.md" accepts-web-file-names="recently_updated.html"/>
</toc-element> </toc-element>
@ -23,7 +24,6 @@
<toc-element id="basics.md" accepts-web-file-names="basics.html"> <toc-element id="basics.md" accepts-web-file-names="basics.html">
<toc-element id="types_of_plugins.md"/> <toc-element id="types_of_plugins.md"/>
</toc-element> </toc-element>
<toc-element toc-title="Code Samples" href="https://github.com/JetBrains/intellij-sdk-code-samples"/>
<toc-element id="getting_started.md"> <toc-element id="getting_started.md">
<toc-element id="github_template.md" toc-title="Using GitHub Template"/> <toc-element id="github_template.md" toc-title="Using GitHub Template"/>
<toc-element id="gradle_build_system.md" accepts-web-file-names="build_system.html" <toc-element id="gradle_build_system.md" accepts-web-file-names="build_system.html"

29
topics/intro/code_samples.md Normal file
View File

@ -0,0 +1,29 @@
[//]: # (title: Code Samples)
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
## Introduction
This guide comes with a number of sample plugins available from dedicated [intellij-sdk-code-samples](https://github.com/JetBrains/intellij-sdk-code-samples) GitHub repository.
Please see <path>README.md</path> which lists all available code samples with a short description.
Each sample is stored in a dedicated folder and is accompanied by its own <path>README.md</path>. Links to the corresponding tutorial or reference page in this tutorial, as well as a list of relevant show-cased elements are provided.
## Setting up Code Samples
All sample plugins are based on Gradle, see [Building Plugins with Gradle](gradle_build_system.md) to get started. Additionally, the screencast [Working with Gradle in IntelliJ IDEA](https://www.youtube.com/watch?v=6V6G3RyxEMk) offers a thorough introduction to Gradle functionality.
Make sure plugins _Git_, _Gradle_, and _Plugin DevKit_ are enabled.
Clone the [intellij-sdk-code-samples](https://github.com/JetBrains/intellij-sdk-code-samples) GitHub repository via <control>Git | Clone...</control>. After successful cloning, the IDE suggests opening the project.
Select the code sample(s) to import via the [Gradle tool window](https://www.jetbrains.com/help/idea/gradle.html#link_gradle_project).
Alternatively, import _all_ code samples available by choosing `_gradleCompositeBuild`, which links all Gradle projects in a Composite Build.
After successful import, the project appears in the Gradle tool window tree as a new node.
## Running Code Samples
Run the plugin by using the Gradle [runIde task](gradle_prerequisites.md#executing-the-plugin) shown under the corresponding project's <control>Tasks</control> node.