Demo

Last edited

Every theme feature on one page. Hidden from nav and search; reachable at /demo/.

Typography

Body text with bold, italic, inline code, highlight, a link, a raw superscript1, and a real footnote1.

  1. ordered
  2. list
  • unordered
  • list
commanddoes
lslist
cdchange dir

Code

terminal
npx playwright test
print("no title, no header")

Sidenote

Margin note, hangs to the right on wide screens and drops into the flow below $bp-toc. The shortcode goes at the start of the paragraph it annotates, on the same line. A note keeps the vertical position it would have had in the flow, so it lines up with this paragraph — and so two notes on adjacent short paragraphs will overlap, since nothing pushes the second one down. Give each note a paragraph at least as tall as itself.

Filler paragraph so the next note has somewhere to hang. Filler paragraph so the next note has somewhere to hang. Filler paragraph so the next note has somewhere to hang.

Same thing as a blockquote alert, for when it stands alone.

Filler so the note above has clearance before the next heading.

Admonitions

Note

note

Tip

tip

Important

important

Warning

warning

Caution

caution

Pithy

pithy

Definition

definition

Problem

problem

Solution

solution

Question

A question on its own.

Question

Question followed by an answer — they join into one block.

Answer

The answer.

Pros

  • always paired with cons
  • sits side by side

Cons

  • closes the pair

Author Some Book p. 1

A quote rendered as a comment card.

Plain blockquote, no marker.

with a cite

Tabs

npm install

Groups with a shared label switch together, and the choice is remembered:

Prose, admonitions, and a nested group:

npm run build

Note

inside a tab


  1. Footnotes are Goldmark’s own, on by default. They collect at the bottom of the page with a back-link. ↩︎