Markdown Guide

#guide#markdown

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

FeatureSupportedNotes
TablesYesGitHub-flavored
CalloutsYesVia remark directives
MathYesKaTeX, inline and display

Lists

A task list:

  • Write the intro
  • Add a callout example
  • Add a diagram

An ordered list:

  1. First, gather requirements.
  2. Then, sketch the approach.
  3. Finally, ship it.

Code

A fenced shell block:

Terminal window
pnpm install
pnpm dev

Math

Inline math like E=mc2E = mc^2 sits naturally within a sentence. Display math gets its own block:

01x2dx=13\int_0^1 x^2 \, dx = \frac{1}{3}

That covers the essentials.