Markdown Guide
A tour of the markdown features supported by this blog's pipeline.
This post is a reference for the markdown features the site supports. Use it to check how a particular element renders before you rely on it in a real post.
The fuller authoring guide (folder layout, GIFs, sidebar topics) is private:
run pnpm dev and open /docs/starter-guide/ locally. It is marked draft: true, so it is not published in production builds.
Headings
Headings from ## through #### are available and feed the table of contents.
A third-level heading
A fourth-level heading
Callouts
Callouts use directive syntax and render as styled admonitions.
Note (Heads up)
This is a note callout.
Tip
A tip.
Warning
A warning.
Tables
| Feature | Supported | Notes |
|---|---|---|
| Tables | Yes | GitHub-flavored |
| Callouts | Yes | Via remark directives |
| Math | Yes | KaTeX, inline and display |
Lists
A task list:
- Write the intro
- Add a callout example
- Add a diagram
An ordered list:
- First, gather requirements.
- Then, sketch the approach.
- Finally, ship it.
Code
A fenced shell block:
pnpm installpnpm devMath
Inline math like sits naturally within a sentence. Display math gets its own block:
That covers the essentials.