Este editor de README te permite escribir archivos README.md con vista previa al estilo GitHub en tiempo real, índice con enlaces, listas de tareas, tablas y bloques de código. Parte del README de ejemplo, usa la barra de herramientas o los atajos para dar formato y descarga el .md o una página HTML independiente. El borrador se guarda en el navegador mientras escribes.
Cómo se usa
- Escribe Markdown en el editor, o suelta, abre o pega un archivo .md. Se carga un README de ejemplo para empezar.
- Usa la barra o los atajos para negrita, cursiva, títulos, enlaces, listas, tareas, código, citas y tablas.
- Pasa a Vista previa para ver el resultado al estilo GitHub con un índice clicable, o a HTML para obtener el código generado.
- Copia el HTML, descarga una página .html independiente con estilos o descarga el archivo .md.
- Admite GitHub Flavored Markdown: tablas, listas de tareas, bloques de código, tachado y enlaces automáticos. Los títulos reciben anclas al estilo GitHub.
- El HTML se sanea: se eliminan scripts y atributos peligrosos.
- Tu borrador se guarda automáticamente en este navegador y sigue ahí cuando vuelvas.
- En pantallas anchas, Dividir muestra el editor y la vista previa lado a lado.
Qué debe tener un buen README
El README es lo primero que se ve en un repositorio, así que debe responder rápido a tres preguntas: qué hace el proyecto, cómo se instala y cómo se usa. Un orden habitual es una descripción de una línea, un ejemplo breve o una captura, los pasos de instalación, el uso con un bloque de código, la configuración, cómo contribuir y la licencia. Deja la jerga fuera del primer párrafo; los detalles van más abajo.
Los bloques de código con nombre de lenguaje (```js, ```bash) se resaltan en GitHub. Los enlaces relativos como docs/setup.md funcionan dentro del repositorio y las imágenes pueden apuntar a archivos del mismo.
GitHub Flavored Markdown
La vista previa sigue GitHub Flavored Markdown (GFM), una ampliación del estándar CommonMark. Además de títulos, listas, enlaces y énfasis, añade tablas con barras verticales, listas de tareas con - [ ] y - [x], ~~tachado~~, enlaces automáticos para URL sueltas y bloques de código delimitados. Cada título recibe un ancla al estilo GitHub, así un enlace como #instalacion salta a esa sección; es lo que usa el índice.
Preguntas frecuentes
¿Cómo añado un índice a un README?
Añade una lista de enlaces a las anclas de los títulos, por ejemplo - [Uso](#uso); GitHub los resuelve igual que la vista previa. El índice de la vista previa muestra cada título y su ancla.
¿Cómo hago una lista de tareas?
Empieza la línea con - [ ] para una tarea pendiente o - [x] para una hecha. En GitHub, las listas de tareas de issues y pull requests se pueden marcar directamente.
¿Admite tablas y bloques de código de GitHub?
Sí. Las tablas usan | para separar columnas y una línea de guiones bajo la cabecera; los bloques de código empiezan y terminan con tres comillas invertidas.
¿Se guarda mi borrador?
Sí, automáticamente en este navegador, y sigue ahí cuando vuelves. No se sube nada.
¿Puedo obtener el HTML?
Sí. Cambia a la vista HTML para copiar el código generado y saneado, o descarga una página .html independiente con estilos.