Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.

Markdown

This is a first level header.

Header Level

This is a second level header.

Third Level Header

You can also just use the hashes syntax instead of the underlines with dashes or equals signs. Add more hashes for deeper nesting.

Paragraphs

To add a paragraph simply write some text and then add two newlines to separate this paragraph from another one.

Like this. Note that it is useful to use hard line wrapping. The alternative, soft wrapping, is when your editor wraps the lines only visually. Consider using your editor to automatically re-wrap paragraphs for you.

Emphasis

You can emphasize like this:

  • italics or italics
  • bold or bold
  • strike-through
  • verbatim

Quoting

This is a block quote.

And another paragraph.

Lists

  • list
  • are
  • very
  • simple
  1. ordered
  2. is also
  3. possible
  • this is a list item

    with another paragraph

Hyperlinks

You can find the complete pandoc Markdown documentation here.

You can also structure this a bit more differently and provide the list of links later or at the end of the file.

Footnotes

You can footnotes to your text like this.1

Bibliography

This one is often cited [see @WatsonCrick1953].

Images

The image caption goes here.

Syntax Highlighting

This is a verbatim text block, also called fenced code block:

This is a so-called fenced block.
Everything inside will be translated verbatim.
No **emphasis** works here.
A fixed-width font is used to display these blocks.

This code block has no syntax highlighting. To enable syntax highlighting, add the language to the starting fence:

# you can also add code blocks with syntax highlighting
# this is an R code snippet
# specify the language at the starting fence

# using fread is much faster
library(data.table)
table <- fread('example.csv')

# than using read.csv
table <- read.csv('example.csv')

Tables

header 1 header 2 header 3
left centered 424242
aligned content 42

LaTeX if you need it

As you can see, Markdown is very simple. If you need more advanced type-setting, you can always fall back to using \LaTeX. You can use inline formulas like

a^2 + b^2 = c^2
. You can also use them standalone:

a^2 + b^2 = c^2

You can do the same with tables and pretty much else.

  1. This looks just like hyperlinks!