Cómo convertir el README de un proyecto en PDF
Un README se ve bien en una plataforma de alojamiento de código, pero clientes, auditores y departamentos de compras suelen pedir la documentación del proyecto en un PDF que puedan archivar. Esta guía convierte el archivo Markdown en un documento ordenado sin herramientas de compilación.
El PDF conserva la estructura del README, así que títulos, listas, tablas y bloques de código se ven como el autor quería.
Paso a paso
Consigue el archivo README
Descarga README.md del repositorio o guárdalo desde tu editor. Se aceptan archivos de hasta 1 MB.
Conviértelo
Abre README a PDF y elige el archivo. No hay opciones; títulos, listas, tablas y bloques de código se maquetan solos.
Revisa las imágenes
Las imágenes que apuntan a una dirección de internet no se cargan. Si el README depende de capturas de pantalla, añádelas después como páginas aparte.
Únelo a otros documentos
Abre Unir PDF y añade el PDF del README junto con otros archivos, como una licencia, un registro de cambios o un diagrama de arquitectura.
Numera las páginas
Abre Numerar páginas de un PDF y elige un formato y una posición, para que los revisores puedan citar páginas exactas.
Herramientas de esta guía
Preguntas sobre esta tarea
- ¿Puedo convertir varios archivos Markdown?
- Convierte cada archivo por separado y después une los resultados con Unir PDF en el orden que quieras.
- ¿Se muestran las insignias y las imágenes remotas?
- No. Las imágenes enlazadas desde internet se omiten, así que las insignias desaparecen. El texto que las rodea se conserva.
- ¿Se sube el README?
- La conversión se hace en un servidor seguro que borra el archivo en cuanto envía el PDF. Unir y numerar funcionan en tu navegador.