Skip to content

Markdown Reference

Quick markdown and mkdocs reference list.
See the official documentation for more.

Typography

Title

# Titre 1
## Titre 2: First level
### Titre 3 : second level
#### Titre 4 : not in the menu

Formatting

normal text 
**bold text**
*italic text*
==This was marked (highlight)==
^^This was inserted (underline)^^
~~This was deleted (strikethrough)~~

normal text
bold text
italic text
This was marked (highlight)
This was underline
This was deleted (strikethrough)

Adding keyboard keys

Keyboard keys
++ctrl+alt+del++

Ctrl+Alt+Del

Citation

> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Maths

Using block syntax

Blocks must be enclosed in $$...$$ or \[...\] on separate lines:

block syntax
$$
\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k}
$$
\[ \cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} \]

Using inline syntax

Inline blocks must be enclosed in $...$ or \(...\):

inline syntax
The homomorphism $f$ is injective if and only if its kernel is only the
singleton set $e_G$, because otherwise $\exists a,b\in G$ with $a\neq b$ such
that $f(a)=f(b)$.

The homomorphism \(f\) is injective if and only if its kernel is only the singleton set \(e_G\), because otherwise \(\exists a,b\in G\) with \(a\neq b\) such that \(f(a)=f(b)\).

Internal
[Starting Package](/starting-package)

Starting Package

External
[arXiv](https://www.arxiv.org)

arXiv

List

Unordered lists

Unordered lists can be written by prefixing a line with a -, * or + list marker, all of which can be used interchangeably. Furthermore, all flavors of lists can be nested inside each other:

List, unordered
- Nulla et rhoncus turpis. Mauris ultricies elementum leo. 

    * Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
    * Nam vulputate tincidunt fringilla.
    * Nullam dignissim ultrices urna non auctor.

  • Nulla et rhoncus turpis. Mauris ultricies elementum leo.

    • Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
    • Nam vulputate tincidunt fringilla.
    • Nullam dignissim ultrices urna non auctor.

Ordered lists

Ordered lists must start with a number immediately followed by a dot. The numbers do not need to be consecutive and can be all set to 1., as they will be re-numbered when rendered:

List, ordered
1.  Vivamus id mi enim. Integer id turpis sapien. 

    1.  Vivamus venenatis porttitor tortor sit amet rutrum. 
    2.  Morbi eget dapibus felis. 

        1.  Mauris dictum mi lacus
        2.  Ut sit amet placerat ante
        3.  Suspendisse ac eros arcu

  1. Vivamus id mi enim. Integer id turpis sapien.

    1. Vivamus venenatis porttitor tortor sit amet rutrum.

    2. Morbi eget dapibus felis.

      1. Mauris dictum mi lacus
      2. Ut sit amet placerat ante
      3. Suspendisse ac eros arcu

Definition lists

When [Definition Lists] is enabled, lists of arbitrary key-value pairs, e.g. the parameters of functions or modules, can be enumerated with a simple syntax:

Definition list
`Lorem ipsum dolor sit amet`

:   Sed sagittis eleifend rutrum. 

`Cras arcu libero`

:   Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. 

    Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
    Nam vulputate tincidunt fringilla.
Lorem ipsum dolor sit amet

Sed sagittis eleifend rutrum.

Cras arcu libero

Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex.

Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis. Nam vulputate tincidunt fringilla.

Task lists

Unordered list items can be prefixed with [ ] to render an unchecked checkbox or [x] to render a checked checkbox, allowing for the definition of task lists:

Task list
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
- [ ] Vestibulum convallis sit amet nisi a tincidunt
    * [x] In hac habitasse platea dictumst
    * [ ] Praesent sed risus massa
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
  • Lorem ipsum dolor sit amet, consectetur adipiscing elit
  • Vestibulum convallis sit amet nisi a tincidunt
    • In hac habitasse platea dictumst
    • Praesent sed risus massa
  • Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

Groups

Grouping code blocks

Code blocks are one of the primary targets to be grouped, and can be considered a special case of content tabs, as tabs with a single code block are always rendered without horizontal spacing:

Content tabs with code blocks
=== "C"

    ``` c
    #include <stdio.h>

    int main(void) {
      printf("Hello world!\n");
      return 0;
    }
    ```

=== "C++"

    ``` c++
    #include <iostream>

    int main(void) {
      std::cout << "Hello world!" << std::endl;
      return 0;
    }
    ```

#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

Table

A simple table
| Syntax | Description |
| ------ | ----------- |
| Header | Title |
| Paragraph | Text |
Syntax Description
Header Title
Paragraph Text

Raise attention

Annotations

Annotations consist of two parts: a marker, which can be placed anywhere in a block marked with the annotate class, and content located in a list below the block containing the marker:

Text with annotations
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }

1.  :man_raising_hand: I'm an annotation! I can contain `code`, __formatted
    text__, images, ... basically anything that can be expressed in Markdown.

Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.

  1. 🙋‍♂️ I'm an annotation! I can contain code, formatted text, images, ... basically anything that can be written in Markdown.

Box

Boxes follow a simple syntax: a block starts with !!!, followed by a single keyword used as a [type qualifier]. The content of the block follows on the next line, indented by four spaces:

Box
!!! note

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus.

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus.

Collapsible box

When [Details] is enabled and the block is started with ??? instead of !!!, the admonition is rendered as a collapsible block with a small toggle on the right side:

Collapsible
??? note

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.
Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Possible type of boxes.

  • note:
  • abstract:
  • info:
  • tip:
  • success:
  • question:
  • warning:
  • failure:
  • danger:
  • bug:
  • example:
  • quote:

Footnotes

Here's a sentence with a footnote. 1

Here's a sentence with a footnote. [^1]
[^1]: This is the footnote.

Images

Syntax

Simple syntax is 

![Mon Image](https://dummyimage.com/800x600/)

Image folder

Images are stored in /assets/img/
Logo

Image size

Smaller images could be rendered using { width=200 } attribute

Image size and location
![Logo](/assets/img/LKB_Logo.png){ width=200 }

Image alignment

When [Attribute Lists] is enabled, images can be aligned by adding the respective alignment directions via the align attribute, i.e. align=left or align=right:

Image, aligned to left
![Image title](https://dummyimage.com/600x400/eee/aaa){ align=left }

Image title

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

  1. This is the footnote. ↩