Authors' Guide¶
Markdown tips¶
Headings¶
- The page may contain only one
H1header
Highlighting content¶
Following is a list of type qualifiers provided by Material for MkDocs, whereas the default type, and thus fallback for unknown type qualifiers, is note1:
More details on mkdocs-material documentation
Note
A piece of information the reader should take note of.
Example
A sample code snippet or use case to illustrate a concept or feature.
Info
Additional information or context that may be helpful.
Quote
A cited or notable statement from another source.
Summary
A summary of the content or key points of the tutorial or section.
Tip
A helpful suggestion or advice to improve the reader's understanding or workflow.
Success
A positive outcome or result.
Checklist
- A positive outcome or result, done
- Incompleted item
- Completed subitem
- Incomplete subitem
Question
A prompt to encourage the reader to think or ask questions.
Warning
An alert to potential risks or issues.
Failure
A negative outcome or result.
Danger
A more severe alert to potential risks or issues.
Bug
A known issue or error in the software or tool being used.