Datos clave
- Categoría
- Conversión y codificación
- Tipos de entrada
- textarea, select, checkbox
- Tipo de salida
- text
- Cobertura de muestras
- 4
- API disponible
- Yes
Resumen
El Generador de TOC Markdown es una herramienta diseñada para crear automáticamente tablas de contenidos estructuradas a partir de los encabezados de tus documentos Markdown. Al procesar los títulos, genera un índice jerárquico con enlaces de anclaje compatibles con el formato de GitHub, permitiendo personalizar el nivel de los encabezados, el estilo de lista, la sangría y el formato de salida en Markdown o HTML.
Cuándo usarlo
- •Al redactar archivos README.md extensos para repositorios de GitHub que requieren un índice de navegación rápido.
- •Al estructurar documentación técnica o manuales de usuario escritos en Markdown para facilitar la lectura.
- •Al preparar artículos de blog o guías en formato Markdown que necesitan una tabla de contenidos en HTML o Markdown antes de su publicación.
Cómo funciona
- •Pega el contenido de tu documento Markdown en el campo de entrada de texto.
- •Configura los niveles de encabezado mínimo y máximo (H1-H6), el estilo de lista (ordenada o desordenada) y el tipo de sangría.
- •Selecciona si deseas incluir enlaces ancla y define el formato de salida (Markdown, HTML o ambos).
- •Copia la tabla de contenidos generada automáticamente y pégala al inicio de tu documento.
Casos de uso
Ejemplos
1. Índice para un README de GitHub
Desarrollador de Software- Contexto
- Está preparando el archivo README.md para un nuevo proyecto de código abierto y quiere que los usuarios naveguen fácilmente por las secciones de instalación, uso y contribución.
- Problema
- Crear manualmente los enlaces ancla para cada sección es propenso a errores y requiere mucho tiempo.
- Cómo usarlo
- Pega el contenido del README en la herramienta, selecciona el nivel mínimo H2 y máximo H4, y mantén activada la opción de enlaces ancla.
- Configuración de ejemplo
-
markdownInput: '# Mi Proyecto\n## Instalación\n### Requisitos\n## Uso', minLevel: '2', maxLevel: '4', listStyle: 'unordered', indent: '2spaces', includeAnchor: true, outputFormat: 'markdown' - Resultado
- Obtiene una lista desordenada en Markdown con enlaces directos a las secciones de Instalación, Requisitos y Uso lista para pegar.
2. Tabla de contenidos en HTML para Blog
Redactor de Contenidos- Contexto
- Escribe artículos largos en Markdown y los publica en una plataforma que requiere código HTML para la navegación interna.
- Problema
- Necesita transformar la estructura de títulos de su borrador Markdown en una lista ordenada de HTML con enlaces internos.
- Cómo usarlo
- Introduce el borrador en la herramienta, selecciona el formato de salida HTML y elige el estilo de lista ordenada.
- Configuración de ejemplo
-
markdownInput: '# Guía SEO\n## 1. Introducción\n## 2. Estrategia', minLevel: '2', maxLevel: '3', listStyle: 'ordered', indent: '4spaces', includeAnchor: true, outputFormat: 'html' - Resultado
- Genera un bloque de código HTML estructurado con etiquetas <ol> y <li> que enlazan a los encabezados correspondientes.
Probar con muestras
markdown, barcodeHubs relacionados
Preguntas frecuentes
¿Cómo genera la herramienta los enlaces de anclaje?
Utiliza el formato estándar de GitHub, convirtiendo los encabezados en minúsculas y reemplazando los espacios por guiones.
¿Puedo excluir ciertos niveles de encabezado del índice?
Sí, puedes definir el rango exacto ajustando los niveles mínimo y máximo de encabezado, por ejemplo, de H2 a H4.
¿Qué formatos de salida admite la herramienta?
Admite salidas en formato Markdown, HTML o una combinación de ambos.
¿Es obligatorio que la lista sea desordenada?
No, puedes elegir entre listas desordenadas (con guiones) o listas ordenadas (con números).
¿La herramienta modifica mi texto original?
No, la herramienta solo lee los encabezados del texto ingresado para generar el índice independiente.