Guías

Guía de componentes

Todo lo que puedes usar al escribir una página de documentación.

Esta página es la guía viva del módulo de docs: muestra cada elemento disponible al escribir MDX. Úsala como referencia (y como página de prueba cuando se toque el shell de documentación).

Tipografía

Texto con negritas, cursivas, código en línea, tachado y enlaces internos relativos que se resuelven al idioma correcto automáticamente.

Las citas en bloque sirven para destacar ideas o referencias de terceros.

Avisos (Callout)

Información

El aviso por defecto, para contexto adicional.

Cuidado

Para advertencias que el lector no debería saltarse.

Peligro

Para acciones destructivas o errores comunes.

Tarjetas (Cards)

Código

Bloque con título y resaltado de sintaxis (shiki, temeado claro/oscuro):

lib/ejemplo.ts
export function saludar(nombre: string): string {
  return `Hola, ${nombre}`;
}

Con líneas resaltadas y numeración:

resaltado.ts
export function calcular(valores: number[]): number {
  return valores.reduce((total, v) => total + v, 0);
}

Con notación de diff:

cambios.ts
export function presupuesto(partidas: number[]): number {
  return partidas.reduce((total, p) => total + p, 0); 
  return partidas.reduce((total, p) => total + p * 1.18, 0); 
}

Pestañas (Tabs)

pnpm install
npm install

Pasos (Steps)

Levanta la base de datos

docker compose up -d en la raíz del repo.

Arranca el entorno

pnpm dev y abre http://localhost:3000.

Edita el contenido

Entra a /admin y configura la marca.

Árbol de archivos (Files)

index.mdx
instalacion.mdx
componentes.mdx

Acordeones (Accordions)

Diagramas (Mermaid)

Renderizados a SVG en el servidor — siguen el tema y la marca sin JavaScript:

aprobada cambios Editor escribe MDX Revisión en PR Deploy Docs publicados

Tablas

EjePregunta que respondeEjemplo
Servicios¿Qué hacemos técnicamente?Diseño estructural
Mercados¿Para qué industria?Salud
Tipologías¿Qué activo se construye?Hospital

Listas

  1. Los pasos numerados se usan para procedimientos.
  2. Cada paso debería ser una acción concreta.
  • Las viñetas agrupan ideas sin orden.
  • Como esta.

Última actualización

¿Te fue útil esta página?