.i18n/conf.yml

ملف التكوين لـ i18n.site هو .i18n/conf.yml والمحتوى كما يلي :

i18n:
  fromTo:
    en:
upload:
  ext:
    - md
nav:
  - i18n: home
    use: Toc
    url: /
  - i18n: doc
    menu: NB demo1,demo2
    use: Doc
  - i18n: blog
    use: Blog
addon:
  - i18n.addon/toc

من بينها، عنصر التكوين upload إلى ext: يعني أنه سيتم تحميل .md فقط عند النشر.

التنقل العلوي

nav: خيارات تكوين، تتوافق مع قائمة التنقل الموجودة أعلى الصفحة الرئيسية.

من بينها، i18n: home يتوافق مع home: Home في en/i18n.yml (حيث en هي اللغة المصدر لترجمة المشروع).

محتوى en/i18n.yml هو النص المعروض في قائمة التنقل، والذي سيتم ترجمته وفقًا لـ fromTo في التكوين، على سبيل المثال، ترجمته إلى zh/i18n.yml .

بعد الانتهاء من الترجمة، يمكنك تعديل قيمة الترجمة yml ، ولكن لا تضيف أو تحذف مفتاح الترجمة yml .

0قالب وثيقة use: Toc مع المخطط التفصيلي

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc يعني العرض باستخدام قالب Toc ، وهو ما يعني عرض قالب Markdown واحد.

TOC هو اختصار لـ Table of Contents عندما يتم عرض هذا القالب، سيتم عرض المخطط التفصيلي لملف Markdown هذا في الشريط الجانبي.

يمثل url: مسار الملف Markdown ( / يتوافق مع الدليل الجذر /README.md ، ويتطلب اسم الملف هذا بادئة كبيرة ولاحقة صغيرة).

0قالب مستند use: Md بدون مخطط تفصيلي

القالب Md والقالب Toc متماثلان ويستخدمان لعرض ملف Markdown واحد. لكن القالب Md لا يُظهر المخطط التفصيلي في الشريط الجانبي.

يمكنك تعديل use: Toc في التكوين أعلاه إلى use: Md ، وتشغيل i18n.site في الدليل md مرة أخرى، ثم زيارة عنوان URL لمعاينة التطوير لمراقبة التغييرات على الصفحة الرئيسية.

use: Blog قوالب المدونة

يعرض قالب المدونة قائمة بالمقالات (العناوين والملخصات) مرتبة حسب وقت النشر.

→ انقر هنا للتعرف على التكوين المحدد

0 قوالب وثيقة ملف use: Doc

في ملف التكوين:

  - i18n: doc
    menu: NB demo1,demo2
    use: Doc

يشير إلى استخدام Doc لعرض القالب.

يدعم قالب Doc دمج عدة MarkDown لإنشاء مخططات مستندية لمشاريع فردية أو متعددة.

مشاريع متعددة وملفات متعددة

تكوين .i18n/conf.yml في i18n:doc هو وضع عرض متعدد المشاريع متعدد الملفات.

هنا، menu: NB demo1,demo2 يعني استخدام القالب NB لعرض القائمة المنسدلة.

NB ، وهو اختصار للرقم Name Breif ، يعني أن القائمة المنسدلة يمكنها عرض اسم المشروع وشعاره.

NB متبوعًا بالمعلمة demo1,demo2 التي تم تمريرها إليها.

ملاحظة : ** يجب ألا يكون هناك مسافات ** قبل الفاصلة وبعدها , في demo1,demo2 .

بالنسبة للمعلمات المذكورة أعلاه، فإن ملف فهرس الدليل المقابل هو:

مشروع واحد ملفات متعددة

إذا كان لديك مشروع واحد فقط، يمكنك تكوينه على النحو التالي.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] لا يدعم المشروع الفردي الذي يحتوي على ملفات متعددة تكوين url كمسار جذر / إذا conf.yml → nav: لم يتم تكوين مسار جذر، عند الوصول إلى الصفحة الرئيسية لموقع الويب، ستتم إعادة كتابته تلقائيًا إلى عنوان URL الأول ضمن التكوين nav: . يهدف هذا التصميم إلى التمييز بشكل أفضل بين مستندات المشروع والمدونات والمحتويات الأخرى من خلال الدلائل. يوصى باستخدام ملف واحد وصفحة واحدة كصفحة رئيسية.

[!TIP] إذا لم تتم كتابة url ، فسيتم تعيين url افتراضيًا على القيمة i18n تسري هذه القاعدة أيضًا على القوالب الأخرى.

