GitHub Pages 是一项服务,它可以将 Markdown 文件转换为网站,并免费将它们托管在互联网上。如果你知道如何使用 GitHub,并且需要创建一个简单的网页,那么 GitHub Pages 是你的不二之选。只需在 GitHub 上创建一个新存储库,提交 Markdown 文件,然后启用 GitHub Pages 功能即可。

GitHub Pages 使用 Jekyll 静态网站生成器来创建你的网站,并且对 Markdown 的支持非常出色。你可以为你的网站选择 GitHub 的预制主题之一,使用 Jekyll 主题,或使用你自己的自定义 CSS。下面显示的是使用 GitHub 预制主题之一的示例网页。

Example of GitHub Pages websites

令人困惑的是,GitHub Pages 呈现 Markdown 的方式与 GitHub 不同。GitHub 使用自己的 Markdown 处理器;GitHub Pages 使用 jekyll-commonmark。这意味着你的 README.md 文件在 GitHub 网站上看起来会与在 GitHub Pages 网站上不同。例如,表情符号会在 GitHub 网站上呈现,但不会在使用 GitHub Pages 生成的网站上呈现。

GitHub Pages Markdown 支持

GitHub Pages 为以下 Markdown 元素提供支持。

元素 支持 备注
标题
段落
换行符
粗体
斜体
引用块
有序列表
无序列表
代码
水平线
链接
图像
表格
带围栏的代码块
语法高亮 确保 syntax_highlighter: rouge_config.yml 文件的 kramdown 部分中。
脚注
标题 ID
定义列表
删除线 可以使用两个波浪号 (~~word~~) 或一个波浪号 (~word~)——两者都可以。
任务列表
表情符号(复制并粘贴) 未知
表情符号(简码) 未知
高亮
下标
上标
自动 URL 链接
禁用自动 URL 链接
HTML

支持其他语法元素

作为一项额外福利,GitHub Pages 为若干晦涩元素提供支持。

元素 Markdown 呈现的输出
缩写 *[HTML]: 超文本标记语言
HTML 规范由 W3C 维护。
由 W3C 维护 HTML 规范。

另请参见

将 Markdown 技能提升到一个新高度。

60 页学会 Markdown。Markdown 指南 一书专为新手和专家设计,是一本综合参考书,包含入门和精通 Markdown 语法所需的一切内容。

获取本书
想要了解有关 Markdown 的更多信息吗?

不要现在就停止!🚀 Star GitHub 存储库,然后在下方输入您的电子邮件地址,以通过电子邮件接收新的 Markdown 教程。无垃圾邮件!