GitHub Pages 是一项将 Markdown 文件转换为网站并在 Internet 上免费托管它们的服务。如果您知道如何使用 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。这意味着您的文件在 GitHub 网站上的显示方式与 GitHub Pages 网站上的文件看起来不同。例如,表情符号在 GitHub 的网站上呈现,但不在使用 GitHub Pages 生成的网站上呈现。README.md

GitHub Pages Markdown 支持

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

Element Support Notes
Headings Yes
Paragraphs Yes
Line Breaks Yes
Bold Yes
Italic Yes
Blockquotes Yes
Ordered Lists Yes
Unordered Lists Yes
Code Yes
Horizontal Rules Yes
Links Yes
Images Yes
Tables Yes
Fenced Code Blocks Yes
Syntax Highlighting Yes Make sure that is in the section of the file. syntax_highlighter: rougekramdown_config.yml
Footnotes Yes
Heading IDs Yes
Definition Lists Yes
Strikethrough Yes You can use two tildes () or one tilde () — both work. ~~word~~~word~
Task Lists Yes
Emoji (copy and paste) Unknown
Emoji (shortcodes) Unknown
Highlight No
Subscript No
Superscript No
Automatic URL Linking Yes
Disabling Automatic URL Linking Yes
HTML Yes

支持其他语法元素

作为额外的奖励,GitHub Pages 提供了对几个晦涩元素的支持。

Element Markdown Rendered Output
Abbreviation *[HTML]: Hyper Text Markup Language
The HTML specification is maintained by the W3C.
The HTML specification is maintained by the W3C.

另请参阅

将您的 Markdown 技能提升到一个新的水平。

在 60 页中学习 Markdown。《Markdown 指南》专为新手和专家设计,是一本全面的参考书,包含您入门和掌握 Markdown 语法所需的一切。

获取书籍