Gerador de blocos de código Markdown
Coloque código em um bloco de código Markdown com a linguagem certa para destaque de sintaxe, escolha o delimitador e, se quiser, transforme em seção recolhível.
Carregando Gerador de blocos de código Markdown…
Seus arquivos nunca saem do seu dispositivo
Como usar Gerador de blocos de código Markdown
- 1
Abra Gerador de blocos de código Markdown nesta página. Ele carrega direto no seu navegador.
- 2
Adicione seu arquivo, texto ou valores e ajuste as configurações.
- 3
Copie ou baixe o resultado. Nada é enviado nem armazenado.
Sobre esta ferramenta
Compartilhar código num README, issue do GitHub, Discord ou Stack Overflow funciona melhor em um bloco de código delimitado com a linguagem definida: ele mantém a formatação e ganha destaque de sintaxe. Este gerador de blocos de código Markdown envolve o seu código corretamente, mesmo quando o próprio código tem crases, e pode guardar trechos longos em uma seção recolhível.
Como criar um bloco de código
- Cole o seu código.
- Escolha a linguagem, como JavaScript, Python, Bash, JSON ou SQL.
- Escolha o delimitador: três crases, ou tis quando o código tiver crases.
- Se quiser, ative uma seção recolhível e escreva o texto do resumo.
- Confira a prévia e copie o Markdown.
O que ele gera
```python
print("Hello")
```
O nome da linguagem depois do delimitador de abertura diz ao GitHub, GitLab, Discord e às ferramentas de documentação como colorir o código.
Código recolhível
Logs longos e arquivos de configuração podem esconder o resto de uma issue. A opção recolhível envolve o bloco em um elemento details com o seu resumo como título clicável, como "Log de erro completo", para os leitores abrirem quando precisarem.
Dicas
- Sempre defina a linguagem; isso deixa o código muito mais fácil de ler.
- Use diff como linguagem para mostrar linhas adicionadas e removidas com + e -.
- Corte saídas longas para a parte relevante antes de compartilhar.
- Remova segredos como chaves de API e senhas do código antes de publicar.
Para mais Markdown, veja o guia rápido de Markdown, ou escreva um documento inteiro no editor de Markdown.
Perguntas frequentes
Como adicionar um bloco de código em Markdown?
Coloque três crases na linha antes e depois do código e escreva o nome da linguagem logo após as três primeiras, por exemplo ```javascript.
Como mostrar código que contém crases?
Use um delimitador mais longo ou tis (~~~) em volta do bloco, o que o gerador pode fazer por você, para que as crases internas não fechem o bloco.
Quais linguagens têm destaque?
O destaque é feito pelo site que exibe o seu Markdown. GitHub, GitLab e a maioria das ferramentas aceitam linguagens comuns como JavaScript, Python, Bash, JSON e SQL.
Como fazer um bloco de código recolhível?
Ative a opção recolhível e escreva um resumo. O bloco é envolvido em um elemento details que os leitores podem expandir.
Como mostrar um diff?
Use diff como linguagem e comece as linhas alteradas com + ou -. No GitHub elas aparecem em verde e vermelho.
Funciona no Discord e no Slack?
O Discord aceita blocos de código delimitados com linguagem. O Slack aceita blocos de código, mas sem destaque por linguagem.