Revisar la estructura Markdown antes de publicar

Pega un README o un borrador de documentación para ver el esquema de encabezados y los avisos: saltos de nivel, anclas repetidas, bloques de código sin cerrar, enlaces vacíos o sin definición y espacios finales. El Markdown se lee como texto, nunca se renderiza y no se abre ningún enlace.

Se ejecuta localmente en tu navegador
Esta herramienta procesa todos los datos localmente en tu navegador.
Código MarkdownComprueba problemas estructurales sin renderizar, subir ni abrir enlaces.

Cómo revisar un documento Markdown antes de publicar

El comprobador lee como texto el Markdown que pegas y responde con tres cosas: el esquema de encabezados, los contadores de encabezados, enlaces y bloques de código, y los avisos estructurales que puede demostrar a partir del propio texto. No renderiza el documento, no lo sube y no abre ningún enlace, así que un borrador que aún no quieres compartir se puede revisar aquí mismo.

Todo se ejecuta en la página. En una sesión medida, las únicas peticiones que salieron del navegador fueron las de analítica del propio sitio: el borrador, los enlaces y el esquema se quedaron en la pestaña, y por eso el comprobador sigue funcionando sin conexión.

  1. Pega el README, la guía o el borrador de documentación en Código Markdown, o pulsa Cargar ejemplo para partir de un documento que ya contiene un encabezado repetido y un enlace vacío.
  2. Pulsa Comprobar Markdown. El esquema lista cada encabezado con el ancla que genera y su número de línea, el informe recoge lo que encontró cada regla y los contadores muestran los totales de encabezados, enlaces y bloques de código.
  3. Lee los avisos en orden: salto de nivel de encabezado, ancla repetida, bloque de código sin cerrar, enlace con texto vacío o sin destino, enlace de referencia sin definición, línea terminada en espacios que no son los dos del salto de línea, almohadilla sin espacio detrás y documento sin encabezado de nivel uno.
  4. Pulsa Copiar para llevarte el informe en texto plano, o Descargar para guardarlo como markdown-report.txt junto al archivo de origen.
  5. Pulsa Limpiar para vaciar los dos paneles antes del siguiente documento.

Qué lee el comprobador y qué deja intacto

Qué cuenta como enlace

Los enlaces en línea se cuentan con título opcional, como en [texto](https://example.com "título"), y con un nivel de paréntesis dentro del destino, que es lo que necesitan las URL al estilo de Wikipedia. Los enlaces de referencia cuentan cuando el documento define la etiqueta en cualquier punto: la forma completa [texto][ref], la forma colapsada [texto][] y la forma abreviada [ref] resuelven contra una línea como [ref]: https://example.com, con título o sin él. Los enlaces automáticos — <https://example.com> y <mailto:docs@example.com> — también cuentan.

Tres cosas que parecen enlaces se dejan fuera a propósito: las imágenes escritas como ![alt](imagen.png), la sintaxis de enlace dentro de código en línea como `[texto](url)` y las etiquetas HTML como <a href="https://example.com">, que son marcado y no un enlace automático. Un enlace de referencia sin definición se avisa en lugar de contarse.

Cómo se leen encabezados, bloques y front matter

Se reconocen los dos estilos de encabezado: ATX (de # a ######, con hasta tres espacios de sangría y un cierre opcional de #) y setext (una línea de párrafo subrayada con ==== para el nivel uno o ---- para el nivel dos). Las anclas se generan como lo hacen los generadores de sitios estáticos — minúsculas, sin puntuación y con los espacios convertidos en guiones — así que «Install now!» e «Install now?» chocan en #install-now y el segundo se avisa como ancla repetida.

Un bloque abierto con ``` o ~~~ oculta su contenido a todas las demás reglas, y lo cierra una línea final al menos tan larga como la de apertura; un bloque sin cerrar se avisa en la línea donde se abrió. Un documento que empieza por una línea --- se lee como front matter YAML hasta la siguiente línea --- o ..., de modo que los dos puntos, los corchetes y los espacios finales de los metadatos no se avisan como si fueran prosa.

Qué no hace el comprobador

No renderiza Markdown, así que no puede mostrar cómo quedará la página, y no solicita los destinos de los enlaces, así que una URL inalcanzable nunca se avisa. Comprueba las reglas de esta página y nada más: la longitud de línea, el estilo de las viñetas, las líneas en blanco alrededor de los bloques, la alineación de tablas y el resto de reglas de estilo de un linter completo quedan fuera, y un bloque de código sangrado con cuatro espacios se lee como texto normal.

Un documento de 4000 líneas con 4000 enlaces se analizó en unos 0,6 s en un navegador de escritorio, y el trabajo se hace al pulsar el botón, no mientras escribes. Para revisar un repositorio entero con un conjunto de reglas fijo, un linter de línea de comandos sigue siendo mejor herramienta; esta página responde por un solo borrador, sin subirlo.

Herramientas recientes: