Markdown in mkdocs

For full documentation visit mkdocs.org.

Read : Markdown guide for Mkdocs

Basic Syntax

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

Heading

# H1

## H2

### H3

Bold

bold text

Italic

italicized text

Blockquote

blockquote

Ordered List

  1. First item
  2. Second item
  3. Third item

Unordered List

  • First item
  • Second item
  • Third item

Code

code

Horizontal Rule

Markdown Guide

Image

alt text

Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Table

Syntax Description
Header Title
Paragraph Text

Fenced Code Block

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Extensions

Footnotes

Footnotes1 have a label2 and the footnote’s content.

Footnotes[^1] have a label[^@#$%] and the footnote's content.

[^1]: This is a footnote content.

[^@#$%]: A footnote on the label: "@#$%".

Admonition

optional explicit title within double quotes

Any number of other indented markdown elements.

This is the second paragraph.

!!! type "optional explicit title within double quotes"

    Any number of other indented markdown elements.

    This is the second paragraph.

Définition

You should $x=1$ note that the title will be automatically capitalized.

$$\sum\limits_{n=1}^{100} n^2=\ldots$$

!!! Définition

    You should $x=1$ note that the title will be automatically capitalized.

    $$\sum\limits_{n=1}^{100} n^2=\ldots$$

Definition List

Apple
Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
Orange
The fruit of an evergreen tree of the genus Citrus.
Apple
: Pomaceous fruit of plants of the genus Malus in the family Rosaceae.

Orange
: The fruit of an evergreen tree of the genus Citrus.

Emoji 👍

I love you ❤️ and 😂 and 😄 …

♠️ ♦️ ♥️ ♣️ 💠

:spades: :diamonds: :hearts: :clubs: :diamond_shape_with_a_dot_inside:

Emoji list 💬

Details

Docs

Un contenu caché

Une image random

Ça marche

/// details | Un contenu caché
![Une image random](https://dummyimage.com/600x400/000/fff)

Ça marche

///

Caption

Docs

alt text

Figure 1. It is TUX !!!!

![alt text](https://www.markdownguide.org/assets/images/tux.png)
/// figure-caption
It is TUX !!!!
///

Task List

  • item 1
    • item A
    • item B more text
      • item a
      • item b
      • item c
    • item C
  • item 2
  • item 3
- [x] item 1
    - [x] item A
    - [ ] item B
          more text
        - [x] item a
        - [ ] item b
        - [x] item c
    - [x] item C
- [ ] item 2
- [ ] item 3

Mermaid

docs

flowchart TD A[Christmas] -->|Get money| B(Go shopping) B --> C{Let me think} C -->|One| D[Laptop] C -->|Two| E[iPhone] C -->|Three| F[fa:fa-car Car]
```mermaid
flowchart TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[fa:fa-car Car]
```
Arbre de probabilité
graph LR A0(debut) A0 -->|0.5| A1a(S) A0 -->|0.5| A1b(E) A1a -->|0.5| A2a(S) A1a -->|0.5| A2b(E) A1b -->|0.5| A2c(S) A1b -->|0.5| A2d(E)

Mkdocs

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

    mkdocs.yml    # The configuration file.
    docs/
        index.md  # The documentation homepage.
        ...       # Other markdown pages, images and other files.

  1. This is a footnote content. ↩

  2. A footnote on the label: “@#$%”. ↩