Documentation navigation

Essentials

Prose Components

Compose rich prose sections from local, owned components.

Callouts

Callouts emphasize contextual information with local markup that stays easy to read and customize.

Note

Use callouts for supporting details that should stay close to the related explanation.

Tip

Keep the markup local and copyable so template users can adjust the treatment after installation.

Warning

Do not hide critical setup requirements inside decorative examples.

Cards

Cards, callouts, and grouped links should remain copyable and easy to customize.

Badges and keyboard

Small inline affordances are useful for versions, statuses, shortcuts, and command hints.

Badge

::badge Stable ::Stable

Shortcut

:kbd{value="meta"} :kbd{value="K"}Meta K

Inline code

`components.json`components.json

Steps

Steps describe setup flows as a visible sequence instead of relying on a hidden prose transform.

1

Create the project

Start from the Stackhacker UI docs template or copy the relevant block into your app.

2

Install dependencies

Install packages with pnpm so Nuxt can prepare types and generated imports.

pnpm install
3

Run the docs locally

Start Nuxt and review the responsive docs layout before customizing content.

pnpm dev