كيفية استخدام Jekyll لكتابة وثائق المشروع؟

Question

أنا أكتب وثائق لمشروعي. لقد فعلت مشروعي في بيثون. لكني اخترت جيكل لكتابة الوثائق. لكنني لم أجد أي وثائق مفيدة. هناك الكثير من الأسئلة الأساسية التي لا تزال تتحرك حولي. مثل كيفية إنشاء قالب في jekyll وما إلى ذلك ، يرجى اقتراح أي مساعدة في الوثائق الكاملة أو مشاركة فكرتك على الوثائق باستخدام jkeyll.

Answer 1

Jekyll موجهة للغاية. يمكن استخدامه لإنشاء صفحات HTML ثابتة ، ولكنه ليس مثاليًا لتوثيق مشروع برنامج (إلا إذا كنت تنوي توثيقه بمدونة).

إذا تم استضافة مشروعك على Github ، فمن المحتمل أن تكون أفضل من خلال استخدام WiThub's Wiki ، وهو متقدم إلى حد ما الآن.

إذا كنت لا تزال ترغب في إنشاء وثائق تلقائيًا ، فهناك حلول أفضل هناك - Pydoc هو واحد ، ولكن هناك آخرون ، مثل أبو الهول, أو أحدث وصول ، ديكسي.

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 من إجابة توم.

أعتقد أنه يجب أن يكون هناك آخرين ، لكن لا أعرف.

Answer 3

أقوم بتطوير موضوع Jekyll لمستندات التكنولوجيا هنا: https://github.com/tomjohnson1492/documentation-theme-jekyll.