Steps
A numbered procedure whose rail survives the code blocks inside it.
- #authoring
- #components
A procedure where the order is part of the content. The markers sit on a rail that connects them, so a step holding a code block still reads as step three of four rather than as a heading followed by a panel.
A plain ordered list is better when the items are short and the order is incidental. Steps earn their weight once each item carries a command or a paragraph.
Create the entry directory
The path is the route, so every segment is lowercase and hyphenated.
shellWrite the document
Open with
# useInterval, then start the body's structure ath2. Frontmatter is optional; anything left out is derived from the path, the first heading and the body.Put the code beside it
An adjacent
use-interval.tsis served as-is and can be quoted from the document, so the code in the note is the code the note is about.Check it before committing
Validation resolves every internal link and asset reference, and fails on the first one that does not exist.
shell
Numbering from elsewhere
start continues a procedure that began in an earlier section, so the second
half does not restart at one:
Build the site
shellRead the summary
The build prints the entry count and every derived route; a missing note is visible here before it is visible in the navigation.
Props
<Steps />
start?number
Number the first step from something other than one.
- Default
1
<Step />
title?string
The step's heading. An imperative phrase reads best next to a number.
Related entries
Callouts
Semantic notices for a caveat, a tip or a danger, with the five types and when each is honest.
Tabs
One panel per alternative, with keyboard navigation and a shared choice across the document.
Details
A native disclosure for the paragraph most readers do not need, and the rule for what may go inside one.