Writing documentation
status: published to the front matter in the Markdown source file.
This page shows some of the Markdown and Liquid widgets that are available for writing documentation using this template. The Markdown file used to create this page can be viewed on GitHub.
Heading 2
Headings provide the basic structure to a page. HTML supports six levels of headings. The top-level heading is added automatically based on the page title. Among other things, headings are used to make pages accessible, so always use them in order and don’t use bold, italtics, or underline to signify a heading!
Heading 3
Heading 4
Heading 5
Heading 6
Formatting text
Bold or italics can make a word or phrase stand out.
Lists
Unordered lists use bullets:
- Unordered
- List
Ordered lists use numbers:
- Ordered
- List
Tables
| Col 1 | Col 2 | Col 3 |
|---|---|---|
| Row 1, Col 1 | Row 1, Col 2 | Row 1, Col 3 |
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 |
| Row 3, Col 1 | Row 3, Col 2 | Row 3, Col 3 |
Notices
Notices can be used to make information stand out.
Information notices highlight important information.
Warnings let users know about potential problems or gotchas.
Links
Jekyll relative links use URLs relative to the site root
Private links may require additional authentication
External links take users to another site