mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
75 lines
2.2 KiB
Plaintext
75 lines
2.2 KiB
Plaintext
---
|
|
title: "Steps"
|
|
description: "Create numbered step-by-step procedures with the steps component to guide users through sequential tasks, tutorials, and setup workflows."
|
|
keywords: ["sequence", "numbered steps", "procedures", "tutorial steps"]
|
|
boost: 3
|
|
---
|
|
|
|
import IconsOptional from "/snippets/icons-optional.mdx";
|
|
|
|
Use steps to display a series of sequential actions or events. You can add as many steps as needed.
|
|
|
|
<Steps>
|
|
<Step title="First Step">
|
|
These are instructions or content that only pertain to the first step.
|
|
</Step>
|
|
<Step title="Second Step">
|
|
These are instructions or content that only pertain to the second step.
|
|
</Step>
|
|
<Step title="Third Step">
|
|
These are instructions or content that only pertain to the third step.
|
|
</Step>
|
|
</Steps>
|
|
|
|
```mdx Steps example
|
|
<Steps>
|
|
<Step title="First Step">
|
|
These are instructions or content that only pertain to the first step.
|
|
</Step>
|
|
<Step title="Second Step">
|
|
These are instructions or content that only pertain to the second step.
|
|
</Step>
|
|
<Step title="Third Step">
|
|
These are instructions or content that only pertain to the third step.
|
|
</Step>
|
|
</Steps>
|
|
```
|
|
|
|
## Steps properties
|
|
|
|
<ResponseField name="children" type="ReactElement<StepProps>[]" required>
|
|
A list of `Step` components.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="titleSize" type="string" default="p">
|
|
The size of the step titles. One of `p`, `h2`, `h3`, and `h4`.
|
|
</ResponseField>
|
|
|
|
## Individual step properties
|
|
|
|
<ResponseField name="title" type="string" required>
|
|
The title is the primary text for the step and shows up next to the indicator.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="children" type="string | ReactNode">
|
|
The content of a step either as plain text or components.
|
|
</ResponseField>
|
|
|
|
<IconsOptional />
|
|
|
|
<ResponseField name="stepNumber" type="number">
|
|
The number of the step.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="titleSize" type="string" default="p">
|
|
The size of the step titles. One of `p`, `h2`, `h3`, and `h4`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="id" type="string">
|
|
A custom ID for the step, used for anchor linking and table of contents navigation.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="noAnchor" type="boolean" default="false">
|
|
Whether to hide the anchor link for the step.
|
|
</ResponseField>
|