Skip to contents

If you’re new to markdown syntax, see the below selection of examples adapted from the Markdown basics Quarto documentation. Reference this primer when working through the tutorials and editing the report content.

Text formatting

Markdown syntax Output
*italics*, **bold**, ***bold italics***
italics, bold, bold italics
superscript^2^ / subscript~2~
superscript2 / subscript2
~~strikethrough~~
strikethrough
`verbatim code`
verbatim code

Headings

Markdown syntax Output
# Header 1

Header 1

Number of # corresponds to header level.
###### Header 6
Header 6
Markdown syntax Output
<https://quarto.org>
https://quarto.org
[Quarto](https://quarto.org)
Quarto
![Caption](images/logo.png){width=100 fig-alt="soils logo"}
Caption
Caption

Learn more in the article on Figures.

Lists

Markdown syntax Output
* unordered list
    + sub-item 1
    + sub-item 2
        - sub-sub-item 1
  • unordered list
    • sub-item 1
    • sub-item 2
      • sub-sub-item 1
*   item 2

    Continued (indent 4 spaces)
  • item 2

    Continued (indent 4 spaces)

1. ordered list
2. item 2
    i) sub-item 1
         A.  sub-sub-item 1
  1. ordered list
  2. item 2
    1. sub-item 1
      1. sub-sub-item 1
(@)  A list whose numbering

continues after

(@)  an interruption
  1. A list whose numbering

continues after

  1. an interruption

Note that unlike other Markdown renderers (notably Jupyter and GitHub), lists in Quarto require an entire blank line above the list. Otherwise the list will not be rendered in list form, rather it will all appear as normal text along a single line.

Tables

Markdown syntax
| Right | Left | Default | Center |
|------:|:-----|---------|:------:|
|   12  |  12  |    12   |    12  |
|  123  |  123 |   123   |   123  |
|    1  |    1 |     1   |     1  |
Output
Right Left Default Center
12 12 12 12
123 123 123 123
1 1 1 1

Learn more in the article on Tables.

Blocks

Markdown syntax Output
> Blockquote

Blockquote

| Line Block
|   Spaces and newlines
|   are preserved
Line Block
   Spaces and newlines
   are preserved

Special characters

Markdown syntax Output
\
hard line break
endash: --
endash: –
emdash: ---
emdash: —