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

sdk_style.md: cleanup

Browse Source
This commit is contained in:
Yann Cébron 2025-04-10 14:05:21 +02:00
parent fb78f5363e
commit 1a0f357c55
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
topics/intro/sdk_style.md
View File

@ -95,8 +95,9 @@ Consistent text styles are used to standardize references and keywords:
* Filename extensions are not capitalized when part of a full filename, path, or URL: <path>plugin.xml</path>. * Filename extensions are not capitalized when part of a full filename, path, or URL: <path>plugin.xml</path>.
* When using \$PLACEHOLDER\$ in non-code parts, it must be escaped: `<path>\$PLACEHOLDER\$/somePath</path>`. * When using \$PLACEHOLDER\$ in non-code parts, it must be escaped: `<path>\$PLACEHOLDER\$/somePath</path>`.
* Keyboard shortcuts are wrapped using `<shortcut>`: `press <shortcut>Alt+Insert</shortcut>` becomes "press <shortcut>Alt+Insert</shortcut>". * Keyboard shortcuts are wrapped using `<shortcut>`: `press <shortcut>Alt+Insert</shortcut>` becomes "press <shortcut>Alt+Insert</shortcut>".
* See [Guidelines for Highlighting Syntax](#guidelines-for-highlighting-syntax) for best practices for representing code fragments.
* See [Links to IntelliJ Platform Source](#links-to-intellij-platform-source) for more details about representing names of source files in links. See [Guidelines for Highlighting Syntax](#guidelines-for-highlighting-syntax) for best practices for representing code fragments.
See [Links to IntelliJ Platform Source](#links-to-intellij-platform-source) for more details about representing names of source files in links.
### Links ### Links
@ -139,7 +140,7 @@ General Markdown links have the default Markdown link style:
#### Links to IntelliJ Platform Source #### Links to IntelliJ Platform Source
Links to files in the IntelliJ Platform (`intellij-community`) repository use the `%\gh-ic%` prefix instead of the full URL to the repository. Links to files in the IntelliJ Platform ([`intellij-community`](%gh-ic%/README.md)) repository use the `%\gh-ic%` prefix instead of the full URL to the repository.
Links to files in source code packages in other GitHub repositories follow the same rules, except the links use a different custom `gh-...` prefix defined in <path>v.list</path>. Links to files in source code packages in other GitHub repositories follow the same rules, except the links use a different custom `gh-...` prefix defined in <path>v.list</path>.
* `[README.md](%\gh-ic%/README.md)`{disable-links} links to any general, non-code information files. ([README.md](%gh-ic%/README.md)) * `[README.md](%\gh-ic%/README.md)`{disable-links} links to any general, non-code information files. ([README.md](%gh-ic%/README.md))
@ -171,11 +172,17 @@ In-paragraph code fragments and IntelliJ Platform APIs are formatted according t
#### Extension Points #### Extension Points
Use `<include from="snippets.topic" element-id="ep"><var name="ep" value="fqn.of.ep"/></include>` snippet to introduce EP. Use `<include from="snippets.topic" element-id="ep"><var name="ep" value="fqn.of.ep"/></include>` snippet to introduce EP:
- <include from="snippets.topic" element-id="ep"><var name="ep" value="fqn.of.ep"/></include>
Use `<include from="snippets.topic" element-id="epLink"><var name="ep" value="fqn.of.ep"/></include>` for variant without "extension point" suffix:
- <include from="snippets.topic" element-id="epLink"><var name="ep" value="fqn.of.ep"/></include>
#### XML #### XML
* For XML elements, use the tag notation with syntax highlighting: `<idea-version>`. For XML elements, use the tag notation with syntax highlighting: `<idea-version>`.
Attributes are shown with syntax highlighting, and attribute values are shown in quotes: `since-build="191"` Attributes are shown with syntax highlighting, and attribute values are shown in quotes: `since-build="191"`
### Source Code ### Source Code