Get started →

Markdown Syntax

ciderpress renders standard CommonMark plus GitHub Flavored Markdown (GFM) extensions out of the box. This page shows every core element rendered live — use it as an authoring reference and as a visual check for theme typography.

For extended components (cards, tabs, diagrams, math), see Built-ins. For inline superscript and subscript, see Superscript & Subscript.

Headings

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Paragraphs & inline text

A paragraph is one or more lines of text separated by a blank line. Inline emphasis composes freely: bold, italic, bold italic, strikethrough, and inline code.

Escape markdown characters with a backslash: *not italic* and `not code`.

End a line with a backslash to force a hard line break —
this line follows the break within the same paragraph.

Lists

Unordered

  • First item
  • Second item
  • Third item with a longer line that wraps onto a second visual line to show how the hanging indent aligns under the text rather than the marker

Ordered

  1. First step
  2. Second step
  3. Third step with a longer line that wraps onto a second visual line so the marker-to-text gap and hanging indent stay consistent with unordered lists

Nested & mixed

  1. Top-level ordered item
    • Nested unordered child
    • Another child
      1. Deeply nested ordered item
      2. Sibling
  2. Back to the top level
    1. Nested ordered child
    2. Sibling child

Task lists

  • Completed task
  • Another done item
  • Outstanding task
  • Blocked task
- [x] Completed task
- [ ] Outstanding task

Blockquotes

A single-line blockquote.

A multi-line blockquote.

It can span paragraphs and contain inline formatting and links.

Nested blockquotes are supported too.

Code

Inline const answer = 42 sits within a sentence.

Fenced blocks carry a language for syntax highlighting:

type Result<T, E> = readonly [T, undefined] | readonly [undefined, E]

function ok<T>(value: T): Result<T, never> {
  return [value, undefined]
}
pnpm docs:dev --headless

Tables

ElementSyntaxGFM only
Bold**text**No
Strikethrough~~text~~Yes
Task list- [ ] itemYes
Table| a | b |Yes

Columns support alignment:

LeftCenterRight
abc
foobarbaz

Horizontal rule

Content above the divider.


Content below the divider.

Images

ciderpress logo

GFM footnotes render as linked references1 and collect in an auto-generated section at the foot of the page2.

Footnotes

  1. The first footnote definition.

  2. The second, with inline formatting.