Jamdesk Documentation logo

Steps

Guías numeradas paso a paso para flujos de configuración, tutoriales y solución de problemas. Admite iconos, bloques de código y contenido anidado.

Usa Steps para guías claras y numeradas, como flujos de configuración y solución 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>

Steps básicos

1
Instalar el paquete
npm install @jamdesk/cli
2
Inicializar tu proyecto
jamdesk init
3
Iniciar el servidor de desarrollo
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 sin títulos

Los Steps también funcionan sin títulos:

1

Clona el repositorio desde GitHub.

2

Instala las dependencias con npm install.

3

Ejecuta el servidor de desarrollo.

<Steps>
  <Step>

    Clone the repository from GitHub.

</Step>
  <Step>

    Install dependencies with `npm install`.

</Step>
  <Step>

    Run the development server.

</Step>
</Steps>

Contenido enriquecido en Steps

Cada step puede contener cualquier tipo de contenido:

1
Configura tu API

Crea un archivo de configuración:

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

¡Mantén tu clave de API en secreto! Nunca la incluyas en el control de versiones.

2
Realiza tu primera solicitud

Usa el SDK para realizar una solicitud:

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

Steps con iconos

Usa iconos en lugar de números para mayor variedad visual:

Clonar el repositorio

Clona desde GitHub a tu máquina local.

Instalar dependencias

Ejecuta el comando de instalación del gestor de paquetes.

Empezar a desarrollar

Inicia el servidor de desarrollo.

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

Tamaño de título

Controla la jerarquía de encabezados con titleSize en el contenedor Steps:

1

Primer paso

Este título se renderiza como un elemento h3.

2

Segundo paso

Útil para SEO y la estructura 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>

Props

Steps

p | h2 | h3default: p

Elemento de encabezado para los títulos de los steps.

Step

string

Título opcional del step.

string

Nombre del icono, URL o ruta (reemplaza el número del step).

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

Estilo de icono de Font Awesome.

p | h2 | h3

Sobreescribe el titleSize del Steps padre. Hereda del padre si no se establece.

number

Establece manualmente el número del step (se asigna automáticamente si se omite).

¿Qué sigue?

Descripción general de componentes

Explora todos los componentes disponibles

Conceptos básicos de MDX

Aprende a usar componentes en MDX