Components
Everything you can put in a page, from callouts and tabs to props tables and anatomy diagrams.
Svelte DocSmith’s components go straight into a markdown page. Import the ones
a page uses from svelte-docsmith in its <script> block.
Callout
Draw attention to a note, tip, warning, or danger.
Steps
A numbered walkthrough for sequential instructions.
Card & CardGrid
Linkable cards for next steps and feature grids.
Tabs
Group alternative content behind labeled tabs.
Accordion
Collapse long-form content behind expandable headings.
Badge
Small status and label pills with semantic intents.
Kbd
Render keyboard keys and shortcuts inline.
File Tree
Show project and directory structure as a tree.
Image
Zoomable images with captions, kept next to the page, with a picture per colour mode.
Math
Inline and display formulas, written as MathML at build time.
Columns
Set content side by side in two or three columns that stack on phones.
Do & Don't
Show the right way and the wrong way side by side, for design guidelines.
Colour swatches
Show a palette's colours, and what each token resolves to in the current colour mode.
Tooltip
A short note on a word or phrase, shown on hover, focus or tap.
Video
Video files with a poster and captions, looping clips in place of GIFs, and YouTube that loads on play.
Props Table
Document a component's API in a consistent table, generated from its source.
Landing Page
Build the marketing page that sits in front of your docs.
Anatomy
Label the parts of a live component with numbers and describe each one below it.
Compare
Two versions of one thing, one over the other, with a divider the reader drags.
Section cards
A card for each page in a section, kept up to date from the sidebar.