Skip to content

Best practices

links: Index


Spaces

  • Courage to leave a gap!
  • Leave a space before and after a heading
  • Leave a space before and after an image
  • Leave a space before and after a list
Text before a list:
- Item 1 --> Wrong! This will not be rendered as list!
- Item 2

---

Text before a list:

- Item 1 --> Correct!
- Item 2
  • If you want to create a "new paragraph" you have to use two "newlines"
**Bold heading**
Text --> Wrong! This will be rendered to "**Bold heading** Text"

---

**Bold heading**

Text --> Correct!

Links

  • Simplify links (e.g. [Index](<./000 Index.md>))

Formatting

  • Create an arrow instead of "->" (e.g. $\rightarrow$)

links: Index