فهرس جدول محتويات TOC

إذا تم تمكين القالب use: Doc في التكوين، فيرجى تمكين المكون الإضافي i18n.addon/toc في .i18n/conf.yml التكوين كما يلي :

addon:
  - i18n.addon/toc

سيقوم i18n.site بتثبيت هذا البرنامج الإضافي وتنفيذه تلقائيًا، وقراءة TOC ملف فهرس الدليل، وإنشاء json مخطط تفصيلي للدليل.

إذا كان مشروعًا واحدًا يحتوي على ملفات متعددة، فإن الدليل الجذر TOC هو الدليل المقابل لـ url: في دليل اللغة المصدر، على سبيل المثال، إذا كانت اللغة المصدر صينية: الملف المقابل لـ url: flashduty هو zh/flashduty/TOC .

إذا كانت هناك مشاريع متعددة وملفات متعددة، فلا داعي لتكوين url: الدليل الجذر لـ TOC هو الدليل المقابل لقيمة i18n .

شرح تفصيلي للمحتوى

en/blog/TOC المحتوى كالتالي :

README.md

news/README.md
  news/begin.md
استخدم المسافة البادئة للإشارة إلى المستويات

README.md في الصف الأول من en/blog/TOC أعلاه يتوافق مع i18n.site في الصورة أدناه، وهو اسم المشروع.

السطرين التاليين كما هو موضح في لقطة الشاشة أدناه.

news/README.md يتوافق مع News ، news/begin.md يتوافق مع Our Product is Online !

يتم وضع مسافة بادئة للملفات TOC للإشارة إلى العلاقة الهرمية للمخطط التفصيلي، ودعم المسافة البادئة متعددة المستويات، وتعليقات الأسطر التي تبدأ بـ # .

المستوى الأصلي يكتب العنوان فقط، وليس المحتوى.

عندما تكون هناك مستويات متعددة من المسافة البادئة، يقوم المستوى الأصلي بكتابة العنوان فقط وليس المحتوى. وإلا، سيتم إفساد الطباعة.

مشروع README.md

يمكن كتابة المحتوى في العنصر README.md ، مثل en/demo2/README.md .

لاحظ أن محتوى هذا الملف لا يُظهر مخططًا تفصيليًا لجدول المحتويات، لذا يوصى بتحديد الطول وكتابة مقدمة قصيرة.

شعار المشروع

يمكنك أن ترى أن Deme Two يحتوي على شعار المشروع الخاص به أسفل القائمة المنسدلة واسم مشروع مخطط الكتالوج Your Project slogan :

وهذا يتوافق مع الصف الأول من en/demo2/README.md :

# Demo Two : Your Project slogan

سيتم اعتبار المحتوى الموجود بعد النقطتين الأولى : من عنوان المستوى الأول للمشروع README.md بمثابة شعار المشروع.

بالنسبة للمستخدمين من الصين واليابان وكوريا، يرجى ملاحظة أنه يجب عليك استخدام النقطتين بنصف العرض : بدلاً من النقطتين بالعرض الكامل.

كيفية نقل جدول المحتويات بكميات كبيرة؟

يجب وضع TOC ملفات في دليل اللغة المصدر.

على سبيل المثال، إذا كانت اللغة المصدر هي الصينية، فإن TOC أعلاه هو zh/blog/TOC .

إذا تم تعديل اللغة المصدر، فستحتاج إلى نقل الملفات TOC الخاصة بلغة معينة في المشروع إلى لغة أخرى.

يمكنك الرجوع إلى الأوامر التالية:

rsync -av --remove-source-files --include='*/' \
--include='TOC' --exclude='*' en/ zh/

يرجى تعديل en/ و zh/ في الأمر أعلاه إلى رمز اللغة الخاص بك.

التحميل الافتراضي بدون مسار التكوين

بالنسبة لمسار معين يتم الوصول إليه، إذا لم يتم تكوين بادئة المسار في nav: ، فسيتم تحميل الملف MarkDown المطابق للمسار افتراضيًا وعرضه باستخدام القالب Md .

على سبيل المثال، إذا تم الوصول إلى /test وتم تكوين nav: بدون بادئة هذا المسار، وكانت لغة التصفح الحالية هي الإنجليزية (الرمز en )، فسيتم تحميل /en/test.md بشكل افتراضي وعرضه باستخدام القالب Md .

إذا كان /en/test.md هذا الملف غير موجود، فسيتم عرض الصفحة الافتراضية 404 .