English | 繁體中文
JekyllCN
Forked from Jekyll.
公告
由于官方文档更新,现在中文文档落后于官方文档,欢迎参与贡献翻译。
注意:中文排版遵循这个规范:写给大家看的中文排版指南。暂时放弃了翻译 contributing 和 history,因为他们是脚本生成的。
如何贡献翻译
- 新建一个 issue,说明要贡献哪篇文档(可以是落后于官方版本的中文文档,也可以是还没有翻译的文档),注意翻译之前先看看 issues 里面有没有人已经认领了
- fork 之后,修改
/site/_docs/
中的对应文档进行翻译,并在本地预览,如果不知道如何在本地启动,可以参考如何在本地启动 - 注意在 Front Matter 中将自己加入到
translators
字段,若无此字段,则添加一个 - 注意在 Front Matter 中更新
update_date
,若无此字段,则添加一个 - 若要修改 css,请修改
/site/_sass/_jekyllcn.scss
,新增的 css 以.jekyllcn-
开头,尽量避免破坏 jekyll 的文件 - 提交一个 pull-request,等待审核
如何在本地启动
- 安装 bundle
- 执行
bundle install
- 执行
bundle exec rake site:preview
参考 contributing。
如何发布到 jekyllcn.com
使用 Travis CI 自动发布:https://travis-ci.org/xcatliu/jekyllcn
如何同步最新的 Jekyllrb
git remote add jekyllrb [email protected]:jekyll/jekyll.git
git fetch jekyllrb master
git merge jekyllrb/master
# 解决冲突
项目进度
项目进度汇总
基础建设
- 跟进官方网站版本 (2016-05-10)
- 首页中文适配 (2016-04-20)
- 页脚加上贡献翻译链接
- 导航加上贡献翻译链接
- 每篇文档加上贡献翻译链接
- 加上 ga
- 加上适配 jekyllcn 的 css
- 加上如何贡献翻译的文档
- 加上如何本地启动的文档
- 加上项目进度的文档
- header 中文适配
- 上一节下一节中文适配
- 右侧表头中文适配
- head 中文适配
- 每篇文文档加上原文链接
- 在 header 中加入贡献翻译链接
- 每篇文档加上翻译贡献者
- 在 header 中底色代表项目进度
- 使用 Travis CI 自动发布