Как использовать jekyll для написания документации по проекту?

Ответ 1

Jekyll очень ориентирован на блог. Он может использоваться для создания статических html-страниц, но он не идеален для документирования программного проекта (если вы не намерены документировать его в блоге).

Если ваш проект размещен на github, вам, вероятно, будет лучше, используя github wiki, который сейчас довольно продвинут.

Если вы все еще хотите автоматически создавать документацию, есть лучшие решения - pydoc - это один, но есть и другие, например Sphinx или новейшее прибытие Dexy.

Ответ 2

Теперь в 2014 году есть несколько шаблонов, я смотрю

• http://bruth.github.io/jekyll-docs-template/
  • example 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 из ответа Тома.

Я думаю, что должны быть другие, но не знаю.

Ответ 3

Я разрабатываю тему jekyll для технических документов здесь: https://github.com/tomjohnson1492/documentation-theme-jekyll.