开发工具总结（14）之Jekyll制作文档并发布到GitHub
版权声明：本文为博主原创文章，未经博主允许不得转载。https://cloud.tencent.com/developer/article/1459089
转载请标明出处：
https://cloud.tencent.com/developer/article/1459089
本文出自 AWeiLoveAndroid的博客
在线文档制作工具系列篇 ↓：
- 第一篇：GitBook制作文档并发布到GitHub
- 第二篇：Hexo制作文档并发布到GitHub
- 第三篇：Jekyll制作文档并发布到GitHub
- 第四篇：Vuepress制作文档并发布到GitHub
Jekyll做博客有点复杂，如果说小白，不推荐轻易上手，出现的问题也是很多的，这里仅作为学习和交流。如果你对前端技术很感兴趣，或者你有前端开发经验，那么你开源随意定制化Jekyll模板，相对来说处理出现的错误问题也会比一般人及时一些。由于我对这个还不是很熟悉，希望各位大佬指教。这里出现的错误，欢迎大家指点。本文简单讲接一下Jekyll如何制作文档。
一、制作个人博客步骤
第一步:打开Jekyll主题官网 JekyllThemes http://jekyllthemes.org/ 下载一个自己喜欢的模板。
第二步:把下载好的模板上传到自己的Github仓库中。
第三步:在_posts文件夹中放入自己写好的博客,文件名必须是日期-标题名,例如:2019-01-01-我的第一篇博客。
第四步:上传博客到Github中即可访问自己的博客。
二、Jekyll目录和文件结构介绍
文件 / 目录 | 描述 |
|---|---|
_config.yml | 保存配置数据。很多配置选项都会直接从命令行中进行设置，但是如果你把那些配置写在这儿，你就不用非要去记住那些命令了。 |
_drafts | drafts 是未发布的文章。这些文件的格式中都没有 title.MARKUP 数据。学习如何使用 drafts. |
_includes | 你可以加载这些包含部分到你的布局或者文章中以方便重用。可以用这个标签 {% include file.ext %} 来把文件 _includes/file.ext 包含进来。 |
_layouts | layouts 是包裹在文章外部的模板。布局可以在 YAML 头信息中根据不同文章进行选择。 这将在下一个部分进行介绍。标签 {{ content }} 可以将content插入页面中。 |
_posts | 这里放的就是你的文章了。文件格式很重要，必须要符合: YEAR-MONTH-DAY-title.MARKUP。 The permalinks 可以在文章中自己定制，但是数据和标记语言都是根据文件名来确定的。 |
_data | 放一些其他配置文件,必须是.yml或者.yaml格式的,比如有一个文件叫members.yml,如果想引用这个文件里的内容就通过site.data.membres来引用 |
_site | 一旦 Jekyll 完成转换，就会将生成的页面放在这里（默认）。最好将这个目录放进你的 .gitignore 文件中。 |
三、相关语法官网
- Liquid语法: https://help.shopify.com/themes/liquid
- Jekyll中文网: http://jekyll.com.cn/
- 在本地预览博客效果: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/ 需要安装Ruby
四、比较好的Jekyll模板
腾讯云开发者
