gumdrop

اللثة

البرنامج النصي لتكوين الصفر لعرض مستندات تخفيضية كصفحات HTML ثابتة

تم تصميم Gumdrop ليكون نصًا سهلاً الاستخدام ، مستقل يمكن أن ينشئ مواقع الويب والوثائق المكتوبة في Markdown. إنه يعمل على تحميل جميع تبعياتها من CDN (بما في ذلك محلل التنسيق) ولا يتطلب أي تكوين أو تهيئة.

تثبيت

لا يتطلب Gumdrop التثبيت ، عليك فقط تحميله في مستند HTML مع علامة script .

 < script src =" https://cdn.jsdelivr.net/npm/gumdrop@4 " > </ script > 

الاستخدام

لإنشاء موقع ويب ثابت مع Markdown ، كل ما تحتاج إليه هو إنشاء قالب HTML ( index.html ) على خادم الملفات الخاص بك وإضافة gumdrop كملف نص خارجي.

 < main > </ main >
< script src =" path/to/gumdrop.js " >

كن على دراية ، أنه يتعين عليك خدمة ملفاتك عبر بروتوكول http / https ، لأن بروتوكول file لا يدعم طلبات الجلب.

يمكن تحميل ملفات Markdown في مجلد pages . يراقب Gumdrop جزء التجزئة لعنوان URL ويحمل ملف Markdown المقابل من مجلد pages . يتم تقديم ملفات Markdown المحلية في عقدة <main> HTML إذا كانت موجودة ، في body خلاف ذلك. الملف الافتراضي الذي يتم تحميله إذا لم يتم تحديد أي ملف هو pages/index.md . لإنشاء رابط لملف آخر في مجلد pages ، ببساطة قم بإنشاء رابط مع اسمه المسبق بواسطة #!/ .

 [ Link to about.md ] ( #!/about )

يمكن تحميل الموارد الثابتة (مثل الصور) من أي مجلد يقدمه خادم الملفات الخاص بك ، والمسارات تتعلق بـ index.html . يمكن وضع صفحات الخطأ لمختلف أخطاء HTTP في مجلد errors . يجب تسمية كل ملف وفقًا لرمز الخطأ HTTP الذي يمثله (مثل errors/404.md ).

يمكن تحديد بيانات إضافية لمستنداتك في المادة الأمامية YAML. يمكنك الوصول إلى هذه البيانات في أي من مستندات Markdown باستخدام قوالب الشارب.

يمكنك أيضًا استخدام ملفات منفصلة لتخزين البيانات وربط ملفات الموارد هذه بمستند في المسألة الأمامية. يمكن لملفات الموارد استخدام YAML (افتراضي) أو JSON أو THERMDOWN TYPE. أي قيمة في المسألة الأمامية لمستند تم شرحها بنوع !file تعتبر مورد ملف. مسارات الملفات التي تبدأ مع قيادة / تتعلق بـ index.html ، إذا كان المفقود / المفقود ، فمن المفترض أن يكون مجلد data موقع المورد. إذا لم يتم إعطاء نوع ملف (تمديد) ، فسيتم افتراض امتداد .yaml . بالنسبة لملفات Resource .md ستكون القيمة التي تم إرجاعها هي المستند الذي تم تقديمه.

 # data/todo.yaml

todos :
  - title : First todo
    text : Complete your first assignment
    completed : true
  - title : YAML
    text : Learn more about YAML Front Matters
    completed : false 

 ---
todos: !file todo.yaml
---
{{#todos}}
- **{{title}}**: {{text}} {{#completed}}(✔){{/completed}}
{{/todos}}

سمات

• تكوين الصفر ، لا حاجة إلى تهيئة
• لا يوجد رمز جانبي لخادم ، فقط يحتاج إلى خادم ملفات ثابت
• لا توجد خطوة بناء/توليد ، إنها مجرد ملفات تخدمها
• ميزات تخفيض إضافية عبر Outsamark
• التنقل عن طريق جلب طلبات
• التخزين المؤقت المحلي للملفات لأوقات تحميل أسرع
• بيانات إضافية في المسألة الأمامية وملفات البيانات التي يتم التعامل معها بواسطة قوالب الشارب
• صفحات الخطأ لمختلف رموز خطأ HTTP (404 ، 500 ، 300)

بناء جملة تسليط الضوء

تتم معالجة كتل التعليمات البرمجية المسيجة تلقائيًا بواسطة prism.js. اللغات المدعومة هي اللغات الافتراضية في حزمة prism.js. لتمييز بناء الجملة ، يجب عليك تضمين نمط Prism.js في index.html الخاص بك.

 < link rel =" stylesheet " href =" https://cdn.jsdelivr.net/npm/prismjs@1/themes/prism.css " />

باستخدام صفحات جيثب

يمكنك استخدام Gumdrop مع صفحات github لأنه يمكن أن يكون بمثابة خادم ملفات ثابت. لمنع صفحات github من محاولة تحويل موقعك باستخدام jekyll إضافة ملف .nojekyll فارغ إلى جذر موقعك.

المساهمة

جميع الأفكار والتوصيات وتقارير الأخطاء وطلبات السحب مرحب بها. ؟