Markdown Cheat Sheet

Source: https://github.com/canonical/data-science-stack/blob/main/docs/doc-cheat-sheet-myst.md

This file contains the syntax for commonly used Markdown and MyST markup. Open it in your text editor to quickly copy and paste the markup you need.

Also see the MyST documentation for detailed information, and the Canonical Documentation Style Guide for general style conventions.

H2 heading

H3 heading

H4 heading

H5 heading

Inline formatting

• UI element

• code

• command

• Key

• Italic

• Bold

Code blocks

Start a code block:

code:
  - example: true

# Demonstrate a code block
code:
  - example: true

# Demonstrate a code block
code:
  - example: true

Links

• Canonical website

• https://canonical.com/

• Links

• Link text

• Sphinx Quick Start

• Link text

Navigation

Use the following syntax::

```{toctree}
:hidden:

sub-page1
sub-page2
```

Lists

1. Step 1

   • Item 1

     • Sub-item

   • Item 2

     1. Sub-step 1

     2. Sub-step 2

2. Step 2

   1. Sub-step 1

      • Item

   2. Sub-step 2

Term 1 : Definition

Term 2 : Definition

Tables

Markdown tables

Header 1	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	Cell 4

Centred:

Header 1	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	Cell 4

List tables

Header 1	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	Cell 4

Centred:

Header 1	Header 2
Cell 1 Second paragraph	Cell 2
Cell 3	Cell 4

Notes

Note

A note.

Tip

A tip.

Important

Important information

Caution

This might damage your hardware!

Images

Figure caption

Reuse

Keys

Keys can be defined at the top of a file, or in a myst_substitutions option in conf.py.

{{reuse_key}}

{{advanced_reuse_key}}

Glossary

some term

Definition of the example term.

some term

More useful markup

• Added in version X.Y.

• API