Gerador de README
Escolha as seções que seu README precisa em uma biblioteca de 17, reordene, preencha cada uma, e veja uma pré-visualização estilo GitHub atualizar ao vivo — depois copie ou baixe o README.md finalizado.
Executa totalmente no seu navegador — seus arquivos nunca saem do dispositivo.
Tudo aqui — as seções escolhidas e seu conteúdo — permanece neste navegador (localStorage) e nunca é enviado a lugar nenhum. As imagens dos selos são buscadas no shields.io pelo seu navegador quando a pré-visualização as renderiza.
Como funciona
- 01Comece com o conjunto padrão de seções (Título, Selos, Instalação, Uso, Recursos, Contribuição, Licença, Agradecimentos) ou adicione mais a partir da biblioteca Disponível — Stack Técnica, Screenshots, Referência de API, Variáveis de Ambiente, FAQ e outras.
- 02Clique em uma seção em Selecionadas para editá-la na coluna do meio; use os botões de seta para reordenar ou o × para remover.
- 03Preencha os campos de formulário de cada seção, ou edite o Markdown diretamente para seções de texto livre como Stack Técnica ou Roadmap.
- 04Abra a seção Selos para montar selos do shields.io — um selo de licença (sincronizado com o que você escolheu em Licença), versão npm, status de build e PRs bem-vindos.
- 05Confira a pré-visualização à direita (ou mude para Sem formatação para ver o Markdown bruto), depois copie ou baixe o README.md finalizado.
Perguntas frequentes
O que acontece se eu deixar uma seção em branco?
Ela é totalmente omitida do README gerado — você não terá um título vazio "## Uso" sem nada embaixo. Seções de texto livre (Stack Técnica, Roadmap, FAQ, …) funcionam da mesma forma: limpe o campo de texto e a seção desaparece do resultado.
Isso gera um arquivo LICENSE de verdade?
Não, apenas a seção de Licença do README com uma breve declaração e um link para o texto da licença. Adicione o arquivo LICENSE correspondente ao seu repositório separadamente (o GitHub também pode adicionar um para você a partir das mesmas opções: MIT, Apache 2.0, GPL v3, BSD 3-Clause, MPL 2.0, Unlicense).
Como funciona a seção Selos?
É um pequeno construtor de selos do shields.io: um selo de licença (que segue o que você escolheu na seção Licença por padrão, ou pode ser definido de forma independente), um selo de versão npm (digite o nome do seu pacote), selos de build-passing e PRs-welcome, e um selo opcional "Feito com MarkdownLab" — tudo montado como links de imagem em Markdown simples, livres para você editar depois.
Alguma coisa disso é enviada a um servidor?
Não. Cada seção é montada em Markdown totalmente no JavaScript do seu navegador. Suas escolhas de seção e conteúdo são salvas apenas no armazenamento local deste navegador (para que uma atualização de página não perca seu trabalho) — nada é enviado a lugar nenhum. As imagens de selo são a única exceção: o shields.io as busca diretamente quando a pré-visualização as renderiza.
Posso continuar editando o resultado depois de gerá-lo?
Sim — copie ou baixe, depois abra no Editor de Markdown (ou qualquer editor de texto) para continuar refinando. Este gerador dá um ponto de partida estruturado e sólido, não um modelo travado.