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

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.

我正在为我的项目写一份文件。我已经用python完成了我的项目。但是我选择杰基尔来写文档。但我没有找到任何有用的文档。有很多基本的问题仍在我身边。例如如何在jekyll中生成模板等等。请各位建议我任何帮助完整的文档或分享您的想法关于使用jkeyll文档。

3 个解决方案

#1

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).

哲基尔很blog-oriented。它可以用来生成静态的html页面，但是它并不适合记录软件项目(除非您打算用blog来记录)。

If your project is hosted on github, you will probably be better off by using github's wiki, which is fairly advanced now.

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

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.

如果您仍然希望自动生成文档，那么有更好的解决方案——pydoc是一个，但是还有其他的，比如Sphinx，或者最新的到达，Dexy。

#2

Now in 2014 there are some templates, I'm looking at

现在在2014年有一些模板

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

2015 adding:

2015年加入:

• https://github.com/tomjohnson1492/jekyll-doc from the answer of from Tom.
• 来自汤姆的回答:https://github.com/tomjohnson1492/jekyll-doc。

I think there should be others, but don't know.

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

#3

I'm developing a jekyll theme for tech docs here: https://github.com/tomjohnson1492/documentation-theme-jekyll.

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