Halloween sale. Pro for $12 instead of $18 with code TRICKORTF at checkout, until October 31.
Grátis · Modelo de README incluído

Editor de README online grátis

Comece com um modelo de README com as seções que as pessoas procuram e veja tudo formatado enquanto escreve: blocos de código, tabelas e listas de tarefas. Baixe como README.md quando estiver pronto.

README.md
FileEditViewInsertFormatHelp
README.md

Nome do projeto

Uma frase sobre o que este projeto faz e para quem ele é.

Funcionalidades

  • O que ele faz de melhor, em uma linha
  • O segundo motivo pelo qual as pessoas usam
  • O que o torna diferente

Instalação

npm install your-package

Uso

import { start } from "your-package";

start({ verbose: true });

Configuração

Opção Padrão O que faz
verbose false Registra cada etapa
timeout 3000 Milissegundos antes de desistir

Como contribuir

Pull requests são bem-vindos. Para uma mudança grande, abra uma issue antes para a gente conversar.

Licença

MIT

Carregando o editor…Your files stay in your browser
  • Seus arquivos nunca saem do seu navegador
  • Grátis, sem cadastro
  • Baixe em Markdown, Word, página da web ou PDF
Como funciona

Escreva um README em três passos

  1. 01

    Comece pelo modelo

    A página abre com um README.md com as seções de sempre: o que é, funcionalidades, instalação, uso, configuração, como contribuir e licença.

  2. 02

    Preencha, já formatado

    Substitua os textos de exemplo. Blocos de código ganham cores de sintaxe, tabelas ganham alças e tudo se formata enquanto você digita.

  3. 03

    Baixe o README.md

    Arquivo > Baixar > Markdown (.md) salva o arquivo, pronto para o commit. Ou use Arquivo > Copiar > Como Markdown e cole no editor web do seu repositório.

A README.md in the editor with badges, an install command and an options table, downloaded ready to commit
Grátis para Mac e Chrome

Gostou deste editor? Baixe o TypeFire.

O mesmo editor para toda a sua pasta de notas em Markdown, com um expansor de texto e um gerenciador de área de transferência. No Mac, qualquer arquivo .md aparece em pré-visualização no Finder quando você aperta Espaço.

Baixar grátis para Mac Adicionar ao Chrome, grátis

Um expansor de texto grátis, notas em Markdown e um gerenciador de área de transferência, para Mac e Chrome.

A README.md previewed in Finder with Quick Look on a Mac, after pressing Space
O que ele faz

Tudo o que um README precisa

Os recursos de Markdown em que os READMEs se apoiam, formatados enquanto você escreve.

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

  1. Código delimitado com cores de sintaxe

    Comandos de instalação e exemplos de uso parecem código, na linguagem que você marcar no bloco, com um botão de copiar em cada um.

  2. Tabelas para opções e flags

    Tabelas de configuração são a parte do README que mais dá errado. Aqui você adiciona linhas e colunas com um clique.

  3. Listas de tarefas para o roadmap

    - [ ] e - [x] viram caixas de seleção, do jeito que roadmaps e checklists aparecem nas páginas de repositório.

  4. Badges e imagens

    Badges e imagens de outros sites aparecem depois de um clique em Carregar imagens, então nada é carregado de fora até você permitir.

  5. Salvo enquanto você trabalha

    Seu rascunho fica salvo neste navegador enquanto você digita, para você voltar a ele antes do commit.

Vá além

O mesmo editor, sem a aba do navegador

Este editor vem do TypeFire, um app gratuito de notas em Markdown, expansor de texto e gerenciador de área de transferência. Aqui ele trabalha com os arquivos que você abre. No app, ele abre a sua pasta inteira.

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

TypeFire para Mac

  • Aperte Espaço em qualquer arquivo .md no Finder e leia formatado, com o Quick Look.
  • Abra uma pasta de Markdown, inclusive um cofre do Obsidian, com abas, busca e links.
  • Um expansor de texto e um histórico da área de transferência no mesmo app gratuito.
Baixar grátis para MacConhecer o app para Mac
In a browser email, typing thx and a space expands into a whole thank-you reply

TypeFire para Chrome

  • Este editor na própria aba, a um clique da barra de ferramentas.
  • Sua pasta de notas .md em abas, com busca e links.
  • Um expansor de texto e o histórico da área de transferência em qualquer site.
Adicionar ao Chrome, grátisConhecer o TypeFire para Chrome

Perguntas frequentes

Still not answered?

Email usSetup guidePricing

Comece com uma frase sobre o que o projeto faz e para quem ele é.

Depois funcionalidades, instalação, um exemplo curto de uso, configuração, como contribuir e a licença. O modelo desta página já traz tudo isso como títulos para preencher.

Cole seu README.md aqui ou solte o arquivo na página.

Ele se formata enquanto você edita, então dá para corrigir títulos, tabelas e blocos de código antes do commit.

Ele mostra o que os READMEs mais usam: blocos de código delimitados com cores de sintaxe, tabelas, listas de tarefas, tachado e links automáticos.

Um badge é um link de imagem: [![texto alternativo](url-da-imagem)](url-do-link).

Imagens de outros sites, como os badges do shields.io, aparecem depois que você clica em Carregar imagens no documento.

O modelo já se chama README.md, então Arquivo > Baixar > Markdown (.md) salva com esse nome.

Você pode renomear qualquer documento clicando no nome dele no topo. Ou use Arquivo > Copiar > Como Markdown e cole no editor web do seu repositório.

Sim, sem conta e sem cadastro. Seu rascunho nunca é enviado.

Digite a linha de cabeçalho com barras verticais, uma linha de hifens embaixo e depois suas linhas.

Ou use Inserir > Tabela e digite nas células.

Sim. Use Inserir > Imagem de um endereço da web, ou escreva ![texto alternativo](https://...) para uma imagem hospedada online.

Sim. Ele fica salvo neste navegador enquanto você digita.

Arquivo > Baixar > Markdown entrega o arquivo README.md para o commit.

Mais ferramentas grátis de escrita e 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 trechos de código

Digite poucas letras e receba o código repetitivo

Editor de Markdown para Mac

Edite arquivos .md nos seus repositórios

Guia de Markdown do GitHub

Alertas, listas de tarefas, notas de rodapé

Pare de redigitar o mesmo código repetitivo

O expansor de texto do TypeFire transforma poucas letras no cabeçalho da licença, nos passos de instalação ou no modelo de PR, em qualquer app. Grátis no Mac.

Baixar grátis para Mac Adicionar ao Chrome, grátis

Um expansor de texto grátis, notas em Markdown e um gerenciador de área de transferência, para Mac e Chrome.