.i18n/conf.yml

i18n.site uchun konfiguratsiya fayli .i18n/conf.yml va mazmuni quyidagicha :

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

Ular orasida upload dan ext: gacha konfiguratsiya elementi nashr etilganda faqat .md yuklanishini bildiradi.

Yuqori Navigatsiya Navigatsiyasi

Bosh sahifaning yuqori qismidagi navigatsiya menyusiga mos keladigan nav: konfiguratsiya parametrlari.

Ularning orasida i18n: home en/i18n.yml home: Home ga to'g'ri keladi (bu erda en - loyiha tarjimasining manba tili).

en/i18n.yml mazmuni navigatsiya menyusida ko'rsatilgan matn bo'lib, u konfiguratsiyadagi fromTo ga ko'ra tarjima qilinadi, masalan, zh/i18n.yml ga tarjima qilinadi.

Tarjima tugallangandan so'ng siz tarjimaning qiymatini o'zgartirishingiz mumkin yml , lekin tarjima kalitini qo'shmang yoki o'chirmang yml .

use: Toc Hujjat Shablonlari

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc Toc shablon yordamida renderlashni anglatadi, bu esa bitta Markdown shablonni ko'rsatadi.

TOC Table of Contents ning qisqartmasi. Ushbu shablon ko'rsatilganda yon panelda ushbu Markdown faylning konturi ko'rsatiladi.

url: fayl yo'lini ifodalaydi Markdown ( / ildiz katalogiga mos keladi /README.md , bu fayl nomi katta harflar prefiksi va kichik harf qo'shimchasini talab qiladi).

0Konturasiz use: Md Hujjat Shablonlari

Md shablon va Toc shablon bir xil va ikkalasi ham bitta Markdown ta faylni ko'rsatish uchun ishlatiladi. Ammo Md shablon yon paneldagi konturni ko'rsatmaydi.

Siz yuqoridagi konfiguratsiyadagi use: Toc use: Md ga o'zgartirishingiz, md katalogida i18n.site qayta ishga tushirishingiz va keyin bosh sahifadagi o'zgarishlarni kuzatish uchun rivojlanishni oldindan ko'rish URL manziliga tashrif buyurishingiz mumkin.

use: Blog Blog Shablonlari

Blog shabloni maqolalar ro'yxatini (sarlavhalar va tezislar) nashr qilish vaqti bo'yicha ko'rsatadi.

→ Muayyan konfiguratsiya haqida bilish uchun shu yerni bosing

use: Doc Faylli Hujjat Shablonlari

Konfiguratsiya faylida:

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

Shablonni ko'rsatish uchun Doc foydalanishni bildiradi.

Doc shabloni bir yoki bir nechta loyihalar uchun hujjat konturlarini yaratish uchun bir nechta MarkDown birlashtirishni qo'llab-quvvatlaydi.

Bir Nechta Loyihalar Va Bir Nechta Fayllar

.i18n/conf.yml ning i18n:doc konfiguratsiyasi ko'p loyihali ko'p faylni ko'rsatish rejimidir.

Bu erda, menu: NB demo1,demo2 , ochiladigan menyuni ko'rsatish uchun NB shablonidan foydalanishni anglatadi.

Name Breif ning qisqartmasi bo'lgan NB , ochiladigan menyuda loyiha nomi va shiorini ko'rsatishi mumkinligini anglatadi.

NB dan keyin unga uzatilgan demo1,demo2 parametr keladi.

Eslatma : ** demo1,demo2 , oldin va keyin ** bo'sh joy qolmasligi kerak.

Yuqoridagi parametrlar uchun tegishli katalog indeks fayli:

• en/demo1/TOC
• en/demo2/TOC

Bitta Loyiha Bir Nechta Fayllar

Agar sizda faqat bitta loyiha bo'lsa, uni quyidagi tarzda sozlashingiz mumkin.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] Bir nechta faylli bitta loyiha url / ildiz yo'li sifatida sozlashni qo'llab-quvvatlamaydi Agar conf.yml nav: Hech qanday ildiz yo'li sozlanmagan bo'lsa, veb-saytning bosh sahifasiga kirishda u avtomatik ravishda nav: konfiguratsiyasi ostidagi birinchi URL manziliga qayta yoziladi. Ushbu dizayn kataloglar orqali loyiha hujjatlari, bloglar va boshqa kontentni yaxshiroq ajratib ko'rsatishdir. Bosh sahifa sifatida bitta fayl va bitta sahifadan foydalanish tavsiya etiladi.

[!TIP] Agar url yozilmagan bo'lsa, url sukut bo'yicha i18n qiymatiga o'rnatiladi. Bu qoida boshqa andozalar uchun ham kuchga kiradi.

TOC Tarkibi Indeksi

Agar konfiguratsiyada shablon use: Doc yoqilgan bo'lsa, iltimos, i18n.addon/toc -in .i18n/conf.yml plaginini yoqing. Konfiguratsiya quyidagicha :

addon:
  - i18n.addon/toc

i18n.site ushbu plaginni avtomatik ravishda o'rnatadi va ishga tushiradi, TOC katalog indeks faylini o'qiydi va json katalog konturini yaratadi.

Agar u bir nechta faylga ega bo'lgan yagona loyiha bo'lsa, TOC ildiz katalogi manba til katalogidagi url: ga mos keladigan katalogdir, masalan, agar manba tili xitoycha bo'lsa: url: flashduty ga mos keladigan fayl zh/flashduty/TOC ga teng.

Agar u bir nechta loyiha va bir nechta fayl bo'lsa, url: sozlashning hojati yo'q. TOC ning ildiz katalogi i18n qiymatiga mos keladigan katalogdir.

Tarkibni Batafsil Tushuntirish

en/blog/TOC quyidagicha :

README.md

news/README.md
  news/begin.md

Darajani Ko'rsatish Uchun Chiziqdan Foydalaning

Yuqoridagi en/blog/TOC ning birinchi qatoridagi README.md quyidagi rasmdagi i18n.site ga mos keladi, bu loyiha nomi.

Keyingi ikki qator quyidagi skrinshotda ko'rsatilganidek.

news/README.md News ga mos keladi, news/begin.md Our Product is Online ! ga mos keladi

TOC fayllar konturning ierarxik munosabatini ko'rsatish, ko'p darajali chekinishni qo'llab-quvvatlash va # dan boshlanadigan satr sharhlarini ko'rsatish uchun chegaralangan.

Ota-Ona Darajasi Kontentni Emas, Balki Faqat Sarlavhani Yozadi.

Bir necha darajali chekinishlar mavjud bo'lganda, ota-ona darajasi kontentni emas, balki faqat sarlavhani yozadi. Aks holda, tipografiya buziladi.

README.md Loyihasi

Tarkibni README.md bandda yozish mumkin, masalan, en/demo2/README.md .

E'tibor bering, ushbu faylning mazmuni mazmun jadvalini ko'rsatmaydi, shuning uchun uning uzunligini cheklash va qisqacha kirishni yozish tavsiya etiladi.

Loyiha Shiori

Ko'rishingiz mumkinki Your Project slogan Deme Two ning ochiladigan menyusi va katalog konturi loyihasi nomi ostida joylashgan :

Bu en/demo2/README.md ning birinchi qatoriga to'g'ri keladi :

# Demo Two : Your Project slogan

README.md loyihaning birinchi darajali sarlavhasining birinchi ikki nuqta : keyingi mazmuni loyiha shiori sifatida qabul qilinadi.

Xitoy, Yaponiya va Koreyalik foydalanuvchilar, shuni yodda tutingki, toʻliq kenglikdagi ikki nuqta oʻrniga yarim kenglikdagi ikki nuqta : dan foydalanish kerak.

TOCni Ommaviy Ravishda Qanday Ko'chirish Mumkin?

TOC fayl manba tilining katalogiga joylashtirilishi kerak.

Misol uchun, agar manba tili xitoy tili bo'lsa, yuqoridagi TOC zh/blog/TOC ga teng.

Agar manba tili o'zgartirilsa, loyihadagi ma'lum bir tilning TOC ta faylini boshqa tilga ko'chirishingiz kerak.

Siz quyidagi buyruqlarga murojaat qilishingiz mumkin:

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

Iltimos, yuqoridagi buyruqdagi en/ va zh/ til kodingizga o'zgartiring.

Konfiguratsiya Yo'lisiz Standart Yuklash

Muayyan yo'lga kirish uchun, agar yo'l prefiksi nav: ga sozlanmagan bo'lsa, yo'lga mos keladigan MarkDown fayl sukut bo'yicha yuklanadi va Md shablonidan foydalanib ko'rsatiladi.

Misol uchun, agar /test ga kirsa va nav: ushbu yo'lning prefiksisiz sozlangan bo'lsa va joriy ko'rish tili ingliz (kod en ) bo'lsa, /en/test.md sukut bo'yicha yuklanadi va Md shablonidan foydalanib ko'rsatiladi.

Agar /en/test.md bu fayl mavjud bo'lmasa, standart 404 sahifa ko'rsatiladi.