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

sdk_style.md: Cleanups

Browse Source
This commit is contained in:
Karol Lewandowski 2023-04-07 14:50:27 +02:00
parent 4dafd0a0e7
commit 09afd90b7c
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
topics/intro/sdk_style.md
View File

@ -1,6 +1,6 @@
# SDK Docs Style Guide <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- Copyright 2000-2023 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. --> # SDK Docs Style Guide
<link-summary>Writing and notation styleguide for SDK Docs.</link-summary> <link-summary>Writing and notation styleguide for SDK Docs.</link-summary>
@ -59,7 +59,7 @@ The page title should be as concise as possible, so it can be reused in the [](#
Every page **should** provide a short excerpt (usually one sentence) using dedicated `<link-summary>` tag before the main page contents: Every page **should** provide a short excerpt (usually one sentence) using dedicated `<link-summary>` tag before the main page contents:
```html ```html
<link-summary>Listeners allow subscription to application and project events.</link-summary> <link-summary>Defining groups of related settings.</link-summary>
``` ```
#### Highlighted Links #### Highlighted Links
@ -110,7 +110,7 @@ Consistent text styles are used to standardize references and keywords:
* File formats are shown as all capital letters: PNG and XML. * File formats are shown as all capital letters: PNG and XML.
* 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>.
* 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 more best practices for representing code fragments. * 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 [Links to IntelliJ Platform Source](#links-to-intellij-platform-source) for more details about representing names of source files in links.
### Links ### Links
@ -127,6 +127,7 @@ In some cases (e.g., the same heading text appears multiple times on the same pa
### Properties ### Properties
{#task1-properties} {#task1-properties}
[...] [...]
## Task 2 ## Task 2
### Properties ### Properties
{#task2-properties} {#task2-properties}
@ -194,7 +195,7 @@ Syntax highlighting is applied by specifying the language after the first set of
``` ```
```xml ```xml
<tagName attribute="value">XML Text</tagName> <tagName attribute="value">XML Text</tagName>
``` ```
``` ```
@ -345,6 +346,6 @@ Specify the previous path(s) including <path>.html</path> extension in `accepts-
```xml ```xml
<toc-element <toc-element
id="fundamentals.md" id="themes_getting_started.md"
accepts-web-file-names="reference_guide.html,architectural_overview.html"/> accepts-web-file-names="themes.html,themes-intro.html"/>
``` ```