Passaggi
Guide numerate passo passo per configurazione, tutorial e risoluzione dei problemi. Supporta icone, blocchi di codice e contenuti nidificati.
Usa Steps per creare procedure guidate numerate e chiare, ad esempio per configurazione e risoluzione dei problemi.
Utilizzo
<Steps>
<Step title="Install">Add the package.</Step>
<Step title="Configure">Set your options.</Step>
<Step title="Run">Start the build.</Step>
</Steps>
Passaggi di base
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>
Passaggi senza titoli
Steps funziona anche senza titoli:
Clona il repository da GitHub.
Installa le dipendenze con npm install.
Avvia il server di sviluppo.
<Steps>
<Step>
Clone the repository from GitHub.
</Step>
<Step>
Install dependencies with `npm install`.
</Step>
<Step>
Run the development server.
</Step>
</Steps>
Contenuti avanzati nei passaggi
Ogni passaggio può contenere qualsiasi tipo di contenuto:
Crea un file di configurazione:
{
"apiKey": "your-api-key",
"endpoint": "https://api.example.com"
}Mantieni segreta la tua chiave API! Non eseguirne mai il commit nel controllo versione.
Usa l'SDK per effettuare una richiesta:
const response = await client.getData();
console.log(response);Passaggi con icone
Usa le icone al posto dei numeri per una maggiore varietà visiva:
Clona il repository da GitHub sul tuo computer.
Esegui il comando di installazione del gestore di pacchetti.
Avvia il server di sviluppo.
<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>
Dimensione del titolo
Controlla la gerarchia delle intestazioni con titleSize nel contenitore Steps:
Primo passaggio
Questo titolo viene visualizzato come elemento h3.
Secondo passaggio
Utile per la SEO e la struttura del documento.
<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>
Proprietà
Steps
p | h2 | h3default: pElemento di intestazione per i titoli dei passaggi.
Step
stringTitolo del passaggio, facoltativo.
stringNome, URL o percorso dell'icona (sostituisce il numero del passaggio).
solid | regular | light | thin | sharp-solid | duotone | brandsdefault: solidStile dell'icona Font Awesome.
p | h2 | h3Sovrascrive il valore titleSize del contenitore Steps padre. Eredita il valore dal contenitore padre se non viene impostato.
numberImposta manualmente il numero del passaggio (assegnato automaticamente se omesso).
