.i18n/conf.yml

Il-fajl tal-konfigurazzjoni għal i18n.site huwa .i18n/conf.yml u l-kontenut huwa kif ġej :

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

Fosthom, oġġett ta' konfigurazzjoni upload sa ext: ifisser li .md biss se jittellgħu meta jiġu ppubblikati.

Top Navigazzjoni nav

nav: għażliet ta' konfigurazzjoni, li jikkorrispondu mal-menu tan-navigazzjoni fin-naħa ta' fuq tal-homepage.

Fosthom, i18n: home jikkorrispondi għal home: Home en/i18n.yml (fejn en hija l-lingwa sors tat-traduzzjoni tal-proġett).

Il-kontenut en/i18n.yml huwa t-test muri fil-menu tan-navigazzjoni, li se jiġi tradott skont fromTo fil-konfigurazzjoni, pereżempju, tradott għal zh/i18n.yml .

Wara li titlesta t-traduzzjoni, tista' timmodifika l-valur tat-traduzzjoni yml , iżda ma żżidx jew tħassarx iċ-ċavetta tat-traduzzjoni yml .

0Mudell Ta' Dokument `use: Toc` B'kontorn

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc tfisser tirrendi bl-użu ta 'mudell Toc , li qed tirrendi mudell Markdown wieħed.

TOC hija l-abbrevjazzjoni ta' Table of Contents Meta dan il-mudell jiġi ppreżentat, il-kontorn ta 'dan il-fajl Markdown se jintwera fil-sidebar.

url: jirrappreżenta l-mogħdija tal-fajl ta ' Markdown ( / jikkorrispondi għad-direttorju tal-għeruq /README.md , dan l-isem tal-fajl jeħtieġ prefiss kbir u suffiss żgħir).

0Mudell Ta' Dokument `use: Md` Mingħajr Kontorn

Il-mudell Md u l-mudell Toc huma l-istess u t-tnejn jintużaw biex jirrendu fajl Markdown wieħed. Iżda l-mudell Md ma jurix il-kontorn fil-sidebar.

Tista 'timmodifika use: Toc fil-konfigurazzjoni ta' hawn fuq għal use: Md , erġa' ħaddem i18n.site fid-direttorju md , u mbagħad żur il-URL tal-preview tal-iżvilupp biex tosserva l-bidliet fuq il-homepage.

`use: Blog` Mudelli Tal-Blog

Il-mudell tal-blog juri lista ta’ artikli (titoli u astratti) f’ordni ta’ żmien ta’ pubblikazzjoni.

→ Ikklikkja hawn biex titgħallem dwar il-konfigurazzjoni speċifika

0Mudelli Ta' Dokumenti Ta' Fajl `use: Doc`

Fil-fajl tal-konfigurazzjoni:

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

Jindika l-użu ta' Doc għall-għoti tal-mudelli.

Il-mudell Doc jappoġġja l-integrazzjoni ta 'multipli MarkDown biex jiġġenera deskrizzjonijiet ta' dokumenti għal proġetti singoli jew multipli.

Proġetti Multipli U Fajls Multipli

Il-konfigurazzjoni ta ' .i18n/conf.yml i18n:doc hija mod ta' rendering b'ħafna proġetti b'ħafna fajls.

Hawnhekk, menu: NB demo1,demo2 , tfisser li tuża l-mudell NB biex tirrendi l-menu drop-down.

NB , li hija l-abbrevjazzjoni ta ' Name Breif , tfisser li l-menu drop-down jista' juri l-isem u s-slogan tal-proġett.

NB huwa segwit mill-parametru demo1,demo2 mgħoddi lilha.

: ** M'għandux ikun hemm spazji ** qabel u wara l-virgola , demo1,demo2 .

Għall-parametri ta 'hawn fuq, il-fajl tal-indiċi tad-direttorju korrispondenti huwa:

en/demo1/TOC
en/demo2/TOC

Fajls Multipli Ta 'proġett Wieħed

Jekk għandek proġett wieħed biss, tista 'tikkonfigurah kif ġej.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] Proġett wieħed b'fajls multipli ma jappoġġax il-konfigurazzjoni ta url bħala l-passaġġ ta' l-għeruq / Jekk conf.yml → nav: L-ebda mogħdija ta 'l-għerq ma hija kkonfigurata, meta taċċessa l-homepage tal-websajt, tinkiteb mill-ġdid awtomatikament fl-ewwel URL taħt il-konfigurazzjoni nav: . Dan id-disinn huwa biex jiddistingwi aħjar id-dokumenti tal-proġett, blogs u kontenut ieħor permezz tad-direttorji. Huwa rakkomandat li tuża fajl wieħed u paġna waħda bħala l-home page.

[!TIP] Jekk url ma jkunx miktub, url default għall-valur ta ' i18n Din ir-regola tidħol fis-seħħ ukoll għal mudelli oħra.

