Halloween sale. Pro for $12 instead of $18 with code TRICKORTF at checkout, until October 31.
Gratis · Plantilla de README incluida

Editor de README online gratis

Empieza con una plantilla de README con las secciones que la gente busca y mírala con formato mientras escribes: bloques de código, tablas y listas de tareas. Descárgala como README.md cuando esté lista.

README.md
FileEditViewInsertFormatHelp
README.md

Nombre del proyecto

Una frase sobre qué hace este proyecto y para quién es.

Funciones

  • Lo que mejor hace, en una línea
  • La segunda razón por la que la gente lo usa
  • Lo que lo hace diferente

Instalación

npm install your-package

Uso

import { start } from "your-package";

start({ verbose: true });

Configuración

Opción Valor por defecto Qué hace
verbose false Registra cada paso
timeout 3000 Milisegundos antes de rendirse

Contribuir

Las pull requests son bienvenidas. Para un cambio grande, abre antes una issue para que lo hablemos.

Licencia

MIT

Cargando el editor…Your files stay in your browser
  • Tus archivos nunca salen de tu navegador
  • Gratis, sin registro
  • Descarga en Markdown, Word, página web o PDF
Cómo funciona

Escribe un README en tres pasos

  1. 01

    Empieza con la plantilla

    La página se abre con un README.md con las secciones habituales: qué es, funciones, instalación, uso, configuración, cómo contribuir y licencia.

  2. 02

    Rellénalo, con formato

    Sustituye los textos de ejemplo. Los bloques de código tienen colores de sintaxis, las tablas tienen asas y todo toma formato mientras escribes.

  3. 03

    Descarga el README.md

    Archivo > Descargar > Markdown (.md) lo guarda, listo para el commit. O usa Archivo > Copiar > Como Markdown y pégalo en el editor web de tu repositorio.

A README.md in the editor with badges, an install command and an options table, downloaded ready to commit
Gratis para Mac y Chrome

¿Te gusta este editor? Consigue TypeFire.

El mismo editor para toda tu carpeta de notas en Markdown, con un expansor de texto y un gestor de portapapeles. En Mac, cualquier archivo .md se previsualiza en el Finder al presionar Espacio.

Descargar gratis para Mac Agregar a Chrome, gratis

Un expansor de texto gratis, notas en Markdown y un gestor de portapapeles, para Mac y Chrome.

A README.md previewed in Finder with Quick Look on a Mac, after pressing Space
Qué hace

Todo lo que necesita un README

Las partes de Markdown en las que se apoyan los README, con formato mientras escribes.

Download the README as Markdown, a web page or a PDF from the File menu

  1. Código delimitado con colores de sintaxis

    Los comandos de instalación y los ejemplos de uso se leen como código, en el lenguaje con el que marques el bloque, con un botón de copiar en cada uno.

  2. Tablas para opciones y flags

    Las tablas de configuración son la parte de un README que más se tuerce. Aquí añades filas y columnas con un clic.

  3. Listas de tareas para la hoja de ruta

    - [ ] y - [x] se muestran como casillas, igual que las hojas de ruta y las listas de verificación en las páginas de repositorios.

  4. Insignias e imágenes

    Las insignias e imágenes de otros sitios aparecen tras un clic en Cargar imágenes, así que nada se carga desde fuera hasta que tú lo digas.

  5. Se guarda mientras trabajas

    Tu borrador se guarda en este navegador mientras escribes, para que puedas volver a él antes del commit.

Ve más allá

El mismo editor, sin la pestaña del navegador

Este editor viene de TypeFire, una app gratuita de notas en Markdown, expansor de texto y gestor de portapapeles. Aquí trabaja con los archivos que abres. En la app, abre toda tu carpeta.

TypeFire for Mac with several Markdown notes open in one tab bar

TypeFire para Mac

  • Presiona Espacio sobre cualquier archivo .md en el Finder y léelo con formato, con Quick Look.
  • Abre una carpeta de Markdown, incluida una bóveda de Obsidian, con pestañas, búsqueda y enlaces.
  • Un expansor de texto y un historial del portapapeles en la misma app gratuita.
Descargar gratis para MacVer la app para Mac
In a browser email, typing thx and a space expands into a whole thank-you reply

TypeFire para Chrome

  • Este editor en su propia pestaña, a un clic de la barra de herramientas.
  • Tu carpeta de notas .md en pestañas, con búsqueda y enlaces.
  • Un expansor de texto y tu historial del portapapeles en todos los sitios.
Agregar a Chrome, gratisVer TypeFire para Chrome

Preguntas frecuentes

Still not answered?

Email usSetup guidePricing

Empieza con una frase sobre qué hace el proyecto y para quién es.

Luego funciones, instalación, un ejemplo de uso corto, configuración, cómo contribuir y la licencia. La plantilla de esta página tiene todo eso como títulos para rellenar.

Pega tu README.md aquí o suelta el archivo en la página.

Toma formato mientras lo editas, así que puedes arreglar títulos, tablas y bloques de código antes del commit.

Muestra lo que más usan los README: bloques de código delimitados con colores de sintaxis, tablas, listas de tareas, tachado y enlaces automáticos.

Una insignia es un enlace de imagen: [![texto alternativo](url-imagen)](url-enlace).

Las imágenes de otros sitios, como las insignias de shields.io, aparecen después de hacer clic en Cargar imágenes en el documento.

La plantilla ya se llama README.md, así que Archivo > Descargar > Markdown (.md) la guarda con ese nombre.

Puedes renombrar cualquier documento haciendo clic en su nombre, arriba. O usa Archivo > Copiar > Como Markdown y pégalo en el editor web de tu repositorio.

Sí, sin cuenta y sin registro. Tu borrador nunca se sube.

Escribe la fila de encabezado con barras verticales, debajo una fila de guiones y luego tus filas.

O usa Insertar > Tabla y escribe en las celdas.

Sí. Usa Insertar > Imagen desde una dirección web, o escribe ![texto alternativo](https://...) para una imagen alojada online.

Sí. Se guarda en este navegador mientras escribes.

Archivo > Descargar > Markdown te da el archivo README.md para el commit.

Más herramientas gratis de escritura y Markdown

markdown-viewermarkdown-editor-onlinemarkdown-live-previewopen-md-filemarkdown-cheat-sheetmarkdown-to-pdfmarkdown-to-htmlmarkdown-viewer-windowsmarkdown-table-generatormarkdown-viewer-chromemarkdown-viewer-linuxmarkdown-notepadmarkdown-to-wordmarkdown-converteronline-notepadonline-text-editordistraction-free-writingchatgpt-markdown-to-textword-to-markdowngoogle-docs-to-markdownExpansor de fragmentos de código

Escribe unas letras y obtén el código repetitivo

Editor de Markdown para Mac

Edita los .md de tus repositorios

Guía de Markdown en GitHub

Alertas, listas de tareas, notas al pie

Deja de reescribir el mismo código repetitivo

El expansor de texto de TypeFire convierte unas pocas letras en tu cabecera de licencia, tus pasos de instalación o tu plantilla de PR, en cualquier app. Gratis en Mac.

Descargar gratis para Mac Agregar a Chrome, gratis

Un expansor de texto gratis, notas en Markdown y un gestor de portapapeles, para Mac y Chrome.