Títulos e seções do documento
Coloque de um a seis sinais # e um espaço antes do título. Em um README, use # para o nome do projeto e ## para seções como instalação e uso.
Como fazer uma tabela ou pular linha? Encontre a sintaxe nesta referência rápida de Markdown, edite o exemplo e confira a prévia. Copie o Markdown para seu arquivo .md ou o resultado formatado para colar em um documento.
Coloque de um a seis sinais # e um espaço antes do título. Em um README, use # para o nome do projeto e ## para seções como instalação e uso.
Para negrito, envolva o trecho com **; para itálico, use *. O texto tachado com ~~ funciona nesta prévia e no GitHub.
Uma linha em branco separa parágrafos. Para pular linha dentro do mesmo parágrafo, deixe dois espaços no fim da primeira linha e pressione Enter. Nesta prévia, Enter sozinho não força a quebra.
Use uma barra invertida antes de um símbolo que seria interpretado como formatação. Assim, o asterisco, o # e os colchetes aparecem no texto.
Comece a linha com > e um espaço. Use esse formato para separar uma citação ou uma observação do restante das anotações.
Escreva três hífens em uma linha própria, com uma linha em branco antes. Sem esse espaço, os hífens podem transformar a linha de cima em um título.
Use 1. para uma etapa e - para um marcador. Para criar uma sublista, recue o hífen até o início do texto do item principal; no exemplo, são três espaços.
Escreva - [ ] para uma pendência e - [x] para uma tarefa concluída. Preserve o espaço depois do hífen e depois dos colchetes. Funciona nesta prévia e no GitHub.
O link usa [texto](URL); a imagem começa com !. Este exemplo usa uma imagem da web. No README, você também pode usar um caminho relativo ao arquivo .md, como imagens/diagrama.png, se a imagem estiver no repositório.
Defina a URL em uma linha separada e use o mesmo identificador no texto. É útil quando um endereço aparece várias vezes na documentação.
Separe as colunas com | e inclua uma linha de hifens abaixo do cabeçalho. Deixe uma linha em branco antes da tabela ao inseri-la em outro texto. Tabelas funcionam nesta prévia e no GitHub.
Use :--- à esquerda, :---: no centro e ---: à direita na linha separadora. Para mostrar | dentro de uma célula, escreva \|. O exemplo funciona nesta prévia e no GitHub.
Use uma crase de cada lado para um comando no texto e três crases em linhas separadas para um bloco de código. Depois das crases de abertura, você pode indicar a linguagem, como js. O código exibido não é executado.
Use a mesma identificação na chamada [^nota] e na definição. Esta prévia e os arquivos .md do GitHub aceitam notas de rodapé. No GitHub, notas de rodapé não são aceitas em wikis. Em outros editores, confira o suporte antes de usar.
Nesta prévia, == destaca um trecho e ++ marca uma inserção. São extensões do editor: essas mesmas marcas não têm esse efeito no Markdown do GitHub.
Esta prévia aceita ~ para subscrito e ^ para sobrescrito. Essas formas dependem do editor e não são a sintaxe usada pelo GitHub para esses efeitos.
Adapte este README de um organizador de estudos: apresente o projeto, explique o uso e liste as próximas entregas. Troque o link de exemplo pelo endereço da sua documentação. Copie a sintaxe para o README.md e confira a prévia no GitHub.
Registre decisões e distribua as próximas tarefas. Substitua os campos pelos dados da equipe; depois, copie o Markdown para suas notas ou o resultado formatado para um documento.
Reúna resumo, atividades e próximos passos em um só exemplo. Adapte o texto e use Converter para Word no cartão para levar o relatório ao conversor; confira títulos, listas e tabela no documento gerado.
Quando o resultado não sai como esperado, comece pelo símbolo, pelo espaço ou pelo caminho que faz diferença na escrita.
Em um arquivo .md, uma quebra no texto-fonte pode continuar como espaço no parágrafo. Para separar parágrafos, deixe uma linha vazia. Para uma quebra dentro do parágrafo, mantenha dois espaços antes do Enter. O GitHub trata Enter de forma diferente em comentários e em arquivos .md; confira o tipo de campo em que você está escrevendo.
Se você escreveu só o cabeçalho e os dados, falta a linha separadora: coloque | --- | --- | entre eles em uma tabela de duas colunas. Confira se o cabeçalho e o separador têm o mesmo número de colunas. Se uma barra vertical fizer parte do conteúdo, use \| para ela não abrir outra célula. Deixe uma linha em branco antes da tabela e verifique se o editor aceita esse recurso.
Para montar as colunas e ajustar o alinhamento, use o gerador de tabelas Markdown e copie a sintaxe para seu documento.
Para um README.md na raiz do repositório,  aponta para a pasta imagens da mesma raiz. Confira o nome, a extensão, maiúsculas e minúsculas e se o arquivo foi enviado ao GitHub. Um caminho local do seu computador não resolve para os demais leitores. A prévia desta página não tem acesso aos arquivos do seu repositório; teste esse caminho no próprio GitHub.
Alinhe o marcador da sublista com o começo do texto do item principal. Em 1. Revisar, o texto começa depois de três caracteres: recue a sublista com três espaços. Se o número ganhar mais dígitos, ajuste o recuo. O exemplo de listas mostra essa relação.
A sintaxe básica é um ponto de partida. Os recursos extras e o contexto de uso explicam por que o mesmo texto pode aparecer de outro jeito.
Para conferir as regras do GitHub, consulte a documentação de escrita e formatação e o guia de tabelas. A tabela abaixo descreve esta prévia; não é uma garantia de compatibilidade com todos os aplicativos.
| Recurso | Nesta prévia | Ao usar em outro lugar |
|---|---|---|
| Títulos, negrito, links, listas e código | São formatados nos exemplos. | Confira o documento no editor de destino. |
| Tabelas, tarefas e texto tachado | São formatados como extensões. | Também são aceitos no GitHub; outros editores podem variar. |
| Destaque == e inserção ++ | Aplicam destaque e inserção. | Não use essas marcas esperando o mesmo efeito no GitHub. |
| Subscrito ~ e sobrescrito ^ | Aplicam subscrito e sobrescrito. | O GitHub usa outra sintaxe para esses efeitos. |
| Tags HTML, como <br> e <ins> | Aparecem como texto, sem aplicar HTML. | O GitHub aceita algumas tags; não copie a regra de um editor para outro. |
Copie a sintaxe Markdown para o arquivo .md. O modelo de README reúne apresentação, etapas, checklist e link. Adapte esses trechos e confira o resultado no repositório, sobretudo os caminhos das imagens.
Use títulos para separar assuntos e listas para registrar pontos e pendências. Para conferir um texto completo, abra o editor Markdown com prévia em tempo real. Se você usa Obsidian ou a prévia do VS Code, cole o Markdown e confira as extensões no próprio aplicativo. Ao colar em um editor de texto com formatação, experimente copiar o resultado do cartão.
Nos cartões de modelos, o botão Converter para Word leva o texto editado ao conversor. Para começar com outro arquivo ou texto, abra o conversor de Markdown para Word. O modelo de relatório de estudos já reúne títulos, lista e tabela para esse fluxo. Depois de gerar o documento, confira a hierarquia dos títulos, o recuo das listas e a organização das colunas antes de entregar.
Uma cola de Markdown para consultar enquanto você escreve, do primeiro negrito aos ajustes no README.
Markdown é texto com marcas de formatação: **texto** fica em negrito e # seguido de espaço cria um título. Não é preciso executar código. Edite um exemplo acima, compare a sintaxe com o resultado e copie a versão adequada ao seu documento.
Deixe uma linha em branco para começar outro parágrafo. Para quebrar a linha dentro do mesmo parágrafo, termine a primeira linha com dois espaços e pressione Enter. Nesta prévia e em arquivos .md do GitHub, Enter sozinho não força essa quebra; em comentários do GitHub, o comportamento é diferente.
Escreva o cabeçalho, a linha separadora e os dados, usando | entre as colunas. Em uma tabela de duas colunas, o separador pode ser | --- | --- |. Os dois-pontos nessa linha controlam o alinhamento. Os exemplos acima mostram uma tabela simples e outra com alinhamento e uma barra vertical dentro da célula.
Crie ou edite README.md e cole a sintaxe Markdown. Comece com # e o nome do projeto, use ## para as seções e listas para instruções. Adapte o modelo desta página com os dados do seu projeto e confira a prévia do GitHub antes de salvar.
Use . O endereço pode ser uma URL ou, no README, um caminho relativo ao arquivo .md. Se a imagem não aparecer, confira o caminho, o nome exato do arquivo e se ele está no repositório. A descrição entre colchetes serve como texto alternativo.
Comece cada tarefa com - [ ] seguido de espaço e do texto. Para marcar uma concluída, troque por - [x]. O exemplo de lista de tarefas mostra as duas formas. Elas funcionam nesta prévia e no GitHub; em outros editores, confira se há suporte a caixas de seleção.
O GitHub usa GitHub Flavored Markdown (GFM) e recursos próprios da plataforma. Esta prévia também tem extensões, como ==destaque== e ++inserção++, que não funcionam desse jeito no GitHub. Além disso, tags HTML aparecem como texto aqui. Confira a tabela de recursos e valide o arquivo no destino.
Markdown básico não define uma marca própria para sublinhar ou centralizar parágrafos. HTML e extensões dependem do editor; esta prévia não interpreta tags HTML. _texto_ cria itálico, não sublinhado. Para centralizar uma coluna de tabela, use :---: na linha separadora.