Skip to main content

Markdown

note

((This style guide is incomplete!))

Tabs and spacing​

The use of the normal tab (also known as a hard tab) character (\t) is not allowed! You may use two whitespace characters instead of tabs to space code!

- **What spacing is allowed?**
	- This is not allowed! (used \t)
    - This is not allowed!
  - This is correct! (used 2 whitespace characters)

File start​

All markdown files should start with a main headline, or a meta data block!

---
name: value
---

# File Headline

<!--
  Date example: May 21st, 2024
-->

Capitalisation​

All headlines should be capitalised. And the contents of the markdown file should be capitalised according to normal capitalisation rules in English.