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

sdk_style.md: note about linebreaks for content

Browse Source
This commit is contained in:
Yann Cébron 2022-01-17 18:00:04 +01:00
parent ee838b37a3
commit b958258fbd
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
topics/intro/sdk_style.md
View File

@ -40,6 +40,11 @@ Consistent terminology helps the reader grasp new concepts more quickly:
However, only use product names when extensibility or functionality is particular to a product.
### Text Format Conventions
Start every sentence on a new line.
For very long sentences, add additional line breaks after `,`, `:` or other sensible places.
Very long links should also be on a separate line.
Consistent text styles are used to standardize references and keywords:
* Menu paths are wrapped using `<menupath>` with pipe characters separating each level: `<menupath>Settings/Preferences | Editor</menupath>`: <menupath>Settings/Preferences | Editor</menupath>
Menu paths to settings always start with "Settings/Preferences" to cover all platforms. Inside tables, use `&#124;` instead of `|` to prevent escaping problems.