README a PDF

Cómo convertir un README.md a PDF

Un README funciona muy bien en un repositorio, pero a veces necesitas enviarlo a clientes, docentes o compañeros como un documento estable. Esta guía muestra cómo limpiarlo, comprobar su estructura y exportarlo a PDF.

Guía práctica · 5 min

Antes de convertir

Usa un solo título principal y organiza el resto con subtítulos.
Revisa que los enlaces absolutos sigan funcionando fuera del repositorio.
Añade lenguaje a los bloques de código para conservar su legibilidad.

Del repositorio al documento

Revisa la jerarquía
Deja un único encabezado H1 para el proyecto. Utiliza H2 para instalación, uso y configuración, y H3 únicamente cuando una sección necesite subdividirse.
Corrige recursos relativos
Una imagen como ./docs/captura.png depende del repositorio. Para un documento compartible, usa una URL pública estable o elimina el recurso si contiene información interna.
Comprueba código y tablas
Indica el lenguaje del bloque de código y evita tablas excesivamente anchas. Una tabla corta se adapta mejor a una página A4 o Carta.
Ajusta y exporta
Carga el README, selecciona el tamaño de página y revisa la vista previa. Si el documento es largo, activa la tabla de contenido antes de descargar el PDF.

README a PDF

Prueba con un README breve

Edita la descripción o agrega un requisito. La vista previa refleja el Markdown sin ejecutar HTML ni scripts.

Abrir en el convertidor

Puedes modificar el ejemplo aquí. Al abrirlo en el convertidor se cargará la versión original y podrás exportarla.

Markdown editable

Vista previa

Atlas CLI

Una herramienta pequeña para validar archivos de configuración antes de desplegar.

Instalación

bash

npm installnpm run build

Uso

Copia .env.example como .env.
Ejecuta npm run validate.
Corrige los avisos antes de publicar.

Comando	Propósito
`npm test`	Ejecuta las pruebas
`npm run build`	Genera la versión final

Consejo: no incluyas secretos ni credenciales en el README.

Detalles que mejoran el PDF

Elimina insignias y contadores que solo tienen sentido dentro del repositorio.
Sustituye referencias como “haz clic arriba” por instrucciones que funcionen en una página.
Si el README incluye una licencia completa, considera moverla a una página nueva con un salto explícito.

Preguntas frecuentes

¿El README se envía a un servidor?

No. md2pdf lee y convierte el contenido dentro del navegador.

¿Se conservan los bloques de código?

Sí. El PDF mantiene el bloque, el lenguaje indicado y el ajuste de líneas largas.