Skip to content

Introduction to MkDocs Markdown

General Formatting

Markdown enables you to have italic, bold, highlighted, underlined, strikethrough and inline code text. Furthermore, you can provide links. In addition to these basic formatting rules you can also decide to includesubscript and evensuperscript, deletions and additions and even comments. For special occassions you can show even keyboard shortcuts: Cmd+C

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
*italic*
**bold**
==highlighted==
^^underlined^^
~~strikethrough~~
`inline code`
 [links](https://www.nexus.ethz.ch/ "Link to the portal")
 text~subscript~
 text^superscript^
 deletions
 additions
 inline comments
 ++cmd+c++

Lists

You can also generate ordered:

  1. ordered
  2. list
1
2
1. ordered
2. list

... and unordered lists:

  • with
  • different
  • symbols
1
2
3
- with
- different
- symbols

... and todo lists:

  • Lorem ipsum dolor sit amet, consectetur adipiscing elit
  • Vestibulum convallis sit amet nisi a tincidunt
    • In hac habitasse platea dictumst
    • In scelerisque nibh non dolor mollis congue sed et metus
    • Praesent sed risus massa
  • Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
1
2
3
4
5
6
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
- [ ] Vestibulum convallis sit amet nisi a tincidunt
    * [x] In hac habitasse platea dictumst
    * [x] In scelerisque nibh non dolor mollis congue sed et metus
    * [ ] Praesent sed risus massa
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque