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

Question

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

Answer 1

现在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年增加:

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

我认为应该有其他人,但不知道.

Answer 2

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

Answer 3

Jekyll 非常注重博客。它可用于生成静态 html 页面，但对于记录软件项目来说并不理想（除非您打算用博客来记录它）。

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

如果您仍然想自动生成文档，那么有更好的解决方案 - pydoc就是其中之一，但还有其他解决方案，例如Sphinx或最新推出的Dexy。