.i18n/conf.yml

Konfigurační soubor pro i18n.site je .i18n/conf.yml a obsah je následující :

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

Mezi nimi upload až ext: konfigurační položka znamená, že při publikování budou nahrány pouze .md .

Horní Navigace nav

nav: možností konfigurace, odpovídající navigační nabídce v horní části domovské stránky.

Mezi nimi i18n: home odpovídá home: Home v en/i18n.yml (kde en je zdrojový jazyk překladu projektu).

Obsah en/i18n.yml je text zobrazený v navigační nabídce, který bude v konfiguraci přeložen podle fromTo , například přeložen na zh/i18n.yml .

Po dokončení překladu můžete upravit hodnotu translation yml , ale nepřidávejte ani neodstraňujte klíč translation yml .

use: Toc Dokumentu S Obrysem

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc znamená vykreslování pomocí šablony Toc , což je vykreslování jedné šablony Markdown .

TOC je zkratka Table of Contents Když je tato šablona vykreslena, obrys tohoto souboru Markdown se zobrazí na postranním panelu.

url: představuje cestu k souboru Markdown ( / odpovídá kořenovému adresáři /README.md , tento název souboru vyžaduje předponu velká a malá přípona).

use: Md Dokumentu Bez Obrysu

Šablona Md a šablona Toc jsou stejné a obě se používají k vykreslení jednoho souboru Markdown . Šablona Md však nezobrazuje obrys v postranním panelu.

Můžete upravit use: Toc ve výše uvedené konfiguraci na use: Md , znovu spustit i18n.site v adresáři md a poté navštívit URL pro náhled vývoje a sledovat změny na domovské stránce.

use: Blog Šablon Blogu

Šablona blogu zobrazuje seznam článků (názvů a abstraktů) v pořadí podle času zveřejnění.

→ Kliknutím sem se dozvíte o konkrétní konfiguraci

use: Doc Šablony Dokumentů S Více Soubory

V konfiguračním souboru:

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

Označuje použití Doc pro vykreslení šablony.

Šablona Doc podporuje integraci více MarkDown pro generování obrysů dokumentu pro jeden nebo více projektů.

Více Projektů a Více Souborů

Konfigurace .i18n/conf.yml v i18n:doc je režim vykreslování více projektů s více soubory.

Zde menu: NB demo1,demo2 znamená použití šablony NB k vykreslení rozevírací nabídky.

NB , což je zkratka Name Breif , znamená, že rozbalovací nabídka může zobrazit název a slogan projektu.

NB následuje parametr demo1,demo2 který je jí předán.

Poznámka : ** Před a za čárkou , v demo1,demo2 by neměly být žádné ** .

Pro výše uvedené parametry je odpovídající soubor indexu adresáře:

Jeden Projekt Více Souborů

Pokud máte pouze jeden projekt, můžete jej nakonfigurovat následovně.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] Jeden projekt s více soubory nepodporuje konfiguraci url jako kořenové cesty / Pokud conf.yml → nav: Není nakonfigurována žádná kořenová cesta, při přístupu na domovskou stránku webu bude automaticky přepsána na první URL pod konfigurací nav: . Tento návrh má lépe rozlišit projektové dokumenty, blogy a další obsah prostřednictvím adresářů. Jako domovskou stránku se doporučuje použít jeden soubor a jednu stránku.

[!TIP] Pokud není zapsána url , url je výchozí hodnotou i18n Toto pravidlo platí také pro ostatní šablony.

TOC Index Obsahu

Pokud je v konfiguraci povolena šablona use: Doc , povolte prosím plug-in i18n.addon/toc v .i18n/conf.yml Konfigurace je následující :

addon:
  - i18n.addon/toc

i18n.site automaticky nainstaluje a spustí tento plug-in, přečte TOC soubor indexu adresáře a vygeneruje json obrys adresáře.

Pokud se jedná o jeden projekt s více soubory, kořenový adresář TOC je adresář odpovídající url: v adresáři zdrojového jazyka. Například pokud je zdrojovým jazykem čínština: soubor odpovídající url: flashduty je zh/flashduty/TOC .

Pokud se jedná o více projektů a více souborů, není třeba konfigurovat url: Kořenový adresář TOC je adresář odpovídající hodnotě i18n .

Podrobné Vysvětlení Obsahu

en/blog/TOC je následující :

README.md

news/README.md
  news/begin.md
K Označení Úrovní Použijte Odsazení

README.md v prvním řádku en/blog/TOC výše odpovídá i18n.site na obrázku níže, což je název projektu.

Následující dva řádky jsou jako na obrázku níže.

news/README.md odpovídá News , news/begin.md odpovídá Our Product is Online !

Soubory TOC jsou odsazeny, aby indikovaly hierarchický vztah obrysu, podporují víceúrovňové odsazení a řádkové komentáře začínající # .

Nadřazená Úroveň Píše Pouze Název, Nikoli Obsah.

Pokud existuje více úrovní odsazení, nadřazená úroveň zapíše pouze název, nikoli obsah. Jinak bude typografie zpackaná.

Projekt README.md

Obsah lze zapsat do položky README.md , například en/demo2/README.md .

Všimněte si, že obsah tohoto souboru nezobrazuje osnovu obsahu, proto se doporučuje omezit délku a napsat krátký úvod.

Slogan Projektu

Můžete vidět Your Project slogan že Deme Two má svůj slogan projektu pod rozbalovací nabídkou a katalogovým názvem projektu : .

To odpovídá prvnímu řádku en/demo2/README.md :

# Demo Two : Your Project slogan

Obsah za první dvojtečkou : v názvu první úrovně projektu README.md bude považován za slogan projektu.

Uživatelé z Číny, Japonska a Koreje by měli používat : s poloviční šířkou místo dvojtečky s plnou šířkou.

Jak Hromadně Přesunout TOC?

TOC souborů je třeba umístit do adresáře zdrojového jazyka.

Pokud je například zdrojovým jazykem čínština, pak TOC výše je zh/blog/TOC .

Pokud je zdrojový jazyk upraven, musíte dávkově přesunout soubory TOC určitého jazyka v projektu do jiného jazyka.

Můžete se obrátit na následující příkazy:

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

Upravte prosím en/ a zh/ ve výše uvedeném příkazu na kód vašeho jazyka.

Výchozí Načítání Bez Konfigurační Cesty

Pro určitou zpřístupněnou cestu, pokud předpona cesty není nakonfigurována na nav: , bude ve výchozím nastavení načten soubor MarkDown odpovídající cestě a vykreslen pomocí šablony Md .

Pokud je například přistupováno /test a nav: je nakonfigurováno bez předpony této cesty a aktuálním jazykem procházení je angličtina (kód en ), ve výchozím nastavení se načte /en/test.md a vykreslí se pomocí šablony Md .

Pokud /en/test.md tento soubor neexistuje, zobrazí se výchozí 404 stránka.