飞翔飞翔
主页
  • 计算机基础

    • TCP协议
  • 数据库

    • SQL教程
  • 编程语言

    • C语言
    • Python2
    • Python3
  • 数据格式

    • JSON教程
  • 工具

    • Markdown指南
  • Git

    • GitFlow
  • Quartz

    • Quartz教程
  • Java

    • Java设计模式
  • 缓存

    • Redis教程
联系
阿里云
主页
  • 计算机基础

    • TCP协议
  • 数据库

    • SQL教程
  • 编程语言

    • C语言
    • Python2
    • Python3
  • 数据格式

    • JSON教程
  • 工具

    • Markdown指南
  • Git

    • GitFlow
  • Quartz

    • Quartz教程
  • Java

    • Java设计模式
  • 缓存

    • Redis教程
联系
阿里云
  • 入门指南
  • 速查表
  • 基本语法

    • 标题
    • 段落
    • 换行
    • 强调
    • 引用块
    • 列表
    • 代码
    • 水平线
    • 链接
    • 图片
    • 转义字符
    • HTML
  • 扩展语法

    • 可用性
    • 表格
    • 围栏代码块
    • 脚注
    • 标题ID
    • 定义列表
    • 删除线
    • 任务列表
    • 表情符号
    • 高亮
    • 下标
    • 上标
    • 自动URL链接
    • 禁用自动URL链接
  • 实用技巧

    • 概述
    • 下划线
    • 缩进
    • 居中
    • 颜色
    • 注释
    • 提示框
    • 图片大小
    • 图片说明
    • 链接目标
    • 符号
    • 表格格式
    • 目录
    • 视频
  • 工具
  • 版权声明

GitHub Pages

GitHub Pages

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

GitHub Pages 使用 Jekyll 静态站点生成器来创建网站,其 Markdown 支持非常出色。您可以从 GitHub 提供的预制主题中选择一个作为您的网站主题,也可以使用 Jekyll 主题,或者使用自定义 CSS。下图展示了一个使用 GitHub 预制主题的示例网页。

GitHub Pages 网站示例

令人困惑的是,GitHub Pages 渲染 Markdown 的方式与 GitHub 不同。GitHub 使用自己的 Markdown 处理器;GitHub Pages 使用 jekyll-commonmark。这意味着您的 README.md 文件在 GitHub 网站上和 GitHub Pages 网站上的显示效果会有所不同。例如,表情符号可以在 GitHub 网站上渲染,但不能在使用 GitHub Pages 生成的网站上渲染。

GitHub Pages Markdown 支持

GitHub Pages 支持以下 Markdown 元素。

功能支持备注
标题是
段落是
换行是
粗体是
斜体是
引用块是
有序列表是
无序列表是
代码是
水平线是
链接是
图片是
表格是
围栏代码块是
语法高亮是确保 _config.yml 文件的 kramdown 部分中包含 syntax_highlighter: rouge
脚注是
标题 ID是
定义列表是
删除线是可以使用双波浪号(~~文字~~)或单波浪号(~文字~)——两者都可以
任务列表是
表情符号(复制粘贴)未知
表情符号(短代码)未知
高亮否
下标否
上标否
自动 URL 链接是
禁用自动 URL 链接是
HTML是

额外语法支持

作为额外功能,GitHub Pages 还支持以下特殊元素。

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

另见

  • Jekyll 文档
  • kramdown 文档