¿qué es un generador de tabla de contenidos Markdown?
Un generador de índice de Markdown lee los encabezados de un documento de Markdown y produce una lista anidada de enlaces que saltan a cada sección. Pegas tu Markdown y la herramienta devuelve un bloque listo para usar, como una lista con viñetas donde cada línea es un enlace `[Heading](#anchor)`. Le evita escribir el esquema a mano y adivinar la identificación del ancla que un renderizador asignará a cada encabezado.
El corazón de la herramienta es el ancla slug. GitHub, GitLab y la mayoría de los generadores de sitios estáticos convierten un encabezado como "Getting Started" en el id `getting-started` bajando el texto, eliminando puntuación y reemplazando espacios con guiones. Este generador aplica la misma regla, incluido el sufijo numérico (`-1`, `-2`) que GitHub agrega cuando dos encabezados comparten un slug, por lo que los enlaces que produce se resuelven a los identificadores exactos que representará su página README o docs. Lee los encabezados ATX (líneas que comienzan con `#`) y los encabezados Setext (texto subrayado con `=` o `-`), e ignora cualquier `#` que aparezca dentro de un bloque de código cercado. Los encabezados que llevan formato en línea se manejan de la misma manera: un enlace, texto en negrita, código en línea o una imagen dentro de un encabezado se reduce a su texto sin formato para la etiqueta, y el ancla se construye a partir de esa misma cadena limpia, por lo que los dos siempre están de acuerdo.
Todo se ejecuta en tu navegador. El Markdown que pegas se analiza con JavaScript del lado del cliente y nunca sale de tu dispositivo, por lo que no hay carga, cuenta ni seguimiento de tu contenido. La herramienta funciona sin conexión una vez que la página se ha cargado, le permite elegir los niveles de encabezado a incluir, cambiar entre listas con viñetas y numeradas, controlar la sangría y actualiza el esquema en el momento en que cambia una opción.
¿cómo utilizar el generador TOC Markdown?
Pega tu rebaja
Coloque su documento de Markdown completo o README en el cuadro de entrada. Los encabezados dentro de bloques de código vallados se omiten automáticamente.
Elija los niveles de encabezado
Establezca los niveles más superficiales y profundos para incluir. Una opción común es H2 a H3, que mantiene el esquema legible sin enumerar cada subsección.
Elija el estilo de lista
Cambie entre una lista con viñetas o numerada, active o desactive los enlaces de anclaje y seleccione sangría de dos, cuatro espacios o pestañas.
Copie la tabla de contenidos
Copie el Markdown generado y péguelo cerca de la parte superior de su documento. Cada entrada enlaza con el ancla de encabezado correspondiente.
Características clave
Anclajes compatibles con GitHub
Slugs coincide con los identificadores que representa GitHub, incluidos los sufijos numéricos para encabezados duplicados, para que cada enlace se resuelva correctamente.
Filtrado de niveles
Incluya solo los niveles de encabezado que desee. La anidación se mide a partir del encabezado incluido más superficial, por lo que una lista que comienza en H2 permanece al ras a la izquierda.
Ordenado o desordenado
Genere una lista con viñetas o una lista numerada con contadores por nivel, con enlaces de anclaje opcionales y sangría configurable.
Consciente del bloque de código
Los encabezados escritos dentro de bloques de código vallados se ignoran, por lo que los fragmentos de ejemplo nunca se filtran en su esquema.
Frequently Asked Questions
Related Tools
HTML Table Generator
Generate an accessible HTML table from pasted CSV or tab-separated data. Add a header row, caption, striped rows, and borders, then copy the HTML and CSS. Runs client-side.
HTML to Markdown
Convert HTML to clean Markdown instantly. Turns headings, lists, links, images, blockquotes, code blocks and tables into portable GitHub Flavored Markdown. Tolerant of messy CMS markup. Runs client-side.
Markdown to HTML
Convert Markdown to clean, semantic HTML with GitHub Flavored Markdown support - tables, task lists, fenced code, heading anchors, live preview and a full HTML document export.
WordPress Readme Generator
Write a plugin readme.txt the WordPress.org directory parses, with a live preview of the listing it produces and a download when it is right.
Comments
0 comments
No comments yet. Be the first to share your thoughts!