É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
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>
Steps sans titres
Les steps fonctionnent également sans titres :
Clonez le dépôt depuis GitHub.
Installez les dépendances avec npm install.
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 :
Créez un fichier de configuration :
{
"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.
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 :
Clonez depuis GitHub vers votre machine locale.
Exécutez la commande d'installation du gestionnaire de packages.
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 :
Première étape
Ce titre est rendu comme un élément h3.
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
stringTitre optionnel du step.
stringNom d'icône, URL ou chemin (remplace le numéro du step).
solid | regular | light | thin | sharp-solid | duotone | brandsdefault: solidStyle d'icône Font Awesome.
p | h2 | h3Remplace le titleSize du Steps parent. Hérite du parent si non défini.
numberDéfinit manuellement le numéro du step (attribué automatiquement si omis).
