- orphan
This file contains the syntax for commonly used reST markup. Open it in your text editor to quickly copy and paste the markup you need.
See the reStructuredText style guide for detailed information and conventions.
Also see the Sphinx reStructuredText Primer for more details on reST, and the Canonical Documentation Style Guide for general style conventions.
UI element
code
file path
command
Key
- Italic
- Bold
Start a code block:
code:
- example: true
# Demonstrate a code block
code:
- example: true
# Demonstrate a code block
code:
- example: true
- Canonical website
- Canonical website (defined in
reuse/links.txt
or at the bottom of the page) - https:\ //canonical.com/
a_section_target
Link text <a_section_target>
index
Link text <index>
Use the following syntax:
.. toctree::
:hidden:
sub-page1
sub-page2
- Step 1
- Item 1
- Sub-item
- Item 2
- Sub-step 1
- Sub-step 2
- Item 1
- Step 2
- Sub-step 1
- Item
- Sub-step 2
- Sub-step 1
- Term 1:
Definition
- Term 2:
Definition
Header 1 | Header 2 |
---|---|
Cell 1 Second paragraph |
Cell 2 |
Cell 3 | Cell 4 |
Header 1 | Header 2 |
---|---|
Cell 1 Second paragraph |
Cell 2 |
Cell 3 | Cell 4 |
align-center
Header 1 | Header 2 |
---|---|
Cell 1 Second paragraph |
Cell 2 |
Cell 3 | Cell 4 |
Header 1 | Header 2 |
---|---|
Cell 1 Second paragraph |
Cell 2 |
Cell 3 | Cell 4 |
Note
A note.
Tip
A tip.
Important
Important information
Caution
This might damage your hardware!
This is included text.
Tab 1
Content Tab 1
Tab 2
Content Tab 2
- example term
Definition of the example term.
example term
X.Y
- Line 1
Line 2
Line 3 API (Application Programming Interface)
Related links at the top of the page:
: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: PurposelyWrong
A terminal view with input and output:
the output
A link to a YouTube video: