Passaggi

Usa Steps per procedure numerate come i flussi di 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

Installa il pacchetto

npm install @jamdesk/cli

Inizializza il progetto

jamdesk init

Avvia il server di sviluppo

jamdesk 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

I passaggi funzionano 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 contenuto:

Configura la tua API

Crea un file di configurazione:

config.json

{
  "apiKey": "your-api-key",
  "endpoint": "https://api.example.com"
}

Mantieni segreta la tua chiave API! Non committarla mai nel controllo di versione.

Effettua la tua prima richiesta

Usa l'SDK per effettuare una richiesta:

const response = await client.getData();
console.log(response);

Passaggi con icone

Sostituisci i numeri con le icone:

Clona il repository

Clona da GitHub sulla tua macchina locale.

Installa le dipendenze

Esegui il comando di installazione del package manager.

Inizia a sviluppare

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 dei titoli con titleSize sul contenitore Steps:

Primo passaggio

Questo titolo viene renderizzato 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: p

Elemento di intestazione per i titoli dei passaggi.

Step

string

Titolo facoltativo del passaggio.

string

Nome dell'icona, URL o percorso (sostituisce il numero del passaggio).

Stile dell'icona Font Awesome.

p | h2 | h3

Sovrascrive il titleSize del Steps padre. Eredita dal padre se non impostato.

number

Imposta manualmente il numero del passaggio (assegnato automaticamente se omesso).

Prossimi passi

Panoramica dei componenti

Sfoglia tutti i componenti disponibili

Nozioni base MDX

Scopri come usare i componenti in MDX