Markdown de GitHub a PDF
README a PDF para cualquier proyecto de GitHub
Un README está pensado para leerse en GitHub, pero a veces tiene que viajar como archivo: la entrega a un cliente, una carpeta de cumplimiento, un trabajo académico. MDPress lee el mismo Markdown con extensiones de GitHub, así que las listas de tareas, tablas y bloques de código salen como un PDF paginado con código resaltado y texto seleccionable.
Abrir el conversorConvierte un README de GitHub a PDF en tres pasos.
- 01
Obtén el Markdown original
Abre README.md en GitHub y pulsa el botón Raw, o usa el icono de copiar archivo sin formato que está al lado. Si tienes el repositorio clonado, el archivo ya está en tu disco.
- 02
Pégalo o súbelo
Pega el texto en el editor, o elige Subir Markdown y abre el archivo .md. La vista previa en vivo muestra cada sección en páginas reales, así que puedes detectar una imagen que falta o una línea de código muy larga antes de exportar.
- 03
Ajusta la página y descarga
El estilo Técnico numera las secciones y da más espacio a los bloques de código, lo que conviene a la documentación. Elige A4 o US Letter, activa un índice si el README es largo, y descarga.
Un README pequeño, listo para convertir.
Pega un archivo como este y cada parte se traslada al PDF.
# tinycache
Una pequeña caché en memoria para Node.js con expiración basada en tiempo.
## Instalación
```bash
npm install tinycache
```
## Uso
```js
import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });
```
## Hoja de ruta
- [x] Expiración por clave
- [ ] Límite de tamañotinycache
Una pequeña caché en memoria para Node.js con expiración basada en tiempo.
Instalación
npm install tinycache
Uso
import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });
Hoja de ruta
- Expiración por clave
- Límite de tamaño
Por qué convertir un README aquí.
Lee Markdown con extensiones de GitHub
Las listas de tareas, tablas con barras, bloques de código con etiqueta de lenguaje, enlaces automáticos y texto tachado se interpretan todos, porque el conversor sigue la misma variante que usa GitHub. Un bloque mermaid se dibuja como diagrama, igual que en la página del repositorio.
Código que se lee bien en papel
Los comandos de instalación y las muestras de configuración se resaltan según el lenguaje. Una línea más ancha que la página se ajusta dentro de su bloque en vez de salirse del borde, así que nadie tiene que adivinar el final de un comando largo.
Un índice a partir de tus títulos
Los README largos ya tienen un esquema en sus títulos. La herramienta Índice lista los primeros tres niveles de título en una página inicial, con números de página, y la herramienta Portada añade una página con el nombre del proyecto, el autor y la fecha.
Consejos y límites reales.
- Las rutas de imagen relativas como docs/screenshot.png no cargarán, porque el conversor no puede ver tu repositorio. Sube la imagen con la herramienta Imágenes, o sustituye la ruta por la dirección web completa de la imagen.
- El HTML sin formato se muestra como texto y no se procesa. Muchos README usan HTML para un logo centrado, insignias en fila o una sección plegable, así que reescribe esas partes en Markdown puro o quítalas.
- Los enlaces relativos a otros archivos del repositorio, como CONTRIBUTING.md, no llevan a ningún lado dentro de un PDF. Cámbialos por direcciones completas de GitHub antes de exportar.
Preguntas sobre README a PDF.
- ¿Puedo pegar un enlace de GitHub y convertir el README directamente?
- No. MDPress no obtiene repositorios. Abre el README en GitHub, pulsa Raw, copia el texto y pégalo, o sube el archivo README.md desde tu clon. Toma solo unos segundos y también funciona con repositorios privados, ya que tú aportas el texto.
- ¿Por qué faltan las imágenes en mi README convertido a PDF?
- Lo más probable es que el README apunte a imágenes con rutas relativas, que solo funcionan dentro del repositorio. Añade cada imagen con la herramienta Imágenes para que quede incrustada en el documento, o enlaza a una dirección absoluta en la web. Las imágenes incrustadas cuentan dentro del límite de 4 MB.
- ¿Funcionan las insignias y los bloques HTML en un README?
- Las insignias escritas con la sintaxis de imagen de Markdown y una dirección web completa cargan como cualquier otra imagen. Todo lo escrito como etiquetas HTML se imprime como texto literal, así que un bloque de encabezado centrado o una sección de detalles necesita convertirse a Markdown primero.
Convierte el README en un archivo que puedas enviar.
Pega el Markdown original o sube README.md, revisa la vista previa y descarga. No se necesita cuenta para los primeros cuatro PDF de cada día.