Un índice para cualquier fichero Markdown, en cinco segundos
Los ficheros de documentación largos (un README de 800 líneas, un changelog, una guía de deploy) son difíciles de leer sin un índice arriba. Los lectores quieren saltar a "Solución de problemas" o "Referencia API" con un clic, no scrollear diez pantallas.
Esta herramienta lee tu Markdown, recoge cada heading (H1 a H6) y construye una lista anidada de bullets con enlaces a anclas. Los enlaces funcionan al instante en GitHub, GitLab, Docusaurus, Astro y la mayoría de generadores de sitios estáticos.
Nos saltamos los headings dentro de code fences (`# no es un H1 si está dentro de \`\`\`bash`). El generador soporta tres estilos de ancla (GitHub, GitLab, plano), un modo "insertar en documento", marcadores opcionales `<!-- TOC -->` para herramientas de auto-actualización y un toggle "saltar primer H1".
Cómo usarla
- Pega tu Markdown en el panel izquierdo. Por defecto se carga un ejemplo corto para que la herramienta tenga algo con lo que trabajar.
- Configura el rango de profundidad con los sliders, defaults H1 a H4. Si no quieres los headings más pequeños, pon max a H3. Si solo quieres secciones de nivel superior, pon max a H2.
- Elige un estilo de ancla: GitHub (lo más común, funciona también en GitLab y Docusaurus), GitLab (muy similar, pequeñas diferencias para dígitos iniciales), Plano (slugify clásico, solo ASCII).
- Activa "Lista numerada" si prefieres `1.` sobre `-`. Los números se auto-ajustan al renderizar (GitHub muestra 1, 2, 3 aunque cada entrada sea `1.`).
- "Saltar primer H1": si la primera línea del fichero es el título del documento (p. ej. el nombre del proyecto en un README), normalmente no lo quieres en el TOC. Cambia el interruptor.
- "Modo insertar": en vez de solo el TOC, el generador devuelve el documento completo con el TOC insertado justo después del primer H1. Útil cuando tienes un fichero grande existente y quieres añadir un TOC sin edición manual.
- Copia el TOC (o el documento completo en modo insertar) y pega en tu fichero. O descarga como fichero .md.
Cuándo es útil
Situaciones concretas en las que un índice vale la pena:
- Un README open-source grande. El fichero tiene 12 secciones: "Instalación", "Quick start", "Configuración", "API", "Ejemplos", "Solución de problemas", "Contribución", "Licencia". Sin TOC el usuario scrollea. Con TOC pulsa y aterriza.
- Un CHANGELOG.md con docenas de versiones. Un TOC enlazando a cada versión (`## v1.4.2, 2025-10-12`, `## v1.4.1, 2025-10-08`, ...) deja a los lectores saltar a la release interesante con un clic. Genera el TOC una vez, añade versiones nuevas arriba, el TOC necesita actualizarse manualmente o con una herramienta como `markdown-toc`.
- Docs técnicas en Docusaurus / Astro / MkDocs. Algunos temas renderizan un TOC en el sidebar automáticamente, pero un TOC en la página sigue ayudando en artículos largos. Genéralo aquí, pega en el fichero, listo.
- Migrar docs de Confluence / Notion. Los exports de esas herramientas rara vez vienen con un TOC usable. Pega, genera, pega el resultado arriba.
- Un libro o artículo de larga forma en Markdown. Los libros técnicos suelen escribirse en Markdown (Pragmatic Bookshelf, Manning). Cada capítulo necesita un índice de secciones.
- Docs internos de empresa. El README del repo de infra, un runbook de incidentes, un doc de onboarding, cualquier cosa con más de 5 secciones.
Si estás construyendo un README desde cero, usa nuestro generador de README, añade el TOC automáticamente. Tras ordenar las cosas, pasa el fichero por nuestro linter Markdown, pilla errores comunes de enlace ancla.