Repolode
提交项目
guodongxiaren

guodongxiaren/README

展示 GitHub Flavored Markdown（GFM）各类语法写法与渲染效果的语法参考文件。

在 GitHub 查看官网
Star
7,064
Fork
7,039
未关闭 Issue
55
最近提交
12个月前

这是什么？

这是一份 GitHub Flavored Markdown（GFM）的语法实践手册。内容涵盖标题、文本样式、图片、链接、列表、块引用、代码高亮、表格、提示框（Alerts）、表情、diff 语法，以及折叠、居中等常用 HTML 写法。

每个小节都同时给出源码和渲染效果，方便对照查看。这些语法同样适用于 GitHub 上的 README、Issues 和 Wiki，适合在编写项目文档时快速查阅。

核心功能

  • 01涵盖标题、文字强调、删除线和多级列表等基础语法。
  • 02介绍图片与链接写法，包括引用式链接。
  • 03演示带语言标识的代码块高亮。
  • 04包含表格对齐、提示框（Alerts）和 diff 高亮。
  • 05给出折叠内容、居中展示等常用 HTML 写法。

适用场景

  • 编写 README 或 Issue 时查询 GFM 语法。
  • 学习在 GitHub 上使用表格、任务列表和提示框。
  • 查看折叠区块、居中内容等 HTML 写法。

使用前须知

  • 这是一个Markdown语法参考和测试文件，并非可安装的软件。

收录于专题

静态网站生成器与文档工具

标签

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

常见问题

README 是什么？
展示 GitHub Flavored Markdown（GFM）各类语法写法与渲染效果的语法参考文件。 这是一份 GitHub Flavored Markdown（GFM）的语法实践手册。内容涵盖标题、文本样式、图片、链接、列表、块引用、代码高亮、表格、提示框（Alerts）、表情、diff 语法，以及折叠、居中等常用 HTML 写法。
README 可以免费使用吗？用的什么许可证？
README 以 Unlicense 许可证开源。用于商业产品前，请先确认许可证条款。
README 还在维护吗？
超过半年未提交。README 最近一次提交是在 2025年11月24日。
README 适合用来做什么？
编写 README 或 Issue 时查询 GFM 语法。 学习在 GitHub 上使用表格、任务列表和提示框。 查看折叠区块、居中内容等 HTML 写法。
在哪里获取 README？
源代码和安装说明在 GitHub 上：https://github.com/guodongxiaren/README

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目