Command list
CommandList shows CLI commands with a one-line description each.
<CommandList> draws CLI commands with a one-line description each, linking to their pages.
Doc engine v2 only (presets). A v1 site doesn't draw <CommandList>: used empty it shows nothing, and any content inside it shows as plain text.
Used empty
With no content, it lists the pages of a section named CLI.
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
A two-column table — command, then description:
Or a list of `command` — description lines. A command written as a link links to its page:
Props
| Prop | Type | Default | Description |
|---|---|---|---|
title | string | "quick links" | Heading of the block, where the preset draws one |
limit | number | 6 | Most commands 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. Console draws its quick links. The other presets draw a table. On a page with the normal frame it sits in the content column; on a layout: wide page it runs across the page.
Example
This site's own, from <CommandList limit={4} />:
| Command | Description |
|---|---|
CLI Overview | The stx command-line interface for building, previewing, and deploying Syntext documentation. |
stx init | Initialize a new Syntext documentation project. |
stx dev | Deploy a preview build and redeploy it as you edit. |
stx build | Build your documentation on Syntext's servers and download the static site for self-hosting. |