Skip to content

Latest commit

 

History

History
261 lines (182 loc) · 4.13 KB

doc-cheat-sheet-myst.md

File metadata and controls

261 lines (182 loc) · 4.13 KB
Raw
orphan myst
true
substitutions
reuse_key advanced_reuse_key
This is **included** text.
This is a substitution that includes a code block: ``` code block ```

(cheat-sheet-myst)=

Markdown/MyST cheat sheet

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.

See the MyST style guide for detailed information and conventions.

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

H2 heading

H3 heading

H4 heading

H5 heading

Inline formatting

  • {guilabel}UI element
  • code
  • {command}command
  • {kbd}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

(a_section_target_myst)=

Links

  • Canonical website
  • {ref}a_section_target_myst
  • {ref}Link text <a_section_target_myst>
  • {doc}index
  • {doc}Link text <index>

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-rows: 1

* - Header 1
  - Header 2
* - Cell 1

    Second paragraph
  - Cell 2
* - Cell 3
  - Cell 4

Centred:

   :header-rows: 1
   :align: center

* - Header 1
  - Header 2
* - Cell 1

    Second paragraph
  - Cell 2
* - Cell 3
  - Cell 4

Notes

A note.

A tip.

Important information

This might damage your hardware!

Images

Alt text

   :width: 100px
   :alt: Alt text

   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}}

File inclusion

   :start-after: include_start
   :end-before: include_end

Tabs

```{group-tab} Tab 1

Content Tab 1
```

```{group-tab} Tab 2
Content Tab 2
```

Glossary


some term
  Definition of the example term.

{term}some term

More useful markup

  • {abbr}API (Application Programming Interface)

Custom extensions

Related links at the top of the page (surrounded by ---):

relatedlinks: https://github.com/canonical/lxd-sphinx-extensions, [RTFM](https://www.google.com)
discourse: 12345

Terms that should not be checked by the spelling checker: {spellexception}PurposelyWrong

A single-line terminal view that separates input from output:

   :input: command
   :user: root
   :host: vampyr
   :dir: /home/user/directory/

the output

A multi-line version of the same:

   :user: root
   :host: vampyr
   :dir: /home/user/directory/

:input: command 1
output 1
:input: command 2
output 2

A link to a YouTube video:

   :title: Demo