/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Components Quick start

Quick start

QuickStart draws numbered first steps, in your preset's home style.

2 min read

<QuickStart> draws the numbered "start here" steps of a docs home — each a title, a line of text and a link.

Note

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

mdx
<QuickStart />

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:

text
<QuickStart>: the site has no guide pages to start from, so it shows nothing. Give it content or remove it.

With your own content

mdx
<QuickStart title="Live in three steps">
<Step title="Install the CLI" href="/cli/overview">
One curl command installs stx on macOS and Linux.
</Step>
<Step title="Create and preview" href="/cli/init">
Run stx init, then stx dev to see every save live.
</Step>
<Step title="Deploy" href="/cli/deploy">
Run stx deploy to publish.
</Step>
</QuickStart>

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

PropTypeDefaultDescription
titlestring"Start here" (Grid: "Start")Heading of the block, where the preset draws one
limitnumber3Most 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.

•
Hero and Search — the hero and the home search box
Was this page helpful? Yes No
Product
Resources
Company
© 2026 SyntextBuilt with Syntext