polyshGenerador de índices Markdown
Obtén un índice anidado y con enlaces para cualquier documento Markdown.
- Funciona en tu navegador
- Sin subidas
- Sin cuenta
Cargando tu herramienta del navegador…
Qué hace Generador de índices Markdown
Un README, un SOP o una guía de administración largos necesitan un índice cerca del principio, y mantenerlo sincronizado a mano es fácil de hacer mal. Pega el documento entero y el generador lee cada encabezado, incluidos los subrayados con === y ---, y escribe una lista anidada de enlaces que saltan a cada sección.
Elige la profundidad con “Incluir hasta”, desde solo H2 hasta todos los niveles. Un único título H1 se deja fuera de forma predeterminada, porque suele dar nombre al propio documento. Activa “Índice numerado” para un esquema 1., 2., 3., que también sirve como mapa rápido de encabezados cuando reorganizas un documento.
Ejemplo
Entrada
# Manual del grabador ## Antes de grabar ### Prueba de micrófono (2 min) ## Edición ### Recortar pausas ## Edición #### Atajos de teclado
Resultado
- [Antes de grabar](#antes-de-grabar) - [Prueba de micrófono (2 min)](#prueba-de-micrófono-2-min) - [Edición](#edición) - [Recortar pausas](#recortar-pausas) - [Edición](#edición-1)
Se omite el título H1, el H4 queda por debajo de la profundidad H3 predeterminada, los paréntesis desaparecen del ancla y el segundo encabezado Edición enlaza a #edición-1.
Cómo usar Generador de índices Markdown
- Pega el documento Markdown completo o haz clic en “Abrir archivo” para cargar un archivo .md.
- Elige un nivel en “Incluir hasta”; en “Más opciones” están “Omitir un único título H1” e “Índice numerado”.
- Haz clic en “Copiar” o en “Descargar .md” y pega la lista bajo el título de tu documento.
Conviene saber
- GitLab, Bitbucket, Docusaurus y otros renderizadores pueden crear los id de forma distinta a GitHub en encabezados con puntuación o letras no latinas, así que prueba un par de enlaces allí.
- Se ignoran los encabezados dentro de código delimitado, como debe ser, pero tampoco se detectan los encabezados escritos en HTML como
<h2>. - La lista es una instantánea. Cuando cambies el nombre de un encabezado o añadas otros, vuelve a generarla; nada la mantiene actualizada.
Preguntas sobre Generador de índices Markdown
¿Cómo añado un índice a un README de GitHub?
Pega aquí el README, copia la lista generada y pégala bajo el título. Cada entrada enlaza a un ancla que GitHub crea para ese encabezado. GitHub también tiene un menú de esquema para los README, pero una lista dentro del archivo funciona en cualquier visor.
¿Por qué un enlace del índice no salta a su encabezado?
Normalmente porque el encabezado cambió después de crear la lista, o porque tu sitio crea las anclas de forma distinta a GitHub. Vuelve a generar la lista con el texto actual y compara un ancla con el id que tu sitio pone de verdad en ese encabezado.
¿Un índice debe incluir los encabezados H4?
Normalmente no. Quien lee recorre las secciones H2, y H3 añade detalle suficiente para guías largas. Bajar más hace la lista más larga que el contenido que resume, así que deja el H3 predeterminado y elige H4 o “Todos” solo para documentación de referencia.
¿Puedo numerar el índice?
Sí. Activa “Índice numerado” en “Más opciones”. Cada nivel se numera desde 1 y se sangra tres espacios, así que se renderiza como una lista ordenada anidada.