diff --git a/topics/intro/sdk_style.md b/topics/intro/sdk_style.md index 640c2906a..0183d2d49 100644 --- a/topics/intro/sdk_style.md +++ b/topics/intro/sdk_style.md @@ -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: plugin.xml. * When using \$PLACEHOLDER\$ in non-code parts, it must be escaped: `\$PLACEHOLDER\$/somePath`. * Keyboard shortcuts are wrapped using ``: `press Alt+Insert` becomes "press Alt+Insert". -* 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 @@ -139,7 +140,7 @@ General Markdown links have the default Markdown link style: #### 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 v.list. * `[README.md](%\gh-ic%/README.md)`{disable-links} links to any general, non-code information files. ([README.md](%gh-ic%/README.md)) @@ -171,12 +172,18 @@ In-paragraph code fragments and IntelliJ Platform APIs are formatted according t #### Extension Points -Use `` snippet to introduce EP. +Use `` snippet to introduce EP: + +- + +Use `` for variant without "extension point" suffix: + +- #### XML -* For XML elements, use the tag notation with syntax highlighting: ``. - Attributes are shown with syntax highlighting, and attribute values are shown in quotes: `since-build="191"` +For XML elements, use the tag notation with syntax highlighting: ``. +Attributes are shown with syntax highlighting, and attribute values are shown in quotes: `since-build="191"` ### Source Code