Generador de README
Elige las secciones que necesita tu README de una biblioteca de 17, reordénalas, rellena cada una y observa cómo se actualiza en vivo una vista previa al estilo GitHub — luego copia o descarga el README.md terminado.
Se ejecuta totalmente en tu navegador — los archivos nunca salen de tu dispositivo.
Todo lo de aquí — las secciones que elijas y su contenido — permanece en este navegador (localStorage) y nunca se sube a ningún sitio. Las imágenes de las insignias se obtienen de shields.io desde tu navegador cuando la vista previa las muestra.
Cómo funciona
- 01Empieza con el conjunto de secciones predeterminado (Título, Insignias, Instalación, Uso, Características, Contribuciones, Licencia, Agradecimientos) o añade más desde la biblioteca disponible — Stack tecnológico, Capturas de pantalla, Referencia de API, Variables de entorno, FAQ y otras.
- 02Haz clic en una sección de Seleccionadas para editarla en la columna central; usa los botones de flecha para reordenarla o la × para eliminarla.
- 03Rellena los campos del formulario de cada sección, o edita el Markdown directamente en secciones de texto libre como Stack tecnológico o Hoja de ruta.
- 04Abre la sección Insignias para crear insignias de shields.io — una insignia de licencia (sincronizada con lo que elijas en Licencia), versión de npm, estado de compilación y «PRs welcome».
- 05Revisa la vista previa de la derecha (o cambia a Sin formato para ver el código Markdown), y luego copia o descarga el README.md terminado.
Preguntas frecuentes
¿Qué pasa si dejo una sección en blanco?
Se omite por completo del README generado — no obtendrás un encabezado «## Uso» vacío sin nada debajo. Las secciones de texto libre (Stack tecnológico, Hoja de ruta, FAQ, …) funcionan igual: vacía el área de texto y esa sección desaparece del resultado.
¿Esto genera un archivo LICENSE real?
No, solo la sección de Licencia del README, con una breve declaración y un enlace al texto de la licencia. Añade el archivo LICENSE correspondiente a tu repositorio por separado (GitHub también puede añadirlo por ti con las mismas opciones: MIT, Apache 2.0, GPL v3, BSD 3-Clause, MPL 2.0, Unlicense).
¿Cómo funciona la sección Insignias?
Es un pequeño generador de insignias de shields.io: una insignia de licencia (que sigue por defecto lo que elijas en la sección Licencia, o se puede configurar de forma independiente), una insignia de versión de npm (introduce el nombre de tu paquete), insignias de «build passing» y «PRs welcome», y una insignia opcional de «Made with MarkdownLab» — todo se genera como enlaces de imagen Markdown normales que puedes editar libremente después.
¿Se envía algo de esto a un servidor?
No. Cada sección se ensambla en Markdown por completo en el JavaScript de tu navegador. Tus elecciones de secciones y su contenido se guardan solo en el almacenamiento local de este navegador (así una recarga no pierde tu trabajo) — no se sube nada a ningún sitio. Las imágenes de las insignias son la única excepción: shields.io las obtiene directamente cuando la vista previa las renderiza.
¿Puedo seguir editando el resultado después de generarlo?
Sí — cópialo o descárgalo, y luego ábrelo en el Editor de Markdown (o en cualquier editor de texto) para seguir perfeccionándolo. Este generador te da un punto de partida sólido y estructurado, no una plantilla cerrada.
Herramientas relacionadas
Generador de tablas Markdown
Crea tablas Markdown a partir de una cuadrícula sencilla.
AbrirHerramientaCurrículum en Markdown
Genera un currículum en Markdown a partir de un formulario breve.
AbrirHerramientaGenerador de diagramas Mermaid
Escribe sintaxis Mermaid y renderiza un diagrama en vivo.
Abrir