Repolode
Enviar
bwplotka

bwplotka/mdox

Una CLI en Go para dar formato a Markdown al estilo GFM, generar fragmentos de código a partir de comandos, comprobar enlaces y crear sitios estáticos de documentación.

Ver en GitHub
Estrellas
84
Forks
12
Issues abiertos
33
Último commit
hace 4 días

¿Qué es?

mdox es una herramienta de línea de comandos para mantener la documentación de un proyecto precisa y coherente. Da formato a los archivos Markdown directamente, siguiendo GitHub Flavored Markdown, y puede validar enlaces relativos y remotos. También permite omitir URL específicas o comprobar enlaces a incidencias y pull requests de GitHub mediante la API de GitHub.

Su función de generación de código reescribe bloques de código cercados marcados con la directiva mdox-exec: ejecuta un comando e inserta su salida. Así, el texto de ayuda de la CLI, los archivos de configuración de ejemplo o los fragmentos de código fuente se mantienen sincronizados con el código que describen. Es posible declarar códigos de salida distintos de cero para cada bloque.

Para sitios web, mdox puede reescribir enlaces con rutas relativas para sitios con varios dominios o versiones, y ejecutar transformaciones que añaden front matter y back matter, cambian el nombre de los archivos o los mueven, y adaptan los enlaces para generadores de sitios estáticos como Hugo. También se puede usar como biblioteca de Go.

Funciones clave

  • 01Da formato a archivos Markdown directamente para aplicar un estilo GFM coherente.
  • 02Genera automáticamente el contenido de bloques de código ejecutando comandos, como los que muestran la ayuda de una CLI.
  • 03Comprueba enlaces relativos y remotos, con reglas configurables para omitirlos y validación compatible con GitHub.
  • 04Reescribe enlaces con rutas relativas para sitios web con varios dominios o versiones.
  • 05Transforma archivos Markdown con front matter, back matter y movimientos de archivos para generadores de sitios estáticos.

Casos de uso

  • Mantener actualizados mediante CI el texto de ayuda de una CLI y los ejemplos de configuración en el README de un repositorio.
  • Detectar enlaces rotos en la documentación durante las comprobaciones de pull requests.
  • Publicar documentación de un proyecto con versiones a partir de archivos Markdown en un sitio estático.

Inicio rápido

  1. 1

    Instala la CLI mdox con Go

  2. 2

    Da formato a los archivos Markdown con mdox fmt

    mdox fmt *.md

Antes de usarlo

  • El README no incluye un comando go install explícito, por lo que el paso de instalación no se muestra como un comando.
  • El proyecto es pequeño, con 80 estrellas, así que el apoyo de la comunidad puede ser limitado.

En colecciones

Herramientas de CLI y terminalGeneradores de sitios estáticos y herramientas de documentación

Temas

#markdown#documentation#cli#link-checker#static-site#golang#code-generation

Preguntas frecuentes

¿Qué es mdox?
Una CLI en Go para dar formato a Markdown al estilo GFM, generar fragmentos de código a partir de comandos, comprobar enlaces y crear sitios estáticos de documentación. mdox es una herramienta de línea de comandos para mantener la documentación de un proyecto precisa y coherente. Da formato a los archivos Markdown directamente, siguiendo GitHub Flavored Markdown, y puede validar enlaces relativos y remotos. También permite omitir URL específicas o comprobar enlaces a incidencias y pull requests de GitHub mediante la API de GitHub.
¿mdox es gratuito? ¿Qué licencia tiene?
mdox es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿mdox sigue mantenido?
Mantenimiento activo. El último commit de mdox fue el 3 nov 2026.
¿Para qué puedo usar mdox?
Mantener actualizados mediante CI el texto de ayuda de una CLI y los ejemplos de configuración en el README de un repositorio. Detectar enlaces rotos en la documentación durante las comprobaciones de pull requests. Publicar documentación de un proyecto con versiones a partir de archivos Markdown en un sitio estático.
¿Cómo se instala mdox?
Instala la CLI mdox con Go Da formato a los archivos Markdown con mdox fmt: mdox fmt *.md
¿Dónde consigo mdox?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/bwplotka/mdox

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados