如何使用jekyll编写项目文档？

Question

我正在为我的项目撰写文档。我在python中完成了我的项目。但我选择jekyll写下文档。但我没有找到任何有用的文档。我身边还有许多基本问题。比如如何在jekyll中生成模板等。伙计们请建议我任何帮助完整文档或使用jkeyll分享您对文档的想法。

Answer 1

杰基尔非常注重博客。它可以用于生成静态html页面，但它不适合记录软件项目（除非您打算用博客记录它）。

如果您的项目是在github上托管的，那么使用github的wiki可能会更好，现在它已经相当先进了。

如果你仍想自动生成文档，那里有更好的解决方案 - pydoc就是其中之一，但还有其他的，比如Sphinx，或者最新的到来，Dexy。

Answer 2

现在2014年有一些模板，我正在看

• http://bruth.github.io/jekyll-docs-template/ 例如http://modeltree.harvest.io/ref/lookup-syntax.html
• https://github.com/clojurewerkz/docslate 例如http://clojuremongodb.info/ http://blog.clojurewerkz.org/blog/2013/06/15/how-we-document-our-projects-with-clojurewerkz-docslate/
• https://github.com/untyped/jekyll-docs 例子?? https://mynaweb.com/help/quick-start

2015年增加：

• https://github.com/tomjohnson1492/jekyll-doc来自Tom的回答。

我认为应该有其他人，但不知道。

Answer 3

我正在为这里的技术文档开发一个jekyll主题：https://github.com/tomjohnson1492/documentation-theme-jekyll。