.i18n/conf.yml

Iyo faira yekumisikidza i18n.site ndeye .i18n/conf.yml uye zvirimo ndezvinotevera :

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

Pakati pavo, upload kusvika ext: yekumisikidza chinhu zvinoreva kuti .md chete ndiyo ichaiswa pairi kudhindwa.

Top Navigation nav

nav: sarudzo dzekugadzirisa, dzinoenderana nemenu yekufambisa iri pamusoro pepeji remba.

Pakati pavo, i18n: home inoenderana home: Home en/i18n.yml (apo en ndiwo mutauro unobva pashanduro yeprojekiti).

en/i18n.yml zvirimo ndiwo mavara anoratidzwa mumenyu yekufambisa, iyo inoshandurwa zvinoenderana fromTo mukugadzirisa, semuenzaniso, yakashandurwa zh/i18n.yml .

Mushure mokunge shanduro yapera, unogona kugadzirisa kukosha kwekushandura yml , asi usawedzera kana kubvisa kiyi yekushandura yml .

use: Toc Gwaro Template Ine Chinyorwa

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc zvinoreva kupa uchishandisa Toc template, iyo iri kupa imwechete Markdown template.

TOC ndiyo chidimbu che Table of Contents Kana template iyi yaitwa, rondedzero yeiyi Markdown faira icharatidzwa mudivi pebhari.

url: inomiririra nzira yefaira Markdown ( / inoenderana nemudzi wedhairekitori /README.md , zita refaira iri rinoda chivakashure chepamusoro uye chivakashure chemavara madiki).

use: Md Gwaro Template Isina Rondedzero

Iyo Md template uye Toc template zvakafanana uye ese ari maviri anoshandiswa kupa imwechete Markdown faira. Asi iyo Md template hairatidze ratidziro muparutivi.

Iwe unogona kugadzirisa use: Toc mukumisikidzwa kwepamusoro use: Md , mhanya i18n.site mune md dhairekitori zvakare, uye wobva washanyira iyo yekuvandudza yekutarisa URL kuti uone shanduko papeji remba.

use: Blog Blog Templates

Iyo blog template inoratidza rondedzero yezvinyorwa (mazita uye abstracts) mukurongeka kwenguva yekuburitswa.

→ Dzvanya pano kuti udzidze nezve chaiyo gadziriro

use: Doc Faira Gwaro Matemplate

Mufaira rekugadzirisa:

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

Inoratidza kushandisa Doc pakupa template.

Doc template inotsigira kubatanidza akawanda MarkDown kugadzira zvinyorwa zvemapurojekiti ega kana akawanda.

Mapurojekiti Akawanda Uye Akawanda Mafaera

Kugadziriswa .i18n/conf.yml i18n:doc ndeye-multi-project multi-file rendering mode.

Pano, menu: NB demo1,demo2 , zvinoreva kushandisa NB template kupa iyo yekudonha-pasi menyu.

NB , inova chidimbu Name Breif , zvinoreva kuti menyu yekudonha inogona kuratidza zita uye sirogani yeprojekiti.

NB inoteverwa neparameter demo1,demo2 yakapfuudzwa kwairi.

demo1,demo2 : ** , **

Kune ma parameter ari pamusoro, iyo inoenderana dhairekitori index faira ndeye:

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

Single Project Akawanda Mafaera

Kana uine purojekiti imwe chete, unogona kuigadzirisa sezvinotevera.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] Imwe purojekiti ine akawanda mafaera haitsigire kugadzirisa url senzira yemidzi / Kana conf.yml → nav: Hapana nzira yemidzi inogadziriswa, kana uchinge wawana peji rekutanga rewebhusaiti, inozonyorwazve kune yekutanga URL pasi peiyo nav: kumisikidzwa. Iyi dhizaini ndeyekusiyanisa zvirinani magwaro eprojekiti, mablogiki uye zvimwe zvirimo kuburikidza nemadhairekitori. Inokurudzirwa kushandisa faira rimwe chete uye peji rimwechete sepeji remba.

[!TIP] Kana url isina kunyorwa, url inokanganisa kukosha kwe i18n Uyu mutemo unoshandawo kune mamwe matemplate.

