Eliminar comentarios de Markdown: regex y limpieza automática

PublicadoHerramientaEliminador de Comentarios de Markdown

Contenido
  1. 1. Cómo funciona la expresión regular que elimina los comentarios HTML de Markdown
  2. 2. Cómo integrar la eliminación de comentarios en el proceso de compilación
  3. 3. Excepciones que se suelen pasar por alto al eliminar comentarios
  4. Resumen
  5. Preguntas frecuentes

Cuando estás puliendo el archivo README.md de un proyecto de código abierto en GitHub o colaborando en la traducción de documentación técnica, es muy común dejar notas internas o frases de referencia para la traducción escondidas en forma de comentarios de Markdown.

Sin embargo, al generar y publicar la versión final (Static Build) o al hacer público el documento Markdown para cualquier lector, esas notas internas pueden quedar visibles tal cual en el código fuente. En este artículo repasamos el funcionamiento de la expresión regular que elimina únicamente los comentarios HTML de un documento Markdown, junto con las excepciones que se suelen pasar por alto.

1. Cómo funciona la expresión regular que elimina los comentarios HTML de Markdown

La forma de comentario que define la especificación de Markdown es la misma que en HTML: <!-- contenido del comentario -->. La expresión regular que captura solo esa estructura y la elimina de todo el documento es la siguiente.

/<!--[\s\S]*?-->/g

Qué hace esta expresión regular

  • <!--, --> : son los límites de inicio y fin del comentario.
  • [\s\S]*? : abarca tanto caracteres de salto de línea (\s) como caracteres que no lo son (\S), de modo que también detecta comentarios de varias líneas con saltos de línea dentro.
  • El signo de interrogación (?) indica una coincidencia no codiciosa (non-greedy). Si lo quitas, cuando el documento tenga varios comentarios se producirá el fallo de borrar de golpe desde el inicio del primer comentario hasta el final del último.

Si pasas esta expresión regular a una función de reemplazo de cadenas, obtienes el resultado sin los comentarios.

cleanedText = originalText.replace(/<!--[\s\S]*?-->/g, "")

2. Cómo integrar la eliminación de comentarios en el proceso de compilación

En la práctica, esta sustitución se incorpora al paso de compilación que convierte Markdown en HTML para automatizarla.

// Ejemplo de pipeline de Markdown para un sitio estático como Next.js
function markdownLoader(content) {
  // Elimina los comentarios HTML justo antes de compilar
  // para que las notas internas no queden en el resultado publicado.
  const cleanContent = content.replace(/<!--[\s\S]*?-->/g, "");
  return marked.parse(cleanContent);
}

No hace falta revisar los comentarios a ojo con buscar (Ctrl+F) en el editor cada vez, ni revisarlos a mano antes de subirlos a Git. Si pegas el texto original en el Eliminador de Comentarios de Markdown de aquí abajo, podrás copiar directamente el resultado con solo los comentarios eliminados usando la misma expresión regular. Si no quieres que queden líneas vacías donde estaban los comentarios, activa también la opción "Limpiar líneas vacías", y en pantalla se mostrará además cuántos comentarios se han eliminado.

Eliminador de Comentarios de Markdown

Copia y pega el texto Markdown que quieres limpiar y pulsa Eliminar comentarios para obtener una versión limpia, sin comentarios internos, lista para compartir.

3. Excepciones que se suelen pasar por alto al eliminar comentarios

SituaciónPunto a tener en cuenta
Casos en los que la cadena <!-- aparece tal cual dentro de un ejemplo de códigoTambién se borra la cadena <!-- que habías escrito para mostrarla como ejemplo de código. Hay que separar primero el bloque de código, aplicar la eliminación de comentarios y después volver a colocarlo.
Frontmatter de Jekyll, Astro, etc. (la sección --- al inicio del documento)Los metadatos YAML del principio del documento también pueden quedar dentro del alcance de la expresión regular de comentarios, así que hay que delimitar el frontmatter por líneas y excluirlo.
Documentos con varios comentarios dispersosSi falta la coincidencia no codiciosa (?), como se explicó antes, se borra todo de golpe desde el primer comentario hasta el último.

Resumen

Los comentarios HTML de Markdown se pueden eliminar con la expresión regular /<!--[\s\S]*?-->/g. No debes olvidar la coincidencia no codiciosa para evitar el accidente de que desaparezca parte del cuerpo del texto en documentos con varios comentarios, y para estar seguro tienes que tratar por separado las cadenas <!-- dentro de los ejemplos de código y la sección de frontmatter. Si te resulta engorroso ejecutar la expresión regular por tu cuenta, puedes pegar el texto original en la herramienta y comprobar el resultado al instante.

Eliminador de Comentarios de Markdown

Copia y pega el texto Markdown que quieres limpiar y pulsa Eliminar comentarios para obtener una versión limpia, sin comentarios internos, lista para compartir.

Preguntas frecuentes

¿Se elimina también si el comentario contiene sintaxis de Markdown?

Sí. El contenido entre <!-- --> se elimina por completo, sin importar su formato. Aunque dentro haya sintaxis de Markdown o texto normal mezclado, se borra según los límites del comentario (<!--, -->).

¿Se puede usar la misma expresión regular en archivos HTML?

Sí, como la notación de comentarios en HTML es la misma, el mismo patrón funciona igual. Eso sí, en HTML pueden aparecer cadenas similares dentro de las etiquetas <script> y <style>, así que conviene revisar las excepciones una vez más que en Markdown.

Este artículo está adaptado de nuestro original en coreano. Leer el original en coreano

Artículos relacionados

  1. Verbos de acción para el currículum: fórmula y ejemplos por áreaAprende la fórmula para escribir frases de currículum centradas en resultados y elige verbos de acción de liderazgo, técnica, análisis y procesos.
  2. Cómo configurar cookies SameSite con sus 6 atributosCómo Domain, Path, Max-Age, SameSite, Secure y HttpOnly afectan el envío y la caducidad de las cookies, y por qué document.cookie y Set-Cookie no coinciden.
  3. Diferencia entre async y defer: carga y ejecución de scriptsCompara cómo la carga normal, async y defer afectan al parseo del HTML: cuándo se descarga el script, cuándo se ejecuta y si bloquea el renderizado.
  4. Barra de desplazamiento CSS: cambio de color en Chrome y FirefoxTu CSS de la barra de desplazamiento funciona en Chrome pero no en Firefox: así difieren ::-webkit-scrollbar y scrollbar-color, y cómo generar ambos.
  5. Cómo compartir un texto secreto sin dejarlo en el servidorCifra y comprime el texto en tu navegador y compártelo dentro de la URL: nada se guarda en el servidor. Te explicamos cuándo se cifra de verdad.
  6. Convertidor de mayúsculas y minúsculas: 4 formatos y sus reglasConvierte texto en inglés a Sentence Case, Title Case, snake_case o kebab-case y descubre qué palabras quedan en minúscula y por qué.

Herramientas relacionadas