Cómo se ve un capítulo
Capítulo de referencia. Cómo se ven los elementos típicos de un texto cuando se escribe en markdown y se publica en la biblioteca. Nada de contenido editorial — esto es solo un espejo para validar el render.
Este texto no es un capítulo editorial, es la referencia visual del lector. Si lo que ves en pantalla coincide con lo que esperabas — el render funciona. Si algo se ve raro, el problema está en el CSS, no en el texto.
Encabezados
Los capítulos usan H2 para las secciones principales y H3 para subdivisiones. H4 o más profundo se evita: si necesitas tanta jerarquía, probablemente tendrías que partir el capítulo en dos.
H3: una subdivisión dentro de una sección
Las subdivisiones aparecen cuando una sección tiene dos o tres caminos paralelos que merecen su propio rótulo. Si solo hay uno, mejor un párrafo.
Énfasis y formato inline
Texto en cursiva, texto en negrita, texto tachado para indicar algo descartado, y código inline para nombres de funciones, archivos o variables sueltas.
Tres formas de marcar lo importante:
- Negrita para la idea que el lector tiene que llevarse.
- Cursiva para énfasis suave o términos.
códigopara identificadores literales del proyecto.
No mezclamos los tres en la misma frase: confunde más de lo que resalta.
Listas
Lista sin ordenar
- Primer punto, una idea por línea.
- Segundo punto, evitando colas largas.
- Tercer punto, sin sub-items salvo que aporten:
- Sub-item solo si rompe una idea en dos partes concretas.
- Otro sub-item, no más.
Lista ordenada
- Paso uno: hacer X.
- Paso dos: validar Y.
- Paso tres: si Y falla, volver al paso uno.
Lista de tareas
- Algo completado.
- Otra cosa que ya está.
- Algo todavía abierto.
- Algo más pendiente.
Citas
Las citas se usan para resaltar una frase que sintetiza la sección. No para meter párrafos largos — para eso está el cuerpo.
Una cita puede ser parte de un razonamiento, no solo de un autor externo:
El refactor más caro es el que hicimos sin que nadie nos lo pidiera.
Bloques de código
// TypeScript es el lenguaje que más aparece en la biblioteca.
interface Chapter {
readonly slug: string;
readonly title: string;
readonly pillars: readonly string[];
}
const isVigente = (c: Chapter): boolean => c.state === "vigente";
# Comandos de shell, siempre con el contexto justo
pnpm test:unit
pnpm test:e2e -- --project=chromium
{
"name": "pulpocode",
"scripts": {
"build": "astro build"
}
}
Tablas
| Característica | Sí | No |
|---|---|---|
| Sintaxis ligera | ✓ | |
| Alineación por columna | ✓ | |
| Imágenes embebidas | ✓ |
| Estado | Significado |
|---|---|
| vigente | El criterio sigue aplicando hoy. |
| revisión | Se está revisitando — algo de lo que dice ya no es del todo cierto. |
| archivado | Conservado por trazabilidad, hay una versión nueva. |
Enlaces
Enlaces dentro de la biblioteca: los pilares, el índice. Enlaces externos: Astro.
No usamos enlaces inline para frases enteras (“haz clic aquí para leer más”). El texto del enlace debe ser el nombre del destino.
Lo que NO entra
- Emojis decorativos al final de párrafo (“¡Ya está! 🎉”). Confunden el tono.
- “Click here”, “Lee más”, “Suscríbete a la newsletter”.
- Notas tipo “pero esto es opcional” al final de un punto definitivo. O es opcional y se explica, o no se menciona.
- Diagramas Mermaid: por ahora no se renderizan; si necesitas un diagrama, exporta una imagen.
Cierre
Si todo lo de arriba se vio bien — sin saltos raros, sin código que se sale del contenedor, sin tablas que parten la línea — el render está sano. Si no, en src/styles/library.css viven las reglas de .reader-body y descendientes.