El contenedor steps transforma instrucciones secuenciales en líneas de tiempo verticales numeradas con enlaces permanentes.
Sintaxis de Contenedor (Container Syntax)
::: steps # Apertura del contenedor de línea de tiempo secuencial
::: step [title:"Encabezado del Paso"] # Apertura del paso individual
Contenido del paso 1 (texto markdown, código, avisos, imágenes)...
::: /step # Cierre explícito del paso
::: step [title:"Encabezado del Paso 2"] # Segundo paso
Contenido del paso 2...
::: /step
::: /steps # Cierre explícito de la línea de tiempo
Características y Atributos Soportados
| Parámetro / Elemento | Tipo | Descripción |
|---|---|---|
| Título del Paso | "String" | title:"..." |
Texto de encabezado en la parte superior del nodo (1er parám posicional o title:"..."). |
| Nodos de Tiempo | Automático | Cada bloque ::: step incrementa automáticamente el índice del paso (1, 2, 3…). |
| Subcontenedores | ::: step … ::: /step |
Envoltorios de pasos explícitos. La sintaxis de lista ordenada (1., 2.) es compatible. |
| Etiquetas de Cierre | ::: /steps, ::: /step, ::: |
Soporta etiquetas de cierre explícitas o marcadores genéricos :::. |
A partir de v0.9.1, docmd introduce etiquetas de apertura y cierre explícitas (ej. ::: card … ::: /card, ::: tab … ::: /tab), propiedades clave-valor explícitas (title:"...", url:"...") y comentarios al final # comentario. Esta sintaxis modernizada se recomienda para toda nueva documentación. Se mantiene la compatibilidad hacia atrás completa para marcadores heredados (== tab, 1.) y valores posicionales.
Ejemplos de Uso
::: steps # Secuencia de inicio
::: step "Inicializar Proyecto" # Paso 1
Ejecuta `npx @docmd/core init` para crear tu estructura.
::: /step
::: step "Escribir Contenido" # Paso 2
Escribe documentación usando archivos Markdown estándar.
::: /step
::: step "Compilar y Desplegar" # Paso 3
Ejecuta `npx @docmd/core build` para compilar la salida de producción.
::: /step
::: /steps
Pasos con Contenido Enriquecido Integrado
Los pasos admiten bloques de código, avisos de llamada (callouts) y contenedores anidados:
::: steps # Guía de despliegue compleja
::: step "Configurar Entorno"
Define opciones de proyecto en `docmd.config.json`.
::: callout info title:"Pista IDE"
Usa `defineConfig` para habilitar el autocompletado de IDE para las claves de esquema.
::: /callout
::: /step
::: step "Generar Compilación de Producción"
Ejecuta el comando de compilación para generar un sitio estático optimizado.
```bash
npx @docmd/core build
```
::: /step
::: step "Desplegar en Infraestructura"
Publica el directorio `site/` compilado en S3, Cloudflare Pages o Vercel.
::: /step
::: /steps
- Configurar Entorno
Define opciones de proyecto en
docmd.config.json.Pista IDEUsa
defineConfigpara habilitar el autocompletado de IDE para las claves de esquema. - Generar Compilación de Producción
Ejecuta el comando de compilación para generar un sitio estático optimizado.
npx @docmd/core build - Desplegar en Infraestructura
Publica el directorio
site/compilado en S3, Cloudflare Pages o Vercel.
La documentación existente que utiliza listas ordenadas con 1. continúa analizándose sin problemas:
::: steps
1. **Configurar Entorno**
Define opciones en `docmd.config.json`.
::: /steps