Skip to main content

Blockquotes

3 min readStableBeginner

A blockquote is any line that starts with >. Use it for pulled quotes, short asides, and attributions. Colored callouts are a separate thing: a quote whose first line is > [!NOTE] gets rewritten before render and comes out as an alert, so reach for Alerts when you want one of those six styles.

Quick Start

One line, one >.

Documentation is a love letter that you write to your future self.

quote.md
Markdown
> Documentation is a love letter that you write to your future self.

Adding Options

Formatting and paragraphs

Markdown keeps working inside the quote, and a bare > line starts a new paragraph within the same block.

Good documentation teaches, guides, and answers questions. The inline syntax is covered in Text Formatting.

— OwnDocs style guide

quote-with-formatting.md
Markdown
> **Good documentation** teaches, guides, and answers questions. The inline
> syntax is covered in [Text Formatting](/features/markdown/text-formatting).
>
> — OwnDocs style guide

Wrapped and lazy lines

Put a > on every line of the quote, wrapped lines included. Markdown does accept a lazy continuation — an unmarked paragraph line straight under a quoted line joins the same paragraph — but it's a habit worth skipping.

lazy-continuation.txt
Plain Text
> First line of the quote
still inside the quote, because the line above opened one

Both lines land in the same <blockquote>. Prettier rewrites the second line with its own > the moment you save, so you may as well type it.

Advanced

Block content inside a quote

Headings, lists, thematic breaks, code fences, and tables all nest inside a quote as long as every line carries the marker.

Release policy

Every release ships three things:

  1. A changelog entry
  2. A migration note
  3. A tagged commit

Bash
Bash
npm run build
StageGate
Buildnpm run build
PublishTag on main
rich-quote.md
Markdown
> ### Release policy
>
> Every release ships three things:
>
> 1. A changelog entry
> 2. A migration note
> 3. A tagged commit
>
> ---
>
> ```bash
> npm run build
> ```
>
> | Stage   | Gate            |
> | ------- | --------------- |
> | Build   | `npm run build` |
> | Publish | Tag on `main`   |

Nested quotes

A second > nests one quote inside another. Add one marker per level.

Every example page owes the reader three things: a working snippet, the rendered result, and a code block they can copy.

Nested quotes reply to the quote above them.

A third level works too, though the indentation gets thin fast.

nested-quote.md
Markdown
> Every example page owes the reader three things: a working snippet, the
> rendered result, and a code block they can copy.
>
> > Nested quotes reply to the quote above them.
> >
> > > A third level works too, though the indentation gets thin fast.

Quotes inside a list item

Indent the > two spaces under a bullet and the quote belongs to that item instead of ending the list.

  • Ship the migration guide

    Readers upgrading from v1 need the rename table before anything else.

    Then link it from the changelog.

quote-in-list.md
Markdown
- Ship the migration guide
 
  > Readers upgrading from v1 need the rename table before anything else.
 
  Then link it from the changelog.

Options

>marker

Starts a blockquote line. Prefix every line of the quote, including wrapped lines.

> (bare)marker

A > on its own line separates paragraphs inside one blockquote.

> >marker

Nests a blockquote inside another blockquote. Add one > per level.

> [!NOTE]alert trigger

Turns the quote into an alert instead. NOTE, TIP, IMPORTANT, WARNING, CAUTION, and DANGER are the six recognized keywords.

two spacesindent

Indents a whole blockquote under a list item so it stays part of that item.

Was this page helpful?