وredtape هو مولد ثيقة تركيزا يستخدم جيثب تخفيض السعر النكهة لتوليد بسيطة، وثائق HTML جذابة. أنه يدمج تلقائيا مع twitter التمهيد وملامح بسيطة، والتصميم الجذاب. مستوحاة redtape التي كتبها د، ولكن يحاول أن يكون واجهة بسيطة في حين أن المستخدمين لا يزال يسمح لأسلوب ومراقبة الوثائق إنتاجها إلى درجة عالية من التخصيص.
تركيب
إذا كنت على نظام تشغيل لينوكس أو OSX، يمكنك استخدام نقطة تثبيت:
> PIP تثبيت redtape
الذي سيتم تثبيت redtape وتبعياته.
استعمال
للاستخدام، المدى RT على وثيقة أو دليل كامل للوثائق. اذا تم تشغيلها على دليل، وغ إنشاء ملفات HTML لكل ملف تخفيض السعر (.md، .mdown، أو ملحقات .markdown):
> غ mydocument.md
> توثيق غ /
ممتلكات
افتراضيا، يفترض غ قمت بإعداد موقع لخدمة الملفات من التي لديها أصول RT الروابط في هذه الوثائق. التخطيط هو بالضبط نفس الدليل الأصول في مستودع redtape: / الأصول / {المغلق، IMG، شبيبة} / .. لكل الأصول التي سوف تستخدم. إذا كنت ترغب في استخدام الأصول الافتراضية redtape، يمكنك بسهولة إنشاء دليل الأصول مناسبة في الدليل الحالي عن طريق تشغيل:
> غ --create الأصول
إذا كنت تقوم بتشغيل في وضع وثيقة واحدة أو لا ترغب في إقامة الدليل الأصول على المضيف النهائي للمستندات HTML الخاص بك، يمكنك أن تقول redtape لتضمين كل الأصول المستخدمة في مستند باستخدام --embed:
> غ --embed mydocument.md
جافا سكريبت
افتراضيا، redtape لا يتطلب أي جافا سكريبت لتشغيل، ولن تضمين أي في وضع --embed. إذا تم تحديد الخيار --prettify، سيتم استخدام مكتبة تجميل جوجل لتسليط الضوء المصدر بدلا من pygments، وإذا --prettify وكلاهما يستخدم --embed، وسوف تكون جزءا لا يتجزأ تلقائيا.
Redtape هو أيضا مناسبة للمظاهرات جافا سكريبت صفحة واحدة بسيطة، وإذا تم تمكين --use-شبيبة، وسوف تشمل redtape مسج والمكتبات جافا سكريبت التمهيد ل.
الناتج تخصيص
تخصيص الناتج من السهل القيام به في مجموعة متنوعة من الطرق. إلى جانب تغيير CSS الأصول للمستندات غير مضمن، يمكنك أيضا إضافة الرؤوس والتذييلات أو حتى استخدام قوالب المستند المخصصة على أساس القالب الافتراضي redtape ل.
الرؤوس والتذييلات
إذا كان لديك رأس المستند مخصصة أو تذييل الصفحة التي تريد إضافتها إلى المستندات الخاصة بك، يمكنك إما إضافة header.html وfooter.html الوثائق إلى الدليل الأساسي الذي يتم تقديم أو مجموعة مسارات الافتراضي لاستخدامها في التكوين كما رأس وتذييل الصفحة. افتراضيا، سيتم وضع هذه في أعلى وأسفل المستند، على التوالي.
وهناك مجموعة عينة من الوثائق يمكن أن يكون:
> ليرة سورية mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
سوف يجعل mydocs مع mydocs RT استخدام رأس وتذييل لكل وثيقة في الدليل.
قوالب مخصصة
إذا كان لديك متطلبات محددة للغاية، يمكنك كتابة قالب المستند الخاص بك ولها السيطرة الكاملة على الإخراج. Redtape يستخدم محرك النموذجيه jinja2، وهو نظام النموذجيه المستخدمة على نطاق واسع على غرار جانغو القوالب. تشغيل redtape مع حجة --context للحصول على فكرة موجزة عن ما هي المتغيرات المتاحة للقالب.
يمكنك أيضا ترث من basic.jinja، الذي هو اسم القالب الافتراضي redtape ل. ويعرف هذا القالب مبنيين والرأس والجسم، والتي من شأنها أن تسمح لك لصياغة متميزة حين ثيقة الجسم، على سبيل المثال، والإبقاء على CSS الأساسي وظائف JavaScript من redtape. وتجاوز كل من أترككم مع معيار HTML5 هيكل الوثيقة.
يمكنك تحديد قالب مخصص للاستخدام مع -t، --template أو وضعها في الدليل المستند كما custom.html أو custom.jinja
المتطلبات:.
بيثون
لم يتم العثور على التعليقات