Repolode
Enviar
guodongxiaren

guodongxiaren/README

Referência de sintaxe Markdown e arquivo de testes que mostra como o GitHub Flavored Markdown (GFM) é renderizado em READMEs, issues e wikis.

Ver no GitHubSite
Estrelas
7,064
Forks
7,039
Issues abertas
55
Último commit
há 12 meses

O que é?

Este repositório é um guia prático de GitHub Flavored Markdown, a sintaxe Markdown estendida usada no GitHub. Ele aborda títulos, formatação de texto, imagens, links, listas, citações em bloco, realce de código, tabelas, alertas, emoji, blocos diff e tags HTML comuns, como seções recolhíveis e conteúdo centralizado.

Cada seção combina a sintaxe original com o resultado renderizado, para que os leitores vejam exatamente como cada elemento será exibido. Os mesmos recursos do GFM se aplicam a arquivos README, issues e wikis no GitHub, tornando o documento uma referência rápida útil na hora de escrever a documentação de um projeto.

Recursos principais

  • 01Aborda títulos, ênfase, texto tachado e listas aninhadas.
  • 02Mostra a sintaxe para imagens e links, incluindo links no estilo de referência.
  • 03Demonstra blocos de código delimitados com realce de sintaxe por linguagem.
  • 04Inclui alinhamento de tabelas, blocos de alerta e realce de diff.
  • 05Documenta recursos de HTML, como seções recolhíveis e conteúdo centralizado.

Casos de uso

  • Consultar a sintaxe do GFM ao escrever um README ou uma issue.
  • Aprender a formatar tabelas, listas de tarefas e alertas no GitHub.
  • Verificar como escrever seções recolhíveis ou blocos centralizados em HTML.

Antes de usar

  • Este arquivo é uma referência de sintaxe Markdown e um arquivo de teste; não é um software instalável.

Em coleções

Geradores de sites estáticos e ferramentas de documentação

Tópicos

#markdown#gfm#readme#documentation#github#flavored

Perguntas frequentes

O que é README?
Referência de sintaxe Markdown e arquivo de testes que mostra como o GitHub Flavored Markdown (GFM) é renderizado em READMEs, issues e wikis. Este repositório é um guia prático de GitHub Flavored Markdown, a sintaxe Markdown estendida usada no GitHub. Ele aborda títulos, formatação de texto, imagens, links, listas, citações em bloco, realce de código, tabelas, alertas, emoji, blocos diff e tags HTML comuns, como seções recolhíveis e conteúdo centralizado.
README é gratuito? Qual é a licença?
README é open source sob a licença Unlicense. Confira os termos da licença antes de usá-lo em produtos comerciais.
README ainda é mantido?
Sem commits há mais de 6 meses. O último commit de README foi em 24 de nov. de 2025.
Para que posso usar README?
Consultar a sintaxe do GFM ao escrever um README ou uma issue. Aprender a formatar tabelas, listas de tarefas e alertas no GitHub. Verificar como escrever seções recolhíveis ou blocos centralizados em HTML.
Onde consigo README?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/guodongxiaren/README

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados

badges / shields

Shields.io é um serviço e uma biblioteca NPM que gera badges de status concisos em SVG e formatos rasterizados para arquivos README e páginas da web.

DevOps e nuvem#badge#svg#status-badge
27,4 mil+23 esta semana5,6 milJavaScriptApache-2.0Bem mantidoAtualizado ontem