```{mermaid}
flowchart LR
A[Hard edge] --> B(Round edge)
B --> C{Decision}
C --> D[Result one]
C --> E[Result two]
```
flowchart LR A[Hard edge] --> B(Round edge) B --> C{Decision} C --> D[Result one] C --> E[Result two]
This guide provides a comprehensive introduction to the basics of Markdown within Quarto, including a range of formatting options and advanced features to enhance your documentation projects.
Here’s what you’ll learn:
This guide ensures you have all the tools needed to enhance your documentation, making it accessible and professionally formatted. Whether you’re compiling a technical report, educational material, or any extensive documentation, mastering these Markdown basics will significantly improve your ability to present information clearly and interactively.
Markdown supports six levels of headings, with #
representing the highest level (Header 1) and ######
the lowest level (Header 6).
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.
Right | Left | Default | Center |
---|---|---|---|
12 | 12 | 12 | 12 |
123 | 123 | 123 | 123 |
1 | 1 | 1 | 1 |
Quarto has native support for embedding Mermaid and Graphviz diagrams.
Live editors to improve your productivity authoring diagrams:
Create a flowchart using Mermaid:
```{mermaid}
flowchart LR
A[Hard edge] --> B(Round edge)
B --> C{Decision}
C --> D[Result one]
C --> E[Result two]
```
flowchart LR A[Hard edge] --> B(Round edge) B --> C{Decision} C --> D[Result one] C --> E[Result two]
A simple undirected graph created using graphviz:
```{dot}
graph G {
layout=neato
run -- intr;
intr -- runbl;
runbl -- run;
run -- kernel;
kernel -- zombie;
kernel -- sleep;
kernel -- runmem;
sleep -- swap;
swap -- runswap;
runswap -- new;
runswap -- runmem;
new -- runmem;
sleep -- runmem;
}
```
Read more about diagrams in Quarto.
Include a video from YouTube:
Additional examples that demonstrate using various video sources and options:
{{< video local-video.mp4 >}}
{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}
{{< video https://youtu.be/wo9vZccmqwc width="400" height="300" >}}
{{< video https://www.youtube.com/embed/wo9vZccmqwc
title="What is the CERN?"
start="116"
aspect-ratio="21x9"
>}}
Read more about videos in Quarto.
Insert a page break with the pagebreak
shortcode:
Native pagebreaks are supported for HTML, LaTeX, Context, MS Word, Open Document, and ePub.
Note that there are five types of callouts, including note
, tip
, warning
, caution
, and important
.
This is a tip.
This is a warning.
This is a caution.
This is important.
Code cell annotations involve:
# <2>
). Use the same number to span an annotation over multiple lines.Possible annotation positions for HTML output are:
below
(default): Annotations appear below the code cell by default.hover
: Annotations show on mouse hover over a line marker.select
: Annotations appear when a marker is clicked and can be dismissed by clicking again.To change the default annotation position, use the code-annotations
metadata field in the document header: