Visor y vista previa de README.md

Revisa un README antes de hacer push. Abre el archivo, pega el texto o suelta un enlace de GitHub y ve insignias, tablas, bloques de código, listas de tareas, alertas y diagramas Mermaid renderizados tal como los muestra GitHub.

Previsualizar un README

Gratis · sin registro · funciona en tu navegador, no se sube nada

El README de markdown-it abierto desde una URL de GitHub, renderizado con insignias, alertas y código en GitHub Dark — Un README real abierto directamente desde un enlace de GitHub: insignias, alertas, tablas y código se ven como en GitHub.

Abre un README desde GitHub o desde el disco

Pega una URL de GitHub como https://github.com/user/repo/blob/main/README.md en Abrir → Desde URL: el visor la convierte en el enlace al archivo raw por ti y lo renderiza. Los enlaces de Gist funcionan igual. Para un proyecto en tu equipo, suelta el README.md en la página o pega su contenido en el editor.

Todo lo que renderiza GitHub, renderizado igual

GitHub-Flavored Markdown es un dialecto concreto, y los README se apoyan en sus extras: tablas con barras, listas de tareas - [ ], ~~tachado~~, URL autoenlazadas, alertas > [!NOTE] / [!WARNING], secciones <details> para instrucciones de instalación largas, insignias de shields.io, anclas de encabezado relativas y código delimitado con etiquetas de lenguaje. Todo se renderiza aquí, con los mismos id de encabezado que genera GitHub para que tus enlaces internos sigan funcionando. Los diagramas Mermaid, que GitHub también dibuja, se renderizan igualmente.

Arréglalo antes del commit

Cambia a la disposición Dividido y edita el README con vista previa en vivo: la barra de herramientas inserta tablas y listas de tareas, los atajos se encargan de negrita, enlaces y encabezados, y el esquema muestra si la estructura de secciones se lee bien. Descarga el .md cuando se vea bien, o copia el HTML renderizado para un sitio del proyecto. Los README no son los únicos archivos Markdown de un repositorio: los archivos de instrucciones como CLAUDE.md y AGENTS.md se abren de la misma manera; consulta el visor de CLAUDE.md.

Míralo en acción

Alertas Note, Important, Warning y Caution al estilo GitHub, una cita y una sección details plegable en el tema GitHub Dark — Alertas al estilo GitHub, citas y secciones <details> plegables, en GitHub Dark.

Bloques de código TypeScript, Python, Bash y diff con resaltado de sintaxis, etiquetas de lenguaje y botones de copiar — Los bloques de código tienen etiqueta de lenguaje, resaltado de sintaxis para más de 50 lenguajes y botón de copiar; este es el tema One Dark.

Fórmula KaTeX en modo bloque y diagrama de flujo Mermaid renderizados dentro de la vista previa — Las fórmulas KaTeX y los diagramas de flujo Mermaid se renderizan directamente en el documento.

Cómo funciona

1
Pega un enlace de README de GitHub en Abrir → Desde URL, o suelta el archivo en la página.
2
Léelo renderizado, con insignias, tablas, código y diagramas en su sitio.
3
Edita en modo Dividido y luego descarga el README.md actualizado.

Qué obtienes

Enlaces de GitHub, convertidos

Las URL blob y Gist se convierten en archivos raw automáticamente.

GFM completo

Tablas, listas de tareas, alertas, notas al pie, details, insignias, autoenlaces, emoji.

Diagramas Mermaid

Los diagramas de arquitectura y de flujo se renderizan en su sitio.

Temas oscuros y claros

Comprueba cómo se lee el README tanto en GitHub Dark como en Light.

Edita con vista previa

Corrige problemas de formato y descarga el archivo corregido.

Privado

Los archivos locales nunca salen de tu navegador; las descargas por URL no se guardan.

Preguntas frecuentes

¿Se verá idéntico a GitHub?

Las reglas de Markdown y los id de encabezado coinciden con GitHub-Flavored Markdown, y los temas GitHub Light / Dark usan los colores de GitHub. Puede haber pequeñas diferencias de espaciado, pero la estructura, tablas, código y alertas se renderizan igual.

¿Puedo previsualizar el README de un repositorio privado?

No por URL, porque el servidor no puede autenticarse en GitHub. Descarga el archivo y suéltalo en la página: se queda en tu dispositivo.

¿Funcionan los enlaces de imagen relativos?

Las imágenes con URL absolutas se renderizan. Las rutas relativas como docs/logo.png no se pueden resolver para un archivo local; al abrir desde una URL de GitHub, usa rutas de raw.githubusercontent.com.

¿Se muestran las insignias?

Sí. Las insignias son imágenes normales con URL absolutas y se renderizan con normalidad.

¿Puedo renderizar un README de otro sitio que no sea GitHub?

Sí, cualquier URL pública que devuelva un archivo Markdown funciona. Las páginas HTML se rechazan para que sepas que debes usar el enlace raw.

Herramientas relacionadas

Listo cuando tú lo estés

Pega Markdown, suelta un archivo o abre una URL: la vista previa aparece al instante y todo se queda en tu dispositivo.

Abrir Markdown Viewer