开始

环境要求

按照 Jekyll 文档 的说明完成基本环境的安装。还需要安装Git。

安装

创建新站点

有两种方法可以为此主题创建新的存储库：

• 使用Chirpy启动器 - 易于升级，隔离不相关的项目文件，以便您可以专注于编写。
• GitHub Fork - 方便自定义开发，但难以升级。除非您熟悉 Jekyll 并决心调整或为该项目做出贡献，否则不建议使用此方法。

选项 1. 使用Chirpy启动器

登录到 GitHub 并浏览到 Chirpy Starter, 单击按钮 Use this template > Create a new repository, 并将新存储库命名为 USERNAME.github.io, 其中 USERNAME 表示您的github用户名。

选项 2. GitHub Fork

登录到GitHub 以fork Chirpy, 然后将其重命名为 USERNAME.github.io (USERNAME 表示您gitHub的用户名).

接下来，将站点克隆到本地计算机。为了稍后构建 JavaScript 文件，我们需要安装 Node.js，然后运行该工具：

$ bash tools/init

如果您不想在 GitHub 页面上部署站点，请在上述命令末尾附加选项--no-gh。

上述命令将:

1. 查看 最新标签的代码（以确保网站的稳定性：因为默认分支的代码正在开发中）。
2. 删除非必要的示例文件，并处理与GitHub相关的文件。
3. 构建JavaScript文件并导出到assets/js/dist/，然后Git跟踪它们。
4. 自动创建一个新的提交以保存上面的更改。

测试发现运行bash tools/init总会报错，无法构建JavaScript文件，建议使用第一种方法，简单可快速上手。

安装依赖项

在首次运行本地服务器之前，请转到站点的根目录并运行：

$ bundle

用法

配置

根据需要更新_config.yml的变量。其中一些是典型的选择：

• url
• avatar
• timezone
• lang

自定义样式表

如果您需要自定义样式表，请将主题的 assets/css/style.scss 复制到Jekyll网站上的同一路径，然后在其末尾添加自定义样式。

从版本 4.1.0 开始，如果您想覆盖在 _sass/addon/variables.scss 中定义的SASS变量，请将SASS主文件 _sass/jekyll-theme-chirpy.scss 复制到站点源中的_sass 目录中，然后创建一个新文件_sass/variables-hook.scss ，并分配新值。

自定义静态资源

在5.1.0版本中引入了静态资源配置。静态资源的CDN由文件 _data/origin/cors.yml 定义，您可以根据网站发布地区的网络条件替换其中的一些。

此外，如果您想自托管静态资源，请参阅chirpy-static-assets。

运行本地服务器

您可能希望在发布之前预览网站内容，因此只需通过以下方式运行它：

$ bundle exec jekyll s

或者使用以下命令在 Docker 上运行站点：

$ docker run -it --rm \
    --volume="$PWD:/srv/jekyll" \
    -p 4000:4000 jekyll/jekyll \
    jekyll serve

几秒钟后，本地服务将在 http://127.0.0.1:4000 发布.

部署

在部署开始之前，请检查文件 _config.yml ，并确保url配置正确。此外，如果您更喜欢project site并且不使用自定义域，或者您想使用GitHub Pages以外的web服务器上的基本URL访问您的网站，请记住将 baseurl 更改为以斜杠开头的项目名称，例如 /project-name 。

现在，您可以选择 以下方法之一 来部署您的 Jekyll 站点。

使用 GitHub 操作进行部署

有几件事需要做好准备。

如果您使用的是 GitHub 免费计划，请保持站点存储库公开。 如果您已将 Gemfile.lock 提交到存储库，并且您的本地计算机未运行 Linux，请转到站点的根目录并更新锁定文件的平台列表：

  $ bundle lock --add-platform x86_64-linux

接下来，配置页面服务。

1.在GitHub上浏览到您的存储库。选择选项卡 Settings ，然后单击左侧导航栏中的 Pages 。然后，在 Source 部分（在 Build and deployment 下），从下拉菜单中选择GitHub Actions。

2.将任何提交推送到GitHub以触发 Actions 工作流。在存储库的 Actions 选项卡中，您应该看到工作流 Build 和 Deploy 正在运行。一旦构建完成并成功，站点将自动部署。

此时，您可以转到 GitHub 指示的 URL 以访问您的网站。

手动构建和部署

在自托管服务器上，您无法享受 GitHub Actions 的便利。因此，应在本地计算机上生成站点，然后将站点文件上载到服务器。

转到源项目的根目录，并按如下所示生成站点：

$ JEKYLL_ENV=production bundle exec jekyll b

或者在 Docker 上构建网站：

$ docker run -it --rm \
    --env JEKYLL_ENV=production \
    --volume="$PWD:/srv/jekyll" \
    jekyll/jekyll \
    jekyll build

除非指定了输出路径，否则生成的站点文件将放置在项目根目录的文件夹 _site 中。现在，您应该将这些文件上传到目标服务器。

---

原文出处