Writing pages¶
Adding a page¶
- Create a Markdown file under
docs/, in a topic folder, e.g.docs/git/rebase.md. - Add it to the
navsection ofmkdocs.ymlso it shows up in the navigation. - Preview it with
zensical serve, then commit and push.
Formatting cheat sheet¶
Callouts¶
Note
A note callout.
Custom title
A tip with its own title.
Collapsible
Hidden until clicked.
Code with a copy button¶
Tabs¶
Task lists¶
- Set up the wiki
- Write the first real note
Diagrams¶
graph LR
A[Write Markdown] --> B[Push to GitHub] --> C[Site updates]
Math¶
Inline math goes between single dollar signs, like \(E = mc^2\). Display math goes between double dollar signs:
\[
\int_0^\infty e^{-x^2} \, dx = \frac{\sqrt{\pi}}{2}
\]