Markdown components

Every element our Markdown pages can render, styled through the docs prose system.

Everything below is rendered from plain Markdown through the docs prose styles. Build new pages in Markdown and they inherit all of this: standard syntax plus GitHub-flavored alerts and syntax-highlighted code.

Headings & text

Body copy supports bold, italics, inline code and links. You can also show keystrokes such as ⌘ K.

A third-level heading

Headings step down in scale and stay scannable on long pages.

A fourth-level heading

This is the smallest heading the prose styles cover.

Lists

A bullet point
- A nested bullet
- Another nested bullet
Back to the top level

A numbered step
A second step
A third step

A completed task
Another completed task
A task still to do

Blockquote

Documentation should answer the question the reader actually has, in the fewest words that still respect them.

Code

Inline code and fenced blocks. Blocks are highlighted by Phiki.

# install dependencies and build
composer install
npm install && npm run build

public function handle(Request $request): JsonResponse
{
    return response()->json(['ok' => true]);
}

Table

Field	Type	Required
title	string	yes
intro	string	no
badge	string	no

Alerts

NOTE

Highlights information the reader should notice, even when skimming.

TIP

Optional advice that helps the reader get more out of a feature.

IMPORTANT

Key information the reader needs in order to succeed.

WARNING

Urgent information that needs attention to avoid a problem.

CAUTION

Advises about the risks or negative outcomes of an action.

That's the full set. Every page that uses prose looks like this.