Markdown

Markdown is a lightweight markup language. It offers an easy-to-read and easy-to-write syntax in its unformatted form. It is possible to add YAML metadata at the beginning of the file.

In programming, Markdown is the preferred format for writing the documentation websites as well as the README.md files, the main entry points of the projects. Markdown is also used to write the pages of static websites (Wikipedia), as well as forums, messaging or knowledge bases and note-taking tools.

Example of Markdown code:

  # Title 1

  Some text

  1. Ordered list 1
  1. Ordered list 2

  ## Title 2

  - Unordered list 1
  - Unordered list 2

The result in html is the following:

  <h1 id="title-1">Title 1</h1>
  <p>Some text</p>
  <ol>


 <li>Ordered list 1</li>


 <li>Ordered list 2</li>
  </ol>
  <h2 id="titre-2">Titre 2</h2>
  <ul>


 <li>Unordered list 1</li>


 <li>Unordered list 2</li>
  </ul>
  <blockquote>


 <p>Blockquote </p>
  </blockquote>