الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

موضوع كتاب هوغو - شوكة ساخنة

موضوع توثيق هوغو بسيط مثل الكتاب العادي

لقطة الشاشة

سمات

  • تصميم بسيط نظيف

  • ودية المحمول

  • قابلة للتخصيص

  • مصممة بحيث لا تتداخل مع التخطيطات الأخرى

  • التكوين الأولي صفر

متطلبات

  • هوغو 0.43 أو أعلى

  • نسخة موسعة من Hugo، اقرأ المزيد هنا

تثبيت

انتقل إلى جذر موقع Hugo الخاص بك وقم بتشغيله: 

git submodule add https://github.com/alex-shpak/hugo-book themes/book

ثم قم بتشغيل Hugo (أو قم بتعيين theme: book في ملف التكوين) 

hugo server --theme book

قائمة طعام

قائمة شجرة الملفات (افتراضية)

افتراضيًا، سيعرض السمة الصفحات من قسم content/docs كقائمة في بنية شجرة.
يمكنك ضبط title weight في مقدمة الصفحات لضبط الترتيب والعناوين في القائمة.

قائمة حزمة الأوراق

يمكنك أيضًا استخدام حزمة الأوراق ومحتوى index.md الخاص بها كقائمة.

نظرًا لأن لديك بنية الملف هذه 

├── content
│   ├── docs
│   │   ├── page-one.md
│   │   └── page-two.md
│   └── posts
│       ├── post-one.md
│       └── post-two.md

قم بإنشاء content/docs/menu/index.md بالمحتوى

 --- بلا رأس: صحيح---- [مثال كتاب](/docs/)
  - [الصفحة الأولى](/docs/page-one)
  - [الصفحة الثانية](/docs/page-two)- [المدونة](/posts)

وقم بتمكينه من خلال إعدادات BookMenuBundle: /docs/menu في تكوين الموقع

  • القائمة سبيل المثال

  • مثال لملف التكوين

  • حزم الأوراق

مدونة

مدونة بسيطة مدعومة posts القسم

إعدادات

تكوين الموقع

هناك عدد قليل من خيارات التكوين التي يمكنك إضافتها إلى ملف config.yml|json|toml

 # (اختياري) اضبط هذا على "صحيح" إذا كنت تستخدم الأحرف الكبيرة في أسماء الملفاتdisablePathToLower: true# (اختياري) اضبط هذا على "صحيح" لتمكين تاريخ "آخر تعديل بواسطة" ومعلومات git Author# على صفحات النوع "doc".enableGitInfo: true# (تحذيرات) الموضوع مخصص لاستخدام التوثيق، لأنه لا يعرض التصنيف.# يمكنك إخفاء التحذير ذي الصلة باستخدام التكوين الموجود أدناهdisableKinds: ["taxonomy"، "taxonomyTerm"]params: # (اختياري، افتراضي صحيح) إظهار أو إخفاء جدول المحتويات عالميًا
  # يمكنك أيضًا تحديد هذه المعلمة لكل صفحة في المادة الأمامية
  BookShowToC: صحيح

  # (اختياري، افتراضيًا لا شيء) قم بتعيين حزمة الأوراق لعرضها كقائمة جانبية
  # عندما لا يتم تحديد بنية الملف والأوزان
  حزمة BookMenuBundle: /menu

  # (اختياري، المستندات الافتراضية) حدد قسم المحتوى لعرضه كقائمة
  # يمكنك أيضًا تعيين القيمة على "*" لعرض جميع الأقسام في القائمة
  قسم الكتب: المستندات

  # هذه القيمة مكررة من $link-color لتسليط الضوء على الرابط النشط في وضع حزمة القائمة
  # BookMenuBundleActiveLinkColor: #004ed0

  # تضمين البرامج النصية JS في الصفحات. معطل افتراضيا.
  # - احتفظ بالقائمة الجانبية في نفس موضع التمرير أثناء التنقل
  BookEnableJS: صحيح

  # تعيين موقع مستودع المصدر.
  # يُستخدم لروابط "آخر تعديل" و"تحرير هذه الصفحة".
  بوك ريبو: https://github.com/alex-shpak/hugo-book

  # تمكين روابط "تحرير هذه الصفحة" لنوع الصفحة "doc".
  # معطل افتراضيا. قم بإلغاء التعليق للتمكين. يتطلب معلمة "BookRepo".
  # يجب أن يشير المسار إلى دليل "المحتوى" الخاص بالريبو.
  BookEditPath: تحرير/رئيس/exampleSite/content

تكوين الصفحة

يمكنك تحديد معلمات إضافية لكل صفحة في المادة الأمامية

 ---# اضبط النوع على "docs" إذا كنت تريد عرض الصفحة خارج القسم الذي تم تكوينه أو إذا قمت بعرض قسم آخر غير "docs"type: docs# اضبط وزن الصفحة لإعادة ترتيب العناصر في قائمة شجرة الملفات (إذا كان BookMenuBundle غير مضبوط)الوزن: 10# (اختياري) اضبط لوضع علامة على الصفحة كقسم مسطح في قائمة شجرة الملفات (إذا لم يتم تعيين BookMenuBundle)bookFlatSection: true# (اختياري) اضبط لإخفاء جدول المحتويات، يتجاوز valuebookShowToC العالمي: خطأ ---

جزئيات

هناك عدد قليل من الأجزاء الفارغة التي يمكنك تجاوزها في layouts/partials/

جزئي التنسيب
layouts/partials/docs/inject/head.html قبل إغلاق علامة <head>
layouts/partials/docs/inject/body.html قبل إغلاق العلامة <body>
layouts/partials/docs/inject/menu-before.html في بداية كتلة القائمة <nav>
layouts/partials/docs/inject/menu-after.html في نهاية كتلة القائمة <nav>

المساهمة

المساهمات مرحب بها وسوف أقوم بمراجعة طلبات السحب والنظر فيها.
الأهداف الأساسية هي:

  • اجعل الأمر بسيطًا

  • احتفظ بالحد الأدنى (أو الصفر) من التكوين الافتراضي

  • تجنب التداخل مع التخطيطات المحددة من قبل المستخدم

لا تتردد في فتح المشكلة إذا فقدت بعض خيارات التكوين أو التخصيص.

رخصة

معهد ماساتشوستس للتكنولوجيا

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل