Converter Markdown em PNG: exemplo de README
Transforme um excerto de README num PNG legível, preserve o formato do código e verifique o resultado antes de o partilhar.
Um README é útil como documento e um excerto pode apresentar um projeto numa publicação de lançamento. Para um repositório público real, abra GitHub README para imagem, introduza o URL do GitHub e carregue o README antes de o rever ou editar para exportação. Para reproduzir diretamente o exemplo fictício, use o conversor de Markdown. Escolha um excerto que se compreenda sozinho.
Um bom cartão responde a três perguntas: o que é, como começar e onde continuar a ler? O exemplo usa um projeto fictício de notas chamado Atlas Notes. O título, a descrição de uma frase, os comandos iniciais e uma lista curta de funcionalidades estabelecem uma ordem de leitura clara.
Os comandos são conteúdo de demonstração de um README, não instruções para instalar este sítio nem um pacote real. Num repositório real, confirme que correspondem às instruções de configuração atuais antes de criar o cartão.
Copie para o conversor o conteúdo dentro da delimitação Markdown exterior. A delimitação Bash interior pertence ao README e deve permanecer na fonte para os comandos aparecerem como um bloco de código.
# Atlas Notes
A small Markdown notebook for release teams.
## Quick start
```bash
npm install
npm run dev
```
- Local Markdown files
- Reviewed release notes
- Portable documentation
O resultado é uma apresentação compacta do projeto. Verifique a hierarquia dos títulos e a distinção entre texto, código e lista de funcionalidades. Coloque junto da imagem uma ligação textual para o README completo: um PNG não disponibiliza comandos selecionáveis nem navegação equivalente.
Escolha PNG para este exemplo de texto e código. Procure uma largura que mantenha as duas linhas de comandos intactas sem tornar o corpo demasiado pequeno no local de publicação. Verifique primeiro a linha mais longa: aumentar a largura pode evitar quebras, mas a imagem continuará a ser reduzida num feed estreito.
Se o README completo tiver emblemas, várias capturas de ecrã e um guia de instalação longo, crie imagens separadas para tarefas diferentes. A apresentação do projeto e a referência de resolução de problemas raramente precisam do mesmo recorte ou da mesma quantidade de texto.
- Confirme que todas as delimitações de código abrem e fecham. Uma delimitação em falta pode fazer o texto seguinte aparecer como código.
- Verifique se o resultado inclui controlos do navegador ou elementos do repositório que não pertencem ao conteúdo escolhido.
- Descarregue o PNG e inspecione-o no tamanho de apresentação previsto, sobretudo os comandos e a pontuação.
- Escreva uma descrição que identifique o projeto e o conteúdo útil, e acrescente à publicação a ligação para o README original.
Quando o README mudar, gere novamente a imagem a partir da fonte editada para manter a coerência com a documentação. Importe um README público do GitHub, reveja-o e exporte.
Guias relacionados: formatar blocos de código Markdown e planear imagens para vários canais.