Visor de README de GitHub: pega o abre un README, mira la vista previa GFM y define una URL base para los enlaces relativos. No se descarga nada de GitHub.
¿Qué es GitHub README Viewer?
GitHub README Viewer es una herramienta en línea gratuita que muestra la vista previa de un README escrito en GitHub Flavored Markdown (GFM) en tu navegador. Pega o abre el README, define una URL base para los enlaces relativos y lee la página renderizada. No se descarga nada de GitHub.
Qué admite
- GFM: tablas, listas de tareas, tachado y código en bloque.
- URL base (opcional): una URL http o https sin credenciales que resuelve enlaces relativos como docs/guide.md. Sin ella, los enlaces relativos quedan no disponibles.
Conviene saber
- La vista previa es aproximada y no es el renderizador de GitHub, así que las funciones que GitHub añade a GFM pueden verse distinto o no aparecer.
- Las imágenes, las insignias y otros archivos a los que apunta el README no se cargan: la imagen aparece como su texto alternativo, y la herramienta avisa de los archivos ausentes.
- Un README en una dirección remota no se descarga. Pega o abre su texto. Esta herramienta no está afiliada a GitHub.
¿Cómo se usa GitHub README Viewer?
- Pega el texto del README o abre el archivo.
- Si quieres que los enlaces relativos se resuelvan, indica una URL base.
- Lee la Vista previa y la lista Enlaces e imágenes no disponibles. Este panel no ofrece Copiar ni Descargar.
Ejemplo
Un README con una insignia y un enlace relativo, y la URL base https://github.com/acme/my-app/blob/main/.
# my-app

See [the guide](docs/guide.md).El enlace a docs/guide.md se convierte en https://github.com/acme/my-app/blob/main/docs/guide.md, y la insignia aparece como su texto alternativo, Build status.
Límites y privacidad
Límites
- Texto: hasta 2.000.000 bytes en UTF-8 (unos 2 MB). Las letras acentuadas y los emojis ocupan más de un byte cada uno. Una entrada o un texto generado mayor se rechaza.
¿Se envía mi contenido a un servidor?
No. Tu contenido y tus archivos se procesan en el navegador y nunca se suben. El OCR y la lectura de PDF descargan archivos de procesamiento, incluidos datos de idioma del OCR y el worker de PDF, de este mismo sitio solo cuando se ejecutan esas herramientas; ningún contenido va a terceros. Las vistas previas Markdown muestran imágenes externas como texto alternativo, sin cargarlas.
Copiar pone un resultado en el portapapeles y descargar lo guarda como archivo, pero solo cuando pulsas el botón. El archivo se crea en tu navegador, así que no se sube nada.
Para conocer todos los detalles, consulta la Política de privacidad
Herramientas y páginas relacionadas
Convierte desde o hacia otros formatos, o trabaja con el mismo contenido en estas herramientas.