Wiki style guidelines
This topic is now part of the original documentation.
Continue to the original article
Find a saved section
- Structure of the wiki
- structure-of-the-wiki
- Conventions
- conventions
- Add a table of contents wherever possible
- add-a-table-of-contents-wherever-possible
- Avoid repetition
- avoid-repetition
- Avoid using abbreviations in page titles
- avoid-using-abbreviations-in-page-titles
- Prefer wiki headings over plain bold text
- prefer-wiki-headings-over-plain-bold-text
- Use code blocks for UI elements
- use-code-blocks-for-ui-elements
- Make software screenshots aesthetically consistent
- make-software-screenshots-aesthetically-consistent
- Use consistent markup for images
- use-consistent-markup-for-images
- Use admonition blocks for stand-out warnings and notes
- use-admonition-blocks-for-stand-out-warnings-and-notes
- Use gerunds for page titles
- use-gerunds-for-page-titles
- Avoid commercial links
- avoid-commercial-links