Este editor de README permite escrever arquivos README.md com prévia ao vivo no estilo do GitHub, sumário clicável, listas de tarefas, tabelas e blocos de código. Comece pelo README de exemplo, use a barra de ferramentas ou os atalhos para formatar e baixe o .md ou uma página HTML independente. O rascunho é salvo no navegador enquanto você digita.
Como usar
- Escreva Markdown no editor, ou solte, abra ou cole um arquivo .md. Um README de exemplo é carregado para começar.
- Use a barra ou os atalhos para negrito, itálico, títulos, links, listas, tarefas, código, citações e tabelas.
- Vá para Prévia para ver o resultado no estilo GitHub com sumário clicável, ou para HTML para obter o código gerado.
- Copie o HTML, baixe uma página .html independente com estilos ou baixe o arquivo .md.
- Suporta GitHub Flavored Markdown: tabelas, listas de tarefas, blocos de código, tachado e links automáticos. Os títulos recebem âncoras no estilo GitHub.
- O HTML é higienizado: scripts e atributos inseguros são removidos.
- Seu rascunho é salvo automaticamente neste navegador e continua lá quando você voltar.
- Em telas largas, Dividir mostra o editor e a prévia lado a lado.
O que um bom README tem
O README é a primeira coisa que as pessoas veem num repositório, então ele deve responder rápido a três perguntas: o que o projeto faz, como instalar e como usar. Uma ordem comum é descrição de uma linha, um exemplo curto ou captura de tela, passos de instalação, uso com bloco de código, configuração, como contribuir e licença. Deixe o jargão fora do primeiro parágrafo; os detalhes vêm depois.
Blocos de código com o nome da linguagem (```js, ```bash) ganham destaque de sintaxe no GitHub. Links relativos como docs/setup.md funcionam dentro do repositório, e imagens podem apontar para arquivos dele.
GitHub Flavored Markdown
A prévia segue o GitHub Flavored Markdown (GFM), uma extensão do padrão CommonMark. Além de títulos, listas, links e ênfase, ele traz tabelas com barras verticais, listas de tarefas com - [ ] e - [x], ~~tachado~~, links automáticos para URLs soltas e blocos de código cercados. Cada título ganha uma âncora no estilo do GitHub, então um link como #instalacao pula para essa seção; é isso que o sumário usa.
Perguntas frequentes
Como adicionar um sumário ao README?
Adicione uma lista de links para as âncoras dos títulos, por exemplo - [Uso](#uso); o GitHub resolve igual à prévia. O sumário clicável da prévia mostra cada título e sua âncora.
Como fazer uma lista de tarefas?
Comece a linha com - [ ] para uma tarefa aberta ou - [x] para uma concluída. No GitHub, listas de tarefas em issues e pull requests podem ser marcadas direto.
Tabelas e blocos de código do GitHub funcionam?
Sim. Tabelas usam | para separar colunas e uma linha de traços abaixo do cabeçalho; blocos de código começam e terminam com três crases.
Meu rascunho fica salvo?
Sim, automaticamente neste navegador, e continua lá quando você volta. Nada é enviado.
Posso pegar o HTML?
Sim. Mude para a visão HTML para copiar o código gerado e higienizado, ou baixe uma página .html independente com estilo.