TOC Tafura Yezviri Mukati Index

Kana template use: Doc ikagoneswa mukumisikidzwa, ndapota gonesa plug-in i18n.addon/toc mu .i18n/conf.yml Magadzirirwo akadai :

addon:
  - i18n.addon/toc

i18n.site ichaisa otomatiki nekuita iyi plug-in, verenga TOC iyo dhairekitori index faira, uye gadzira json iyo dhairekitori rondedzero.

Kana iri purojekiti imwe chete ine mafaera akawanda, dhairekitori remidzi TOC ndiro dhairekitori rinoenderana url: mune dhairekitori remutauro semuenzaniso, kana mutauro unobva kuChinese: faira inoenderana url: flashduty ndeye zh/flashduty/TOC .

Kana iri mapurojekiti akawanda uye mafaira akawanda, hapana chikonzero chekugadzirisa url: Midzi yezvinyorwa zve TOC ndiyo dhairekitori inoenderana nekukosha i18n .

Detailed Content Tsananguro

en/blog/TOC mukati ndeizvi :

README.md

news/README.md
  news/begin.md

Shandisa Indentation Kuratidza Mazinga

README.md mumutsara wekutanga en/blog/TOC pamusoro inoenderana i18n.site pamufananidzo uri pazasi, iro ndiro zita reprojekiti.

Mitsetse miviri inotevera inoratidzwa muscreenshot pazasi.

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

TOC mafaira akaiswa mukati kuti aratidze hukama hwehumambo hwechiratidziro, tsigiro yakawanda-level indentation, uye mitsetse yekutaura inotanga # .

Chiyero Chemubereki Chinonyora Musoro Chete, Kwete Zviri Mukati.

Kana paine akati wandei mazinga e indentation, chikamu chemubereki chinongonyora musoro kwete zvirimo. Zvikasadaro, typography ichakanganiswa.

Chirongwa README.md

Zviri mukati zvinogona kunyorwa muchinhu README.md , senge en/demo2/README.md .

Ziva kuti zviri mufaira iri hazviratidzi tafura yezviri mukati, saka zvinokurudzirwa kudzikamisa kureba uye kunyora sumo pfupi.

Project Sirogani

Iwe unogona kuona Your Project slogan Deme Two ine tagline yeprojekiti pazasi pemenu yekudonhedza uye katalogi yezita reprojekiti : .

Izvi zvinoenderana nemutsara wekutanga en/demo2/README.md :

# Demo Two : Your Project slogan

Izvo zvirimo mushure mekutanga colon : yezita rekutanga-chikamu chepurojekiti README.md ichaonekwa sechirongwa cheprojekiti.

Vashandisi vanobva kuChina, Japan neKorea, ndapota cherechedzai kuti munofanira kushandisa hafu-yakafara colon : pane yakazara-yakafara colon.

Nzira Yekufambisa TOC Muhuwandu?

TOC mafaera anoda kuiswa mudhairekitori remutauro wemabviro.

Semuenzaniso, kana mutauro unobva kuChinese, ipapo TOC kumusoro ndiye zh/blog/TOC .

Kana mutauro wemabviro ukagadziridzwa, unofanirwa kufambisa TOC mafaera emumwe mutauro mupurojekiti kuenda kune mumwe mutauro.

Iwe unogona kutarisa kune inotevera mirairo:

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

Ndapota shandura en/ uye zh/ mumurairo uri pamusoro kukodhi yemutauro wako.

Default Kurodha Pasina Configuration Nzira

Kune imwe nzira iri kuwanikwa, kana nzira yekutanga isati yagadziriswa muna nav: , iyo MarkDown faira inoenderana nenzira inotakurwa nekusarudzika uye inopihwa uchishandisa iyo Md template.

Semuenzaniso, kana /test yakasvikirwa, uye nav: yakagadziriswa pasina prefix yeiyi nzira, uye mutauro wezvino wekubhurawuza ndewechiRungu (code en ), /en/test.md ichatakurwa nekusarudzika uye ichishandurwa uchishandisa template Md .

Kana /en/test.md iyi faira isipo, peji 404 richaratidzwa.