.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 en/i18n.yml home: Home туура келет (мында 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 өзгөртүп, md каталогунда i18n.site кайра иштетип, андан кийин башкы бетте өзгөрүүлөрдү көрүү үчүн иштеп чыгууну алдын ала көрүү URL дарегине баш багыңыз.

use: Blog Блог Шаблондору

Блогдун шаблону макалалардын тизмесин (аталдар жана тезистер) жарыялоо убактысынын тартибинде көрсөтөт.

→ Конфигурацияны билүү үчүн бул жерди басыңыз

use: Doc Файл Документинин Калыптары

Конфигурация файлында:

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

Калыптарды көрсөтүү үчүн Doc колдонууну көрсөтөт.

Doc үлгүсү бир же бир нече долбоорлор үчүн документ схемаларын түзүү үчүн бир нече MarkDown бириктирүүнү колдойт.

Бир Нече Долбоорлор Жана Бир Нече Файлдар

i18n:doc .i18n/conf.yml конфигурациясы - бул көп долбоордун көп файлды көрсөтүү режими.

Бул жерде, 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: Түп жолу конфигурацияланбаса, веб-сайттын башкы бетине киргенде, ал автоматтык түрдө nav: конфигурациясынын астындагы биринчи URL'ге кайра жазылат. Бул дизайн каталогдор аркылуу долбоордук документтерди, блогдорду жана башка мазмунду жакшыраак айырмалоо үчүн. Башкы бет катары бир файлды жана бир баракты колдонуу сунушталат.

[!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

Деңгээлдерди Көрсөтүү Үчүн Чегинүүнү Колдонуңуз

Жогорудагы en/blog/TOC биринчи катарындагы README.md төмөнкү сүрөттөгү i18n.site туура келет, бул долбоордун аталышы.

Кийинки эки сап төмөндөгү скриншотто көрсөтүлгөндөй.

news/README.md News туура келет, news/begin.md Our Product is Online ! туура келет

TOC файлдары контурдун иерархиялык байланышын көрсөтүү үчүн чегинген, көп деңгээлдеги чегинүүнү жана # менен башталган сап комментарийлерин колдойт.

Ата-Энелик Деңгээл Мазмунду Эмес, Аталышты Гана Жазат.

Чектөөнүн бир нече деңгээли болгондо, аталык деңгээл мазмунду эмес, аталышты гана жазат. Болбосо, типография бузулуп калат.

Project README.md

Мазмун en/demo2/README.md сыяктуу 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 барак көрсөтүлөт.