📘Dev

Gerador de README.md

Monte um README.md profissional preenchendo nome, descrição, badges, instalação, uso, licença. Pré-visualização Markdown ao lado.

Nome do projeto Descrição

Badges

license npm build

Gerenciador de pacotes

npm pnpm yarn

Uso (opcional) Licença

README.md

Crie um README profissional

O README é o cartão de visita de um projeto no GitHub, mas encarar o arquivo em branco trava muita gente. Este gerador conduz a montagem de um README.md completo, deixando para você apenas preencher as seções que importam.

Ele arruma os blocos essenciais (nome, descrição, badges, instruções de instalação, exemplos de uso e licença) e mostra ao lado uma pré-visualização do Markdown já renderizado, então você acompanha o resultado enquanto escreve. Em vez de ficar tentando lembrar a sintaxe de cada parte, dá para focar no conteúdo.

A geração acontece no navegador, pronta para você copiar direto na raiz do projeto. Um README caprichado pesa muito na primeira impressão de quem chega no repositório.

Perguntas frequentes

Quais seções entram no README gerado?

O arquivo sai com o título (nome do projeto), os badges que você marcar (license, npm e build), a descrição, uma seção de Instalação com o comando do gerenciador escolhido (npm install, pnpm add ou yarn add), uma seção de Uso com seu código de exemplo num bloco js — ela só aparece se o campo tiver conteúdo — e a Licença, escolhida entre MIT, Apache-2.0, GPL-3.0, BSD-3-Clause e Unlicense. Se o nome ficar vazio, entra o padrão meu-projeto; a descrição vazia é simplesmente omitida.

Os badges gerados funcionam de verdade?

Depende do badge. O de license e o de build são imagens estáticas do shields.io: o de build mostra sempre passing e é decorativo até você trocar pela URL do seu CI de verdade. Já o badge de npm consulta a versão publicada do pacote com o nome que você digitou, então funciona de fato, desde que o pacote exista no registro npm. A ferramenta não valida nenhum deles, só monta o Markdown com as URLs — e, como as imagens vêm do shields.io, os badges precisam de internet para aparecer.

O painel mostra o Markdown renderizado ou o código-fonte?

O código-fonte cru, exatamente o texto que vai dentro do README.md, atualizado a cada tecla digitada. Não há visualização renderizada — para conferir como o GitHub vai exibir, cole o resultado num editor com preview ou no próprio repositório. O botão Copiar joga o conteúdo inteiro na área de transferência de uma vez, sem aviso de confirmação; depois é só criar o arquivo README.md na raiz do projeto e colar. Os cabeçalhos das seções saem em português.

Ferramentas Relacionadas

📑

Gerador de TOC Markdown

Gere o sumário (table of contents) de um arquivo Markdown a partir das headings (#, ##, ###). Inclui anchors no estilo GitHub. Tudo no navegador.

📝

Markdown Cheatsheet

Consulta rápida de sintaxe Markdown, com filtro por palavra: títulos, listas, links, tabelas, código e mais. Mostra a sintaxe crua ao lado do que ela significa.

📋

Gerador de Tabela Markdown

Crie tabelas Markdown visualmente — adicione linhas e colunas, edite células e copie a sintaxe GFM pronta para README, Notion ou GitHub. Sem formatação manual.

⚙️

Gerador de GitHub Actions

Gere workflows YAML para GitHub Actions: CI Node, deploy estático, release semver, lint+test. Customize triggers e steps. Tudo no navegador.

🌳

Gerador de Árvore ASCII

Cole uma estrutura indentada (espaços/tabs) e gere uma árvore ASCII pronta para README — ├──, └── etc. Tudo no navegador.

📖

Gerador Storybook main.js

Gere o .storybook/main.js para Storybook 7+ com React e Vite, pronto para usar. Copie a configuração e comece a documentar seus componentes em minutos.