Guia rápida Markdown

Referência rápida para sintaxe e formatação Markdown

Experimentar Markdown

Guia rápida

O que é uma guia rápida Markdown?

Markdown é um formato de texto simples para documentos estruturados. Uma guia rápida é uma referência rápida para sintaxe: títulos, listas, ligações, tabelas, blocos de código e mais. A especificação CommonMark e o GitHub Flavored Markdown (GFM) definem a sintaxe usada em READMEs, documentação e wikis.

Esta ferramenta mostra uma guia rápida pronta a copiar no painel da direita. Utilize o editor da esquerda para experimentar a sintaxe e ver como renderiza. Copie ou transfira a guia rápida para uso offline. Para gerar tabelas a partir de CSV, utilize o Gerador de tabelas Markdown.

Como utilizar esta ferramenta

1

Rever a guia rápida

O painel da direita mostra títulos, ênfase, listas, ligações, imagens, citações, código, tabelas, listas de tarefas e regras horizontais. Cada exemplo usa sintaxe CommonMark e GFM padrão.

2

Experimentar Markdown no editor

Cole ou escreva Markdown no editor da esquerda. Utilize <strong>Amostra</strong> para carregar conteúdo de exemplo. Experimente com negrito, itálico, listas e tabelas. Para formatar Markdown existente, utilize o Formatador Markdown.

3

Copiar ou transferir

Copie a guia rápida para a área de transferência ou transfira-a como ficheiro <code>.md</code>. Para converter Markdown para HTML, utilize Markdown para HTML. Para um TOC a partir de títulos, utilize o Gerador TOC Markdown.

Onde uma guia rápida ajuda

Novos utilizadores de Markdown precisam de uma referência rápida. O Markdown Guide e a documentação do GitHub oferecem tutoriais; uma guia rápida complementa-os com exemplos copy-paste. Tabelas, listas de tarefas e blocos de código cercados são comuns em READMEs e documentação.

Para lint de Markdown quanto a problemas de estilo, utilize o Linter Markdown. Para validar sintaxe, utilize o Validador Markdown. Para converter HTML para Markdown, utilize HTML para Markdown.

Perguntas frequentes

CommonMark vs GFM?

CommonMark é a especificação base. O GFM adiciona tabelas, listas de tarefas, riscado e autolinks. A maioria das plataformas (GitHub, GitLab) suporta GFM.

Como escapar caracteres especiais?

Utilize uma barra invertida antes de *, _, #, [, etc. Por exemplo, \* mostra um asterisco literal.

Posso utilizar offline?

Transfira a guia rápida como ficheiro .md. Guarde-a na sua pasta de projecto ou documentação para referência rápida.

Guia rápida vs guia de sintaxe?

Uma guia rápida fornece uma referência compacta copy-paste para sintaxe Markdown.

Os meus dados são privados?

Sim. Tudo executa-se no seu browser. Nenhum conteúdo é enviado para qualquer servidor.

Ferramentas relacionadas

Formatador Markdown Gerador de tabelas Markdown Gerador TOC Markdown Markdown para HTML Linter Markdown Validador Markdown Formatador JSON

Saiba mais: CommonMark, especificação CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub.