Skip to main content

Example Page

1   # Site Title

Big Headings should only be used for the title of the page. They also do not appear in the table of contents on the right. Headings should be short and descriptive.

Chapter​

1   ## This is a chapter

These smaller headings should be used for chapters within this site.

Subchapter​

1   ### This is a subchapter

These are the smallest headings you should use and these are for subchapters within chapters.

warning

Do not use bold text instead of headings

Writing Style​

The documentation should mainly consist of continuous text. The text should be formal and objective.

warning

Do not use I or we.

Bullet Points​

1   * This is a bullet point
  • Bullet points should be used to give a short overview over things

Enumerations​

1   1. this
2   2. is
3   3. a
4   4. enumeration
  1. Enumerations should be used if you describe something that has an order, e.g. setting up Firmware_Vault
  2. They could also be used, when a picture has numbers in it to describe different components

Tables​

1   |a|b|
2   |-|-|
ab

Can be used for giving a short overview over a group of things.

Style​

Pictures​

Pictures should be designed, especially if they have a transparent background, to be readable in light- and darkmode.

Notes, Info and Warnings​

note

For notes use this

1   :::note
2
3   Notable note 
4   :::
info

For info use this

1   :::info
2
3   Informing info
4   :::
warning

For warning use this

1   :::warning
2
3   This is a Warning
4   :::

If you mention another site of this documentation, add a link. E.g. This is what you can find in the Edit Documentation documentation.

1   [Text that should be linked](path/to/destination.md#and-maybe-chapter)

Italic and Bold Text​

Bold text should be used, if you want to emphasize a word in the context.

1   **text to emphasize**


Italic text should not be used.

1   *italic text*

Code​

If you want to display code, do not use pictures but write it into the markdown file like this:

1   ```used_language
2   code
3   and
4   more
5   code
6   ```
def func():
    print("this is a demo")

If you want to mention code in you continuous text, use this.

1   `this is a snippet of code to use in a continuous text`