Pages are written in GitHub-flavored Markdown with three additions: callouts, steps and cards. Raw HTML is shown as text, so a page can never run scripts.
Headings
## Heading and ### Subheading appear in On this page on the right and in search. The page title is already the top heading, so start the text at ##.
Links
Link to another page of the same site with its address:
[Install the CLI](install)
[Errors](/errors#rate-limits)Both work on the platform and on docs.<domain>. Links starting with https:// open in a new tab.
Callouts
> [!TIP]
> A helpful hint.Note
Use NOTE for background information.
Tip
Use TIP for a shortcut or a better way.
Important
Use IMPORTANT for something the reader must not miss.
Warning
Use WARNING for something that can go wrong.
Caution
Use CAUTION for something that cannot be undone.
Steps
Wrap a numbered list in :::steps for a numbered, connected sequence:
:::steps
1. **Install.** Add the package.
2. **Configure.** Set your key.
3. **Run.** Start the app.
:::- Install. Add the package.
- Configure. Set your key.
- Run. Start the app.
Cards
Wrap a list of links in :::cards for a grid of clickable cards. The link is the card's title; the text after it is the description.
:::cards
- [**Quickstart**](quickstart) Set up in five minutes.
- [**Guides**](writing) Learn the main ideas.
:::- Quickstart Set up in five minutes.
- Guides Learn the main ideas.
Code
Put the language after the opening fence for highlighting; add words after it to replace the label.
```bash
npm install
```
```ts src/app.ts
export const answer = 42;
```export const answer = 42;Highlighted languages: bash, CSS, diff, INI/TOML, JavaScript, JSON, Markdown, Python, SQL, TypeScript, HTML/XML and YAML. Every code block has a Copy button.
Tables
| Option | Default | What it does |
| --- | --- | --- |
| `name` | — | The name shown to visitors. |Wide tables scroll sideways on phones.
Lists and tasks
- [x] Write the quickstart
- [ ] Add screenshots- Write the quickstart
- Add screenshots