.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 را اضافه یا حذف نکنید.

`use: Toc` الگوی سند تکی با طرح کلی

: nav

  - i18n: home
    use: Toc
    url: /

use: Toc به معنای رندر کردن با استفاده از یک الگوی Toc است که رندر کردن یک الگوی Markdown است.

TOC مخفف Table of Contents است. هنگامی که این الگو رندر می شود، طرح کلی این فایل Markdown در نوار کناری نمایش داده می شود.

url: نشان دهنده مسیر فایل Markdown است ( / مربوط به دایرکتوری ریشه /README.md است، این نام فایل به یک پیشوند بزرگ و یک پسوند کوچک نیاز دارد).

`use: Md` بدون طرح کلی

قالب Md و قالب Toc یکسان هستند و هر دو برای ارائه یک فایل Markdown استفاده می شوند. اما الگوی Md طرح کلی را در نوار کناری نشان نمی دهد.

می توانید use: Toc در پیکربندی بالا به use: Md تغییر دهید، i18n.site دوباره در فهرست md اجرا کنید و سپس از URL پیش نمایش توسعه بازدید کنید تا تغییرات را در صفحه اصلی مشاهده کنید.

`use: Blog` الگوهای وبلاگ

قالب وبلاگ فهرستی از مقالات (عناوین و چکیده ها) را به ترتیب زمان انتشار نمایش می دهد.

→ برای اطلاع از پیکربندی خاص اینجا را کلیک کنید

`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 وجود داشته باشد.

برای پارامترهای بالا، فایل فهرست فهرست مربوطه به صورت زیر است:

en/demo1/TOC
en/demo2/TOC

چند فایل پروژه واحد

اگر فقط یک پروژه دارید، می توانید آن را به صورت زیر پیکربندی کنید.

  - 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 فایل باید در دایرکتوری زبان مبدأ قرار گیرد.

به عنوان مثال، اگر زبان مبدأ چینی است، 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 نمایش داده می شود.