66[ ![ GitHub license] ( https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg )] ( https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE )
77[ ![ 996.icu] ( https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg )] ( https://996.icu )
88
9- 一个不一样的响应式设计 Jekyll 主题(内附神秘工具) ,采用响应式设计,方便记录、管理、分享你的知识和经验。
9+ 一个不一样的 Jekyll 主题,采用响应式设计,方便记录、管理、分享你的知识和经验。[ 懂的进 » ] ( https://chirpy.cotes.info )
1010
1111[ ![ Devices Mockup] ( https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/devices-mockup.png )] ( https://chirpy.cotes.info )
1212
13+ > ⚠️ 中文版文档存在更新不及时的风险(开源文档以英文为主,请见谅)。如果发现中、英文内容不匹配的情况,一切以英文版内容为准。如果您愿意的话,可提交 issuse 提醒作者更新中文版 README,谢谢。
14+
1315## 目录
1416
1517* [ 功能预览] ( #功能预览 )
2830* 自动推荐相关文章
2931* 语法高亮
3032* 二级目录
33+ * 数学表达式
3134* 搜索
3235* Atom 订阅
33- * Disqus 评论
36+ * Disqus 评论
3437* Google 分析
3538* GA 浏览报告(高级功能)
3639* SEO 优化
4144
4245### 准备工作
4346
44- 按照 [ Jekyll 官方文档] ( https://jekyllrb.com/docs/installation/ ) 完成基础环境的安装 (Ruby, RubyGem, Bundler 和 Jekyll )。
47+ 按照 [ Jekyll 官方文档] ( https://jekyllrb.com/docs/installation/ ) 完成基础环境的安装 (` Ruby ` , ` RubyGem ` , ` Bundler ` )。
4548
46- 为了使用项目内免费提供的脚本工具提升你的写作体验 ,如果你的机器系统是 Debian 或者 macOS,则需要确保安装了 [ GNU coreutils] ( https://www.gnu.org/software/coreutils/ ) 。否则,通过以下方式获得:
49+ 为了使用项目内免费提供的脚本工具增进写作体验 ,如果你的机器系统是 Debian 或者 macOS,则需要确保安装了 [ GNU coreutils] ( https://www.gnu.org/software/coreutils/ ) 。否则,通过以下方式获得:
4750
4851* Debian
4952
@@ -66,7 +69,6 @@ $ git clone
[email protected] :USER/jekyll-theme-chirpy.git -b master
6669把上述的` USER ` 替换为你的 GitHub username。
6770
6871
69-
7072### 安装 Jekyll 插件
7173
7274本地首次运行或编译,请在项目根目录下运行:
@@ -121,13 +123,25 @@ jekyll-theme-chirpy/
121123
122124根据个人需要去修改 ` _config.yml ` 的变量,大部分都有注释介绍用法。
123125
124- * 头像
126+ * ` url `
127+
128+ 定义网站 URL,注意结尾不带 ` / ` 。格式: ` <protocol>://<domain> ` .
129+
130+ * ` avatar `
125131
126- 示例的头像文件放置在:` /assets/img/sample/avatar.jpg ` . 把它换成你自己的头像,路径不限定,越小越好。(压缩图像体积可上这个网站:* < https://tinypng.com/ > * ).
132+ 定义头像,示例的文件放置在:` /assets/img/sample/avatar.jpg ` . 把它换成你自己的头像,路径不限定,越小越好。(压缩图像体积可上这个网站:* < https://tinypng.com/ > * ).
133+
134+ * ` timezone `
127135
128- * 时区
136+ 定义时区 ,默认为 ` 亚洲/上海 ` ,如果肉身翻墙要换城市可在此列表找到: [ TimezoneConverter ] ( http://www.timezoneconverter.com/cgi-bin/findzone/findzone ) 或者 [ Wikipedia ] ( https://en.wikipedia.org/wiki/List_of_tz_database_time_zones ) .
129137
130- 时区由 ` timezone ` 定义,默认为 ` 亚洲/上海 ` ,如果肉身翻墙要换城市可在此列表找到: [ TimezoneConverter] ( http://www.timezoneconverter.com/cgi-bin/findzone/findzone ) 或者 [ Wikipedia] ( https://en.wikipedia.org/wiki/List_of_tz_database_time_zones ) .
138+ * ` theme_mode `
139+
140+ 定义颜色方案,有三种可选::
141+
142+ - ** dual** - 自动跟随系统的 ` 深色 ` /` 浅色 ` 设置,当系统或者浏览器不支持深色模式,则默认显示为浅色模式。无论如何,侧边栏左下角都会显示一个颜色切换按钮。
143+ - ** dark** - 全程深色模式。
144+ - ** light** - 全程浅色模式。
131145
132146
133147### 本地运行
@@ -167,7 +181,18 @@ $ bash tools/init.sh
167181
168182> ** 注** : * 最后更新* 列表根据文章的 git 修改记录生成,所以运行前先把 ` _posts ` 目录的修改提交。
169183
170- 它会自动生成文章的 * 最后修改日期* 和 * 分类 / 标签* 页面.
184+ 它会自动生成文章的 * 最后修改日期* 和 * 分类 / 标签* 页面,并自动提交一个 commit。输出日志类似如下:
185+
186+ ``` terminal
187+ [INFO] Success to update lastmod for 4 post(s).
188+ [INFO] Succeed! 3 category-pages created.
189+ [INFO] Succeed! 4 tag-pages created.
190+ [Automation] Updated the Categories, Tags, Lastmod for post(s).
191+ 11 files changed, 46 insertions(+), 3 deletions(-)
192+ ...
193+ Updated the Categories, Tags, Lastmod for post(s).
194+ ```
195+
171196
172197** 3** . 推送到 ` origin/master ` 然后到 GitHub 网页为该项目开启 Pages 服务。
173198
@@ -210,22 +235,24 @@ $ bash tools/build.sh -d /path/to/local/project/
210235| User or Organization | ` https://<username>.github.io/ ` |
211236| Project| ` https://<username>.github.io/project/ ` |
212237
238+ #### 结束工作
239+
240+ 无论你选择了哪种方式部署网站到 GitHub Pages, 请开启 ` HTTPS ` 功能。具体细节参考官方说明:[ Configuring a publishing source for your GitHub Pages site] ( https://help.github.com/en/github/working-with-github-pages/securing-your-github-pages-site-with-https ) 。
213241
214242### 文档
215243
216- 更多细节及更佳的阅读体验 ,请参阅 [ 线上教程] ( https://chirpy.cotes.info/categories/tutorial/ ) 。 与此同时,[ Wiki] ( https://github.com/cotes2020/jekyll-theme-chirpy/wiki ) 也有一份教程的拷贝。
244+ 若想要更多细节以及更佳的阅读体验 ,请参阅 [ 线上教程] ( https://chirpy.cotes.info/categories/tutorial/ ) 。 与此同时,[ Wiki] ( https://github.com/cotes2020/jekyll-theme-chirpy/wiki ) 也有一份教程的拷贝。
217245
218246
219247## 参与贡献
220248
221- 三人行必有我师,欢迎提报告 bug, 帮助改进代码质量,或者提交新功能。具体操作规则请参考[ 此文 ] ( .github/CONTRIBUTING.md ) ,谢谢🙏。
249+ 三人行必有我师,欢迎提报告 bug, 帮助改进代码质量,或者提交新功能。具体操作规则请参考 [ 贡献指南 ] ( ../. github/CONTRIBUTING.md ) ,谢谢 🙏。
222250
223251## 感谢
224252
225253这个主题的开发主要基于 [ Jekyll] ( https://jekyllrb.com/ ) 生态、[ Bootstrap] ( https://getbootstrap.com/ ) 、[ Font Awesome] ( https://fontawesome.com/ ) 和其他一些出色的工具 (相关文件中可以找到这些工具的版权信息).
226254
227- :tada : 感谢所有参与代码贡献的小伙伴, 他们的 GayHub ID 在这个[ 列表] ( https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors ) 。 另外, 提交过 issues(或者未被合并 PR)的高富帅和白富美也不会被遗忘,他/她们帮助报告 bug、分享新点子或者启发了我写出更通俗易懂的文档。
228-
255+ :tada : 感谢所有参与代码贡献的小伙伴, 他们的 GayHub ID 在这个[ 列表] ( https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors ) 。 另外, 提交过 issues(或者未被合并 PR) 的高富帅和白富美也不会被遗忘,他/她们帮助报告 bug、分享新点子或者启发了我写出更通俗易懂的文档。
229256
230257
231258## 赞助
0 commit comments