Quick start
QuickStart draws numbered first steps, in your preset's home style.
<QuickStart> draws the numbered "start here" steps of a docs home — each a title, a line of text and a link.
Doc engine v2 only (presets). A v1 site doesn't draw <QuickStart>: used empty it shows nothing, and any content inside it shows as plain text.
Used empty
With no children, it lists the first guide pages of your first section, each linking to its page.
Used empty, it fills itself from your site. Give it content of its own and it shows only that. With no content and nothing on the site to fill it, it draws nothing and the build log says so:
With your own content
Each <Step title href> is a step. Its text is drawn as plain text, so keep it to one line. href on a <Step> only does something inside <QuickStart>.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
title | string | "Start here" (Grid: "Start") | Heading of the block, where the preset draws one |
limit | number | 3 | Most steps shown when it fills itself |
In each preset
It's drawn in your preset's home style — or in the layout named by appearance.layout.home while that setting still works. Workbench, Grid and Margin draw their home quickstart. The other presets draw it as Steps. On a page with the normal frame it sits in the content column; on a layout: wide page it runs across the page.