asandikci.com/web

Fork 0

Cotes Chung db06610fd6 Update the docs.

2020-08-11 05:58:59 +08:00

7.9 KiB

Raw Blame History

Chirpy

🌏 English • 简体中文

一个不一样的 Jekyll 主题，采用响应式设计，方便记录、管理、分享你的知识和经验。懂的进 »

⚠️ 中文版文档存在更新不及时的风险（开源文档以英文为主，请见谅）。如果发现中、英文内容不匹配的情况，一切以英文版内容为准。如果您愿意的话，可提交 issuse 提醒作者更新中文版 README，谢谢。

功能一览

文章置顶
可配置的全局主题颜色
文章最后修改日期
文章目录
自动推荐相关文章
语法高亮
二级目录
数学表达式
搜索
Atom 订阅
Disqus 评论
Google 分析
GA 浏览报告（高级功能）
SEO 优化
网站性能优化

安装

Fork Chirpy，然后克隆到本地：

$ git clone git@github.com:<username>/jekyll-theme-chirpy -b master --single-branch

设置本地环境

如果你想在本地运行或构建, 参考 Jekyll Docs安装 Ruby， RubyGems 和 Bundler。

首次运行或构建时, 请先安装 Jekyll plugins。在项目根目录运行：

$ bundle install

bundle 会自动安装 Gemfile 内指定的依赖插件。

另外，为了生成一些额外的文件（ Post 的分类、标签以及更新时间列表），需要用到一些脚本工具。如果你电脑的操作系统是 Debian 或者 macOS，请确保已经安装了GNU coreutils，否则，通过以下方式完成安装：

Debian
```
$ sudo apt-get install coreutils
```
macOS
```
$ brew install coreutils
```

使用

运行 Chirpy 需要一些额外的文件, 它们不能通过 Jekyll 原生的命令生成，所以请严格依照下列说明去运行或部署此项目。

初始化

在项目根目录，开始初始化:

$ bash tools/init.sh

如果你不打算部署到 GitHub Pages, 在上述命令后附加参数选项 --no-gh。

上述脚本完成了以下工作:

从你的仓库中删除了:
- .travis.yml
- _posts 下的文件
- docs 目录
如果使用了参数 --no-gh，则会怒删 .github。否则，将会配置 GitHub Actions：把 .github/workflows/pages-deploy.yml.hook 的后缀 .hook 去除，然后删除 .github 里的其他目录和文件。
自动提交一个 Commit 以保存上述文件的更改。

配置文件

根据个人需要去修改 _config.yml 的变量，大部分都有注释介绍用法。典型的几个选项是：

url
avatar
timezone
theme_mode

本地运行

使用以下工具可轻松运行:

$ bash tools/run.sh

访问本地服务： http://localhost:4000

如果你想在本地服务运行后，把修改源文件的更改实时刷新，可使用选项 -r (或 --realtime)，不过要先安装依赖 fswatch 。

部署

部署开始前，把 _config.yml 的 url 改为 https://<username>.github.io(或者你的私有域名，如：https://yourdomain.com)。另外，如果你想使用 Project 类型网站，修改配置文件的 baseurl 为项目名称，以斜杠开头，如：/project。

假设你已经完成了初始化，现在你可以选择下列其中一个方式去站点部署。

部署到 GitHub Pages

由于安全原因，GitHub Pages 的构建强制加了 safe参数，这导致了我们不能使用脚本工具去创建所需的附加页面。因此，我们可以使用 GitHub Actions 去构建站点，把站点文件存储在一个新分支上，再指定该分支作为 Pages 服务的源。

推送任意一个 commit 到 origin/master 以触发 GitHub Actions workflow。一旦 build 完毕，远端将会自动出现一个新分支 gh-pages 用来存储构建的站点文件。
除非你是使用 project 站点, 否则重命名你的仓库为 <username>.github.io。
选择分支 gh-pages 作为 GitHub Pages 站点的发布源.
按照 GitHub 指示的地址去访问你的网站。

部署到其他 Pages 平台

在 GitHub 之外的平台，例如 GitLab，就没法享受 GitHub Actions 的便利了。不过先别慌，可以通过工具来弥补这个遗憾。

先把本地仓库的 upstream 改为新平台的仓库地址，推送一发。以后每次更新内容后，提交 commit ，然后运行:

$ bash tools/publish.sh

注: 最后更新 列表根据文章的 git 修改记录生成，所以运行前先把 _posts 目录的修改提交。

它会自动生成文章的 最后修改日期 和 分类 / 标签 页面，并自动提交一个 commit 并推送到 origin/master 。输出日志类似如下：

[INFO] Success to update lastmod for 4 post(s).
[INFO] Succeed! 3 category-pages created.
[INFO] Succeed! 4 tag-pages created.
[INFO] Published successfully!

最后，根据平台的说明文档为项目开启 Pages 服务。

部署到私人服务器

在项目更目录，运行:

$ bash tools/build.sh -d /path/to/site/

生成的静态文件将会在 /path/to/site/，把内部的文件上传到服务器即可。

文档

若想要更多细节以及更佳的阅读体验，请参阅线上教程。与此同时，Wiki 也有一份教程的拷贝。

参与贡献

三人行必有我师，欢迎提报告 bug, 帮助改进代码质量，或者提交新功能。具体操作规则请参考贡献指南，谢谢 🙏。

感谢

这个主题的开发主要基于 Jekyll 生态、Bootstrap、Font Awesome 和其他一些出色的工具 (相关文件中可以找到这些工具的版权信息).

🎉 感谢所有参与代码贡献的小伙伴, 他们的 GayHub ID 在这个列表。另外, 提交过 issues(或者未被合并 PR) 的高富帅和白富美也不会被遗忘,他/她们帮助报告 bug、分享新点子或者启发了我写出更通俗易懂的文档。

赞助

如果您喜欢这个主题或者它对您有帮助，请考虑打赏作者：在项目主页点击按钮 ❤️ Sponsor 选择适合的链接即可完成（国内一般选第二个链接，支付宝/微信赞助），您的打赏将会极大地鼓励作者，并帮助作者更好地维护项目！

许可证书

本项目开源，基于 MIT 许可。

7.9 KiB Raw Blame History Unescape Escape