jekyll GitHub页面

示例

GitHub为用户或组织和项目站点提供无限托管。Jekyll和静态文件均可用。

以下是在Github上托管Jekyll博客的步骤。

设定

用户或组织站点

1. 创建一个名为username.github.io的存储库，其中username是您在GitHub上的用户名（或组织名称）。

2. 将存储库克隆到您的计算机上：

   $git clone https://github.com/username/username.github.io
   

3. 输入项目文件夹，进行引导，设计和调试站点：

   $cd username.github.io
   $bundle install
   $bundle exec jekyll serve
   

4. 提交并推送存储库：

   $git add --all
   $git commit -m "Initial commit"
   $git push -u origin master
   

现在，您应该可以访问username.github.io来查看您的博客。

项目现场

可以在每个存储库（包括私有存储库）中启用项目站点。

1. 启用项目站点。

   转到设置-GitHub Pages-源，选择一个源以打开存储库的GitHub Pages。

2. 建设现场

   您可以从头开始构建Jekyll网站，也可以使用主题选择器为您的项目网站找到主题。

3. 编辑内容

4. 承诺

现在您应该能够访问username.github.io/your-project来查看您的项目站点。

自定义域

1. 打开设置-> GitHub页面->自定义域，添加您的自定义域。

2. 创建一个CNAME文件：

   $cd username.github.io
   $echo "example.com" > CNAME
   

3. 提交并推送

   $git commit -m "Add CNAME" CNAME
   $git push -u origin master
   

限制条件

外挂程式

Jekyll的插件系统带有钩子，可让您创建特定于站点的自定义生成内容。但是，出于安全原因，GitHub Pages仅允许插件的白名单。

这是白名单：

• Jekyll网站映射

• Jekyll SEO标签

• github元数据

• 杰基尔饲料

• Jekyll重定向自

• 洁子寺

• Jekyll提及

为了避免与GitHub Pages不一致，您可以使用--safe本地服务。

您仍然可以通过以下方式使用所有插件：将生成的站点发布到GitHub Pages，通过在本地转换站点并将生成的静态文件而不是Jekyll源文件推送到GitHub存储库。

降价引擎

自2016年1月5日起，GitHub Pages仅支持kramdown作为Markdown引擎。

有关更多详细信息，请参见https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0。

资料来源

GitHub允许您将Jekyll源设置为master分支，gh-pages分支或分支中的/docs文件夹master。

完整的教程可在https://pages.github.com/获得