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. 启用项目站点。

    转到 Settings-GitHub Pages-Sources,选择一个源来打开存储库的 GitHub 页面。

  2. 建立网站

    你可以从头开始构建一个 Jekyll 站点,或使用 Theme Chooser 为项目站点查找主题。

  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 Sitemap
  • Jekyll SEO 标签
  • GitHub 的元数据
  • 杰基尔饲料
  • Jekyll 重定向自
  • Jemoji
  • 杰基尔提到

为避免与 GitHub 页面不一致,你可以使用 --safe 在本地服务。

你仍然可以通过将生成的站点发布到 GitHub 页面来使用所有插件,方法是在本地转换站点并将生成的静态文件推送到 GitHub 存储库而不是 Jekyll 源文件。

降价引擎

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

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

来源

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

有关完整的教程,请访问 https://pages.github.com/