Indiċi Tal-Kontenut Tat-TOC

Jekk il-mudell use: Doc huwa attivat fil-konfigurazzjoni, jekk jogħġbok attiva plug-in i18n.addon/toc .i18n/conf.yml Il-konfigurazzjoni hija kif ġej :

addon:
  - i18n.addon/toc

i18n.site awtomatikament jinstalla u jesegwixxi dan il-plug-in, jaqra TOC il-fajl tal-indiċi tad-direttorju, u jiġġenera json il-kontorn tad-direttorju.

Jekk huwa proġett wieħed b'ħafna fajls, id-direttorju tal-għeruq TOC huwa d-direttorju li jikkorrispondi għal url: fid-direttorju tal-lingwa tas-sors Per eżempju, jekk il-lingwa tas-sors hija Ċiniża: il-fajl li jikkorrispondi għal url: flashduty huwa zh/flashduty/TOC .

Jekk huwa proġetti multipli u fajls multipli, m'hemmx bżonn li jiġi kkonfigurat url: Id-direttorju tal-għeruq ta ' TOC huwa d-direttorju li jikkorrispondi għall-valur ta' i18n .

Spjegazzjoni Dettaljata Tal-Kontenut

en/blog/TOC -kontenut huwa kif ġej :

README.md

news/README.md
  news/begin.md

Uża Indentazzjoni Biex Tindika L-Livelli

README.md fl-ewwel ringiela ta ' en/blog/TOC hawn fuq jikkorrispondi għal i18n.site fl-istampa hawn taħt, li huwa l-isem tal-proġett.

Iż-żewġ linji li jmiss huma kif muri fil-screenshot hawn taħt.

news/README.md jikkorrispondi għal News , news/begin.md jikkorrispondi għal Our Product is Online !

TOC fajls huma indentati biex jindikaw ir-relazzjoni ġerarkika tal-kontorn, jappoġġjaw indentazzjoni f'diversi livelli, u kummenti tal-linja li jibdew # .

Il-Livell Tal-Ġenitur Jikteb Biss It-Titlu, Mhux Il-Kontenut.

Meta jkun hemm diversi livelli ta 'indentazzjoni, il-livell ġenitur jikteb biss it-titlu u mhux il-kontenut. Inkella, it-tipografija tkun imħassra.

Proġett README.md

Il-kontenut jista' jinkiteb f'oġġett README.md , bħal en/demo2/README.md .

Innota li l-kontenut ta 'dan il-fajl ma jurix sommarju tal-werrej, għalhekk huwa rakkomandat li tillimita t-tul u tikteb introduzzjoni qasira.

Slogan Tal-Proġett

Tista' tara li Deme Two għandu t-tagline tal-proġett tiegħu taħt il-menu drop-down u l-isem tal-proġett tal-kontorn tal-katalgu Your Project slogan :

Dan jikkorrispondi għall-ewwel ringiela ta ' en/demo2/README.md :

# Demo Two : Your Project slogan

Il-kontenut wara l-ewwel kolon : tat-titolu tal-ewwel livell tal-proġett README.md se jitqies bħala l-islogan tal-proġett.

Utenti miċ-Ċina, il-Ġappun u l-Korea, jekk jogħġbok innota li għandek tuża nofs wisa 'kolon : minflok kolon full-wisa'.

Kif Timxi TOC Bl-Ingrossa?

TOC fajls jeħtieġ li jitqiegħdu fid-direttorju tal-lingwa tas-sors.

Pereżempju, jekk il-lingwa tas-sors hija Ċiniża, allura TOC hawn fuq huwa zh/blog/TOC .

Jekk il-lingwa tas-sors tiġi modifikata, għandek bżonn tmexxi l-lott tal-fajls TOC ta 'ċerta lingwa fil-proġett għal lingwa oħra.

Tista' tirreferi għall-kmandi li ġejjin:

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

Jekk jogħġbok immodifika en/ u zh/ fil-kmand ta' hawn fuq għall-kodiċi tal-lingwa tiegħek.

Tagħbija Default Mingħajr Mogħdija Tal-Konfigurazzjoni

Għal ċerta mogħdija li tkun qed tiġi aċċessata, jekk il-prefiss tal-mogħdija ma jkunx ikkonfigurat nav: , il-fajl MarkDown li jikkorrispondi għall-mogħdija jitgħabba b'mod awtomatiku u mogħti bl-użu tal-mudell Md .

Pereżempju, jekk /test jiġi aċċessat u nav: jiġi kkonfigurat mingħajr il-prefiss ta 'din il-mogħdija, u l-lingwa tal-ibbrawżjar attwali hija l-Ingliż (kodiċi en ), /en/test.md se jitgħabba b'mod awtomatiku u jingħata bl-użu ta' template Md .

Jekk /en/test.md dan il-fajl ma jeżistix, tintwera l-paġna 404 default.