如何使用jekyll编写项目文档？
我正在为我的项目编写文档。我已经用 python 完成了我的项目。但我选择 jekyll 来写下文档。但我没有找到任何有用的文档。有很多基本问题仍然围绕着我。比如如何在 jekyll 中生成模板等。请大家向我推荐任何有帮助的完整文档，或者分享您对使用 jkeyll 的文档的想法。
I am writting a documentation for my project. I have done my project in python. But I choose jekyll to write down the documentation. But I didn't found any helpful documentation. There is lots of basic question still moving around me. Such as how to generate template in jekyll etc. Guys please suggest me any help full documentation or share your idea on documentation using jkeyll.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（4）
现在在 2014 年有一些模板，我正在查看
2015 添加：
我想应该还有其他人，但不知道。
Now in 2014 there are some templates, I'm looking at
2015 adding:
I think there should be others, but don't know.
我正在为技术文档开发一个 jekyll 主题： https://github.com/tomjohnson1492/documentation-theme-jekyll< /a>.
I'm developing a jekyll theme for tech docs here: https://github.com/tomjohnson1492/documentation-theme-jekyll.
Jekyll 非常注重博客。它可用于生成静态 html 页面，但对于记录软件项目来说并不理想（除非您打算用博客来记录它）。
如果您的项目托管在 github 上，那么使用 github 的 wiki 可能会更好，它现在已经相当先进了。
如果您仍然想自动生成文档，还有更好的解决方案 - pydoc 就是其中之一，但还有其他一些，例如 Sphinx，或最新推出的 Dexy。
Jekyll is very blog-oriented. It can be used to generate static html pages, but it isn't ideal for documenting a software project (unless you intend to document it with a blog).
If your project is hosted on github, you will probably be better off by using github's wiki, which is fairly advanced now.
If you still want to generate documentation automatically, there are better solutions out there - pydoc is one, but there are others, like Sphinx, or the newest arrival, Dexy.
可以考虑使用mkdocs，这是一个使用python开发的静态站点生成器，主要用于编写项目文档。
You can consider using mkdocs, a static site generator developed using python, primarily for writing project documentations.