وتوجه Markdoc نحو إدارة الوثائق التقنية، ولكن يمكن استخدامها لمجموعة من الأغراض. Markdoc ديها عدد قليل من نقاط البيع ملحوظة:
* مصنوعة الويكي تماما حتى من ملفات مشفرة، لذلك يمكنك وضعها بسهولة في ظل التحكم في الإصدار.
* الويكي تجميع في الدلائل HTML بذاتها، والتي يمكن أن تكون موزعة على النحو كتل القطران أو خدم من قبل خادم HTTP.
* هل يمكن أن تشمل اختياريا وسائل الاعلام ثابتة والتي سوف يتم تجميعها في دليل HTML جنبا إلى جنب مع جميع صفحاتك المقدمة.
* Markdoc يأتي مع كامل وظيفية نقية بيثون WSGI تطبيق وHTTP الخادم لتخدم ما يصل الويكي المترجمة.
* يمكنك تقديم الويكي الخاص بك مع مجموعة متنوعة من ملحقات تخفيض السعر، مثل تسليط الضوء على أساس Pygments رمز، جملة موسع للقوائم تعريف الجيل TOC، وهلم جرا.
* يمكنك تخصيص تماما كيف يتم تقديم الويكي الخاص بك عن طريق تحرير قوالب Jinja2 تستخدم لتحويل تخفيض السعر ليصبح مثل وثائق HTML كامل.
بداية سريعة
التركيب:
#! / بن / باش
الزئبق استنساخ سه: //hg@bitbucket.org/zacharyvoase/markdoc
مؤتمر نزع السلاح markdoc /
PIP تثبيت متطلبات -r
بيثون setup.py تثبيت
جعل يكي
#! / بن / باش
markdoc الحرف الأول بلدي ويكي
مؤتمر نزع السلاح بلدي ويكي /
همة ويكي / somefile.md
# ... إرسال بعض الوثائق ...
markdoc بناء
markdoc خدمة
# .. HTTP مفتوحة: // المضيف المحلي: 8008 / في مستعرض ...
تصميم
الويكي Markdoc لديها تخطيط الافتراضية التالية:
WIKI_ROOT /
| - هتمل /
| - .templates /
| - .TMP /
| - ثابت /
| - ويكي /
`- markdoc.yaml
وهتمل / و.TMP / ينبغي استبعاد الدلائل من أي VCS، لأنها تحتوي على الملفات المؤقتة.
راجع وثائق تخطيط في وثيقة / ويكي / layout.md لمزيد من المعلومات حول أدوار مختلف الدلائل
المتطلبات:.
بيثون
بذرة
رسينك
لم يتم العثور على التعليقات