Generador de README y Vista Previa
Escribe o pega tu Markdown en el panel amplio de la izquierda y mira la vista previa exacta a la derecha, tal como se vería en GitHub, GitLab o Bitbucket. Usa la barra de herramientas para insertar formato o secciones completas (badges, tabla de contenido, instalación, uso, licencia) sin memorizar la sintaxis. Todo se procesa en tu navegador: nada se sube a ningún servidor.
La vista previa se actualiza mientras escribes. Usa la barra de herramientas para insertar formato o secciones completas.
Qué incluir en un buen README
- Un título claro y una descripción de una línea de qué hace el proyecto y para quién.
- Badges de build, versión y licencia para transmitir confianza de un vistazo.
- Instrucciones de instalación copiables (bloque de código) sin pasos ambiguos.
- Un ejemplo de uso mínimo que funcione al copiar y pegar.
- Una sección de licencia: sin ella, legalmente nadie puede reutilizar tu código con confianza.
Preguntas frecuentes
¿Mi Markdown se sube a algún servidor?
No. Todo el procesamiento y renderizado ocurre en tu navegador con JavaScript; el texto que escribes nunca se envía a ningún servidor.
¿Qué variante de Markdown usa este generador?
Un subconjunto amplio de GitHub Flavored Markdown (GFM): títulos, negrita, cursiva, tachado, enlaces, imágenes, listas, listas de tareas, citas, tablas, código en línea y bloques de código con lenguaje. El HTML incrustado directamente no se renderiza, por seguridad.
¿Sirve para GitLab, Bitbucket o npm?
Sí. Cualquier plataforma que renderice Markdown estándar (GitHub, GitLab, Bitbucket, npm, PyPI) mostrará el resultado de forma prácticamente idéntica a esta vista previa.
¿Cómo agrego badges (insignias)?
Usa el botón "Badges" en el menú de secciones para insertar un ejemplo con shields.io, o pega tu propia URL de badge dentro de la sintaxis de imagen: .
¿Puedo descargar el resultado como README.md?
Sí, el botón "Descargar README.md" genera el archivo .md exacto con el contenido del editor, listo para colocar en la raíz de tu repositorio.
¿Qué diferencia hay entre "README" y "README.md"?
Son lo mismo: README.md es simplemente un archivo README escrito en formato Markdown (la extensión .md), que es lo que GitHub, GitLab y la mayoría de plataformas esperan para renderizarlo automáticamente en la página del repositorio.