Jamdesk Documentation logo

Étapes

Guides étape par étape numérotés pour les flux de configuration, les tutoriels et le dépannage. Prend en charge les icônes, les blocs de code et le contenu imbriqué.

Utilisez Steps pour des guides numérotés clairs, tels que les flux de configuration et de dépannage.

Usage

<Steps>
  <Step title="Install">Add the package.</Step>
  <Step title="Configure">Set your options.</Step>
  <Step title="Run">Start the build.</Step>
</Steps>

Steps de base

1
Installer le package
npm install @jamdesk/cli
2
Initialiser votre projet
jamdesk init
3
Démarrer le serveur de développement
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>

Steps sans titres

Les steps fonctionnent également sans titres :

1

Clonez le dépôt depuis GitHub.

2

Installez les dépendances avec npm install.

3

Lancez le serveur de développement.

<Steps>
  <Step>

    Clone the repository from GitHub.

</Step>
  <Step>

    Install dependencies with `npm install`.

</Step>
  <Step>

    Run the development server.

</Step>
</Steps>

Contenu enrichi dans les steps

Chaque step peut contenir n'importe quel contenu :

1
Configurer votre API

Créez un fichier de configuration :

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

Gardez votre clé API secrète ! Ne la committez jamais dans le contrôle de version.

2
Effectuer votre première requête

Utilisez le SDK pour effectuer une requête :

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

Steps avec icônes

Utilisez des icônes à la place des numéros pour une variété visuelle :

Cloner le dépôt

Clonez depuis GitHub vers votre machine locale.

Installer les dépendances

Exécutez la commande d'installation du gestionnaire de packages.

Commencer à développer

Lancez le serveur de développement.

<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>

Taille des titres

Contrôlez la hiérarchie des titres avec titleSize sur le conteneur Steps :

1

Première étape

Ce titre est rendu comme un élément h3.

2

Deuxième étape

Utile pour le SEO et la structure du document.

<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>

Props

Steps

p | h2 | h3default: p

Élément de titre pour les titres des steps.

Step

string

Titre optionnel du step.

string

Nom d'icône, URL ou chemin (remplace le numéro du step).

solid | regular | light | thin | sharp-solid | duotone | brandsdefault: solid

Style d'icône Font Awesome.

p | h2 | h3

Remplace le titleSize du Steps parent. Hérite du parent si non défini.

number

Définit manuellement le numéro du step (attribué automatiquement si omis).

Et ensuite ?

Vue d'ensemble des composants

Parcourir tous les composants disponibles

Bases MDX

Apprendre à utiliser les composants dans MDX