Skip to content

Sample Callouts and FAQ Page

Use a page like this for warnings, common problems, and collapsible answers.

Admonitions

Note

Use a note for background information or a calm heads-up.

Tip

Use a tip for a better workflow, a shortcut, or a recommendation.

Warning

Use a warning when the reader could lose data or get confused by a risky action.

Expandable Details

Sample expandable section

Collapsible sections are useful for FAQs, extra detail, or optional troubleshooting steps.

Simple Troubleshooting Table

Problem Likely cause What to do
A page looks wrong Custom CSS changed layout Check docs/stylesheets/extra.css
A link is missing from the sidebar The page is not in nav Update mkdocs.yml
A new page does not build Markdown syntax is broken Run mkdocs build and fix the error