On this page
Alerts
Alerts make important information stand out. They use GitHub’s alert syntax: a quote whose first line names the kind of alert.
> [!NOTE]
> Clay ignores files whose names start with a dot.Note
Clay ignores files whose names start with a dot.
#All kinds
Note
Background information readers should notice, even when skimming.
Tip
A shortcut or a better way to do something.
Important
Something readers need to know to succeed.
Warning
Something that can go wrong and needs attention.
Caution
The consequences of an action, like losing data.
Danger
A serious risk. DANGER is a Clay addition; GitHub shows it as a plain quote.
#Content in alerts
Alerts can hold everything a quote can: several paragraphs, lists, links and code.
> [!WARNING]
> Renaming a page changes its URL. Before you rename one:
>
> - search the docs for links to it,
> - update links from other websites if you can.
>
> Run `npx clay build --strict` to find broken links.Warning
Renaming a page changes its URL. Before you rename one:
- search the docs for links to it,
- update links from other websites if you can.
Run npx clay build --strict to find broken links.
Tip
Use alerts sparingly. A page full of alerts makes none of them stand out.