Passos
Guias numerados passo a passo para fluxos de configuração, tutoriais e solução de problemas. Suporta ícones, blocos de código e conteúdo aninhado.
Use Steps para roteiros numerados, como fluxos de configuração e solução de problemas.
Uso
<Steps>
<Step title="Install">Add the package.</Step>
<Step title="Configure">Set your options.</Step>
<Step title="Run">Start the build.</Step>
</Steps>
Etapas básicas
npm install @jamdesk/clijamdesk initjamdesk dev<Steps>
<Step title="Install the package">
```bash
npm install @jamdesk/cli
```
</Step>
<Step title="Initialize your project">
```bash
jamdesk init
```
</Step>
<Step title="Start the dev server">
```bash
jamdesk dev
```
</Step>
</Steps>
Etapas sem títulos
Os passos também funcionam sem títulos:
Clone the repository from GitHub.
Install dependencies with npm install.
Run the development server.
<Steps>
<Step>
Clone the repository from GitHub.
</Step>
<Step>
Install dependencies with `npm install`.
</Step>
<Step>
Run the development server.
</Step>
</Steps>
Conteúdo avançado nas etapas
Cada passo pode conter qualquer conteúdo:
Create a configuration file:
{
"apiKey": "your-api-key",
"endpoint": "https://api.example.com"
}Keep your API key secret! Never commit it to version control.
Use the SDK to make a request:
const response = await client.getData();
console.log(response);Etapas com ícones
Substitua os números por ícones:
Clone from GitHub to your local machine.
Run the package manager install command.
Launch the development server.
<Steps>
<Step title="Clone the repository" icon="code-branch">
Clone from GitHub to your local machine.
</Step>
<Step title="Install dependencies" icon="download">
Run the package manager install command.
</Step>
<Step title="Start developing" icon="rocket">
Launch the development server.
</Step>
</Steps>
Tamanho do título
Controle a hierarquia de títulos com titleSize no contêiner Steps:
First Step
This title renders as an h3 element.
Second Step
Useful for SEO and document structure.
<Steps titleSize="h3">
<Step title="First Step">
This title renders as an h3 element.
</Step>
<Step title="Second Step">
Useful for SEO and document structure.
</Step>
</Steps>
Propriedades
Steps
p | h2 | h3default: pElemento de título para os títulos dos passos.
Step
stringTítulo opcional do passo.
stringNome do ícone, URL ou caminho (substitui o número do passo).
solid | regular | light | thin | sharp-solid | duotone | brandsdefault: solidEstilo do ícone Font Awesome.
p | h2 | h3Substitui o titleSize do Steps pai. Herda do pai se não definido.
numberDefine manualmente o número do passo (atribuído automaticamente se omitido).
