.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

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 وەک ڕێڕەوی ڕەگی / ناکات nav:__ __conf.yml 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 ی پێشوەختە پیشان دەدرێت.