doc/doc_markdown_guide.md

Markdown Guide

Index

• The different title levels
• Paragraph formatting
• Link creation
  • Anchor creation
• Display images
• [Citation formatting](#CitationFormatting
• Lists
  • Ordered
  • Unordered
• Tables
• Code segments

Markdown is a markup language from 2004, with many add-ons supporting its function and existence. This guide explores the possibilities and formatting of the language in the context of YunoHost documentation, and not the Markdown language on its own.

Markdown allows formatting of text using tags, in human-readable format; even with formatting. Outside of plaintext editors, a number of specific programs exist. (Markdown on [framalibre.org] (https://framalibre.org/recherche-par-crit-res?keys=markdown)). It is easy to deal with.

The different title levels

Write headlines like this:

# Level 1
## Level 2
### Level 3
#### Level 4
##### Level 5
###### Level 6