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 Amostra 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 .md. Para converter Markdown para HTML, utilize Markdown para HTML. Para um TOC a partir de títulos, utilize o Gerador TOC Markdown.

Referência rápida

Sintaxe essencial de Markdown

Markdown:

# Heading 1
## Heading 2

**bold** and *italic* and `code`

- List item 1
- List item 2

[Link text](https://example.com)

> Blockquote

Renderizado como:

Large heading
Medium heading

Bold text, italic text, and inline code

Bulleted list with two items

Clickable hyperlink

Indented block quote

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

Qual é a diferença entre Markdown e HTML?

Markdown é uma linguagem de marcação leve que converte para HTML. Em vez de escrever <strong>negrito</strong> você escreve **negrito**. Markdown é mais rápido de escrever e mais fácil de ler como texto simples. É amplamente usado para documentação, arquivos README e produção de conteúdo.

Markdown é igual em todo lugar?

Não exatamente. A especificação original do Markdown deixa algumas ambiguidades, então diferentes plataformas implementam variações ligeiras. CommonMark é a especificação padronizada que a maioria das ferramentas segue. GitHub Flavored Markdown (GFM) adiciona extras como listas de tarefas e tabelas.

Como adiciono uma quebra de linha em Markdown?

Termine uma linha com dois ou mais espaços antes de pressionar Enter, ou use uma barra invertida \ no final da linha. Alguns parsers também tratam uma linha em branco entre parágrafos como uma quebra. O comportamento varia ligeiramente entre os sabores de Markdown.

Posso usar HTML dentro do Markdown?

Sim — a maioria dos parsers Markdown permite HTML bruto embutido. Você pode usar <br>, <div>, <span> e a maioria das outras tags HTML diretamente em arquivos Markdown. Isso é útil para centralizar conteúdo ou adicionar estilos personalizados.

Os meus dados são privados?

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

Ferramentas relacionadas

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