.i18n/conf.yml

Konfiguratsioonifail i18n.site jaoks on .i18n/conf.yml ja sisu on järgmine :

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

Nende hulgas tähendab upload kuni ext: konfiguratsiooniüksust, et avaldamisel laaditakse üles ainult .md .

Ülemine Navigeerimisnavigeerimine

nav: konfiguratsioonivalikut, mis vastavad avalehe ülaosas olevale navigeerimismenüüle.

Nende hulgas vastab i18n: home väärtusele home: Home en/i18n.yml (kus en on projekti tõlke lähtekeel).

en/i18n.yml sisu on navigeerimismenüüs kuvatav tekst, mis tõlgitakse konfiguratsioonis vastavalt fromTo , näiteks tõlgitakse zh/i18n.yml ks.

Pärast tõlke lõppu saate muuta tõlke väärtust yml , kuid ärge lisage ega kustutage tõlke võtit yml .

use: Toc Kontuuriga Dokumendimall

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc tähendab renderdamist malli Toc abil, mis on ühe Markdown malli renderdamine.

TOC on lühend Table of Contents Kui see mall renderdatakse, kuvatakse külgribal selle Markdown faili kontuur.

url: tähistab faili teed Markdown ( / vastab juurkataloogile /README.md , see failinimi nõuab suurtähtede eesliidet ja väiketähtede järelliidet).

use: Md Dokumendimall Ilma Kontuurita

Mallid Md ja Toc on samad ja mõlemat kasutatakse ühe Markdown -faili renderdamiseks. Kuid mall Md ei näita külgribal kontuuri.

Saate muuta ülaltoodud konfiguratsioonis use: Toc väärtuseks use: Md , käivitada i18n.site uuesti kataloogis md ja seejärel külastada arenduse eelvaate URL-i, et avalehel muudatusi jälgida.

use: Blog Ajaveebi Malli

Blogimall kuvab artiklite loendi (pealkirjad ja kokkuvõtted) avaldamisaja järjekorras.

→ Konkreetse konfiguratsiooni kohta lisateabe saamiseks klõpsake siin

use: Doc Faili Dokumendimallid

Konfiguratsioonifailis:

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

Näitab Doc kasutamist malli renderdamiseks.

Doc mall toetab mitme MarkDown integreerimist ühe või mitme projekti jaoks dokumendikontuuride loomiseks.

Mitu Projekti Ja Mitu Faili

Konfiguratsioon .i18n/conf.yml i18n:doc on mitme projektiga mitme faili renderdusrežiim.

Siin tähendab menu: NB demo1,demo2 malli NB kasutamist rippmenüü renderdamiseks.

NB , mis on lühend Name Breif -st, tähendab, et rippmenüüs saab kuvada projekti nime ja hüüdlauset.

NB le järgneb sellele edastatud parameeter demo1,demo2 .

Märkus : ** Koma , : demo1,demo2 ees ja järel ei tohi olla ** .

Ülaltoodud parameetrite jaoks on vastav kataloogiindeksi fail:

Üks Projekt Mitu Faili

Kui teil on ainult üks projekt, saate selle konfigureerida järgmiselt.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] Üks projekt mitme failiga ei toeta url konfigureerimist juurteeks / Kui conf.yml → nav: Juurteed pole konfigureeritud, kirjutatakse see veebisaidi avalehele sisenemisel automaatselt ümber esimesele URL-ile nav: konfiguratsiooni all. See kujundus on mõeldud projekti dokumentide, ajaveebi ja muu sisu paremaks eristamiseks kataloogide kaudu. Avalehena on soovitatav kasutada ühte faili ja ühte lehte.

[!TIP] Kui url pole kirjutatud, on url vaikimisi väärtus i18n See reegel kehtib ka muude mallide puhul.

TOC Sisukorra Register

Kui mall use: Doc on konfiguratsioonis lubatud, lubage pistikprogramm i18n.addon/toc in .i18n/conf.yml Konfiguratsioon on järgmine :

addon:
  - i18n.addon/toc

i18n.site installib ja käivitab selle pistikprogrammi automaatselt, loeb TOC kataloogiregistri faili ja genereerib json kataloogi kontuuri.

Kui tegemist on ühe projektiga, millel on mitu faili, on juurkataloog TOC lähtekeele kataloogis url: -le vastav kataloog. Näiteks kui lähtekeel on hiina keel: url: flashduty -le vastav fail on zh/flashduty/TOC .

Kui tegemist on mitme projekti ja mitme failiga, pole url: vaja seadistada. TOC juurkataloog on i18n väärtusele vastav kataloog.

Üksikasjalik Sisu Selgitus

en/blog/TOC on järgmine :

README.md

news/README.md
  news/begin.md
Kasutage Tasemete Märkimiseks Taanet

README.md ülaltoodud en/blog/TOC esimeses reas vastab i18n.site alloleval pildil, mis on projekti nimi.

Järgmised kaks rida on sellised, nagu on näidatud alloleval ekraanipildil.

news/README.md vastab News , news/begin.md vastab Our Product is Online !

TOC failid on taandega, et näidata kontuuri hierarhilist seost, toetada mitmetasandilist taanet ja reakommentaare, mis algavad # ga.

Vanemtasand Kirjutab Ainult Pealkirja, Mitte Sisu.

Kui taande on mitu taset, kirjutab ülemtase ainult pealkirja, mitte sisu. Vastasel juhul läheb tüpograafia sassi.

Projekt README.md

Sisu saab kirjutada punktis README.md , näiteks en/demo2/README.md .

Pange tähele, et selle faili sisu ei näita sisukorra ülevaadet, seega on soovitatav pikkust piirata ja kirjutada lühike sissejuhatus.

Projekti Hüüdlause

Näete, et Deme Two on selle projekti tunnustekst rippmenüü ja kataloogi projekti nime Your Project slogan :

See vastab en/demo2/README.md esimesele reale :

# Demo Two : Your Project slogan

Projekti README.md esimese taseme pealkirja esimese kooloni : järel olevat sisu loetakse projekti tunnuslauseks.

Hiinast, Jaapanist ja Koreast pärit kasutajad pange tähele, et täislaiuse käärsoole asemel peaksite kasutama poollaiust koolonit : .

Kuidas TOC-I Hulgi Teisaldada?

TOC faili tuleb paigutada lähtekeele kataloogi.

Näiteks kui lähtekeel on hiina keel, siis ülaltoodud TOC on zh/blog/TOC .

Kui lähtekeelt muudetakse, peate projekti teatud keele TOC failid pakkides teisaldama teise keelde.

Võite viidata järgmistele käskudele:

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

Palun muutke ülaltoodud käsus oma keelekoodi en/ ja zh/ .

Vaikimisi Laadimine Ilma Konfiguratsiooniteeta

Teatud juurdepääsutee korral, kui tee eesliide ei ole nav: konfigureeritud, laaditakse vaikimisi teele vastav fail MarkDown ja renderdatakse malli Md abil.

Näiteks kui juurdepääs on /test ja nav: on konfigureeritud ilma selle tee eesliiteta ning praegune sirvimiskeel on inglise keel (kood en ), laaditakse vaikimisi /en/test.md ja renderdatakse malli Md abil.

Kui /en/test.md seda faili ei eksisteeri, kuvatakse vaikeleht 404 .