Crea un README.md de GitHub con formulario guiado (insignias, instalación/uso, licencia, contribución) y vista previa en vivo. Nada sale de tu dispositivo.
🔒 Privado por diseño: todo funciona localmente en tu navegador; nada se sube nunca a ningún servidor.
Escrito y mantenido por Javi Morales·Última actualización
Cómo generar un README
Rellena el nombre del proyecto, un eslogan de una línea opcional, y una breve descripción.
Añade las insignias que quieras, elige un tipo (etiqueta/mensaje/color personalizados, licencia, versión de npm, estado de build, o estrellas/forks de GitHub), rellena sus datos, y se añade a la parte superior de tu README como una insignia real y viva de shields.io.
Pega tus instrucciones de Instalación y Uso (texto plano o Markdown, incluyendo bloques de código), elige una Licencia, y añade una nota de Contribución si quieres.
Observa cómo se actualiza la vista previa en vivo mientras escribes, y luego haz clic en Copy Markdown o Download README.md.
Por qué un constructor de README guiado
Todo proyecto real necesita un README, y la mayoría de los README comparten la misma estructura básica, un título, una breve descripción, algunas insignias, cómo instalarlo, cómo usarlo, bajo qué licencia está, cómo contribuir. Escribir esa estructura a mano cada vez (acertando con la sintaxis de la URL de la insignia, recordando el texto exacto de la licencia SPDX, ajustando los niveles de encabezado) es exactamente el tipo de tarea pequeña y repetitiva que merece la pena automatizar. Rellena un formulario, observa cómo se construye solo un README real y correctamente formateado mientras lo haces, y luego cópialo o descárgalo.
URLs de insignias reales y verificadas, no adivinadas
Las insignias son una de las partes más delicadas de escribir un README a mano: las convenciones de URL de shields.io (las reglas de escape de las insignias estáticas, la ruta correcta para una versión de npm frente a un contador de estrellas de GitHub frente a una insignia de estado de build) son fáciles de acertar mal por poco. Esta herramienta construye la URL de cada tipo de insignia siguiendo las convenciones documentadas oficialmente por shields.io, una insignia estática (/badge/etiqueta-mensaje-color), una insignia de versión de npm (/npm/v/<paquete>), una insignia de estado de build de GitHub Actions (/github/actions/workflow/status/<owner>/<repo>/<archivo-de-workflow>), e insignias de estrellas/forks de GitHub (/github/stars/<owner>/<repo>, /github/forks/<owner>/<repo>), así que la insignia simplemente funciona al pegarla en tu README real.
Una vista previa en vivo, con el mismo renderizador Markdown de este sitio
En lugar de escribir un segundo analizador de Markdown solo para el panel de vista previa, esta herramienta reutiliza exactamente el mismo motor de Markdown a HTML que hay detrás del Convertidor de Markdown a HTML, soporte de GitHub Flavored Markdown (tablas, tachado, listas de tareas, bloques de código) y el mismo paso de saneado con DOMPurify, así que el panel de vista previa es siempre igual de preciso (e igual de seguro) que ese convertidor ya establecido.
Usos habituales
Poner en marcha el README.md de un proyecto de código abierto totalmente nuevo en un par de minutos en lugar de copiar a mano una plantilla.
Añadir una fila de insignias adecuada (versión de npm, estado de build, licencia) a un proyecto existente que nunca tuvo una.
Estandarizar la estructura de los README en varios repositorios del mismo equipo.
Combinarlo con el Generador de .gitignore al poner en marcha los archivos base de un repositorio totalmente nuevo.
Construir una tabla de comparación u opciones para el propio cuerpo del README, mira el Generador de Tablas Markdown.
¿Ya tienes documentación en un documento de Word? Conviértela primero a Markdown con Word a Markdown, y luego pega las partes relevantes en los campos de Instalación/Uso/Contribución aquí.
Cómo funciona, en imágenes
Generador de README en pleno proceso: un generador de README que toma nombre del proyecto, lema y descripción, con insignias añadidas desde una lista (versión de npm, estado de compilación de GitHub Actions, estrellas y forks, o una personalizada con etiqueta, mensaje y color) y una selección de licencia.Dónde ocurre el trabajo en una página de SysFenix que no tiene ninguna entrada de archivo: la herramienta llega como JavaScript normal dentro de la página, calcula la respuesta en tu propio dispositivo y la muestra ahí mismo, de modo que la subida, la cola y el registro en servidor que necesita una herramienta online típica no ocurren nunca.
Preguntas frecuentes
¿La interfaz de esta herramienta está traducida al español?
En parte. El formulario, la vista previa y la lógica de generación de Markdown (secciones, licencias, insignias) son exactamente iguales en ambos idiomas, el nombre del proyecto, la descripción y el resto de texto que escribas puede estar en cualquier idioma. Pero el propio componente interactivo (etiquetas de los campos como "Project name", botones como "Copy Markdown"/"Download README.md", los mensajes de estado) es un único componente compartido escrito en inglés y se muestra igual en ambas versiones del sitio, sin traducir, la misma limitación ya documentada en otras herramientas interactivas de este sitio como la Tabla Periódica o el Editor de JSON.
¿Los encabezados del README generado (## Installation,
No, y esto es una decisión deliberada, no un descuido: los encabezados de sección del README ("Installation", "Usage", "License", "Contributing") se generan siempre en inglés, tanto en esta página como en la versión en inglés de la herramienta, es la convención real que sigue la inmensa mayoría de los README de código abierto del mundo real, incluso en proyectos cuyo autor y documentación están en otro idioma, porque el inglés es el idioma de trabajo que esperan la mayoría de herramientas y colaboradores multi-proyecto. Lo que SÍ puedes escribir enteramente en español, en ambas versiones de la página por igual, es todo el contenido bajo esos encabezados: el nombre del proyecto, la descripción, el eslogan, y el propio texto libre de instalación/uso/contribución.
¿Esta herramienta envía los datos de mi proyecto a un servidor?
No. Todo lo que escribes, y el Markdown/HTML que genera, permanece en tu pestaña del navegador, no hay subida, no hay cuenta, y no hay procesamiento en un servidor. La única excepción son las propias imágenes de vista previa de las insignias, mira la siguiente pregunta.
¿Las vistas previas de las insignias hacen una petición de red?
Sí, y merece la pena decirlo claramente. Una insignia (versión de npm, estrellas de GitHub, estado de build, etc.) es una IMAGEN generada en vivo por shields.io, así que mostrarte una vista previa de la insignia hace que tu navegador descargue esa imagen directamente desde img.shields.io, exactamente lo mismo que ocurre cada vez que alguien ve un README con una insignia de shields.io, en GitHub o en cualquier otro sitio. Solo los propios parámetros de la insignia (un nombre de paquete, un owner/repo de GitHub, una etiqueta/mensaje personalizados) son visibles en esa única petición de imagen, el nombre de tu proyecto, la descripción, y el texto de instalación/uso/contribución nunca se envían a ningún sitio.
¿De dónde vienen realmente las imágenes de las insignias?
De shields.io (img.shields.io), un servicio de insignias gratuito y muy usado en el que ya confía la mayoría de proyectos de código abierto. Esta herramienta construye la URL correcta de shields.io para el tipo de insignia que elijas, una insignia estática de etiqueta/mensaje/color, una insignia de versión de npm, una insignia de estado de build de GitHub Actions, o insignias de estrellas/forks de GitHub, y la coloca directamente en el Markdown generado como una imagen `` real, así que la insignia se mantiene viva y actualizada donde sea que pegues el README (no es una instantánea estática).
¿Qué opciones de licencia hay disponibles, y son identificadores de licencia reales?
MIT, Apache License 2.0, GNU GPL v3.0 y BSD 3-Clause, cada una usa su identificador SPDX real y estándar (spdx.org/licenses), los mismos identificadores que reconoce y muestra el propio GitHub. Elegir una añade una breve sección "## License" que hace referencia a un archivo `LICENSE` (que esta herramienta no genera por ti, mira la siguiente pregunta) más, opcionalmente, una insignia de licencia a juego. Elegir "None" omite la sección de licencia por completo en lugar de inventar una.
¿Esto genera un archivo LICENSE real?
No, solo la *sección* de licencia del README, que hace referencia a un archivo `LICENSE` por su nombre. Igualmente tendrás que añadir el texto real de la licencia como un archivo `LICENSE` independiente en tu repositorio (el propio "Add file" → "Create new file" de GitHub, al escribir `LICENSE`, te ofrece insertar el texto completo de cualquiera de estas licencias con un solo clic).
¿Por qué las secciones de Instalación/Uso/Contribución solo aparecen si las relleno?
Un encabezado "## Contributing" vacío sin nada debajo se ve roto e incompleto. Cada una de esas secciones (y la línea de insignias, y el eslogan) solo aparece en el Markdown generado una vez que has escrito algo en ella, deja un campo en blanco y toda su sección se omite, no se muestra vacía.
Convierte un documento Word .docx a Markdown limpio en tu navegador, títulos, listas, tablas y enlaces conservados. Tu archivo nunca sale de tu dispositivo.
