.i18n/conf.yml

Конфигурациската датотека за i18n.site е .i18n/conf.yml , а содржината е следна :

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

Меѓу нив, ставката за конфигурација upload до ext: значи дека само .md ќе бидат поставени при објавување.

Врвна Навигација

nav: опции за конфигурација, што одговараат на менито за навигација на врвот на почетната страница.

Меѓу нив, i18n: home одговара на home: Home во en/i18n.yml (каде што en е изворниот јазик на преводот на проектот).

en/i18n.yml содржина е текстот прикажан во менито за навигација, кој ќе биде преведен според fromTo во конфигурацијата, на пример, преведен на zh/i18n.yml .

Откако ќе заврши преводот, можете да ја менувате вредноста на преводот yml , но не додавајте или бришете го клучот за превод yml .

use: Toc Шаблон За Еден Документ Со Преглед

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc значи рендерирање со користење на Toc шаблон, што е рендерирање на еден шаблон Markdown .

TOC е кратенката од Table of Contents Кога ќе се рендерира овој шаблон, прегледот на оваа датотека Markdown ќе се прикаже во страничната лента.

url: ја претставува патеката на датотеката Markdown ( / одговара на root директориумот /README.md , ова име на датотека бара префикс со големи букви и додавка со мали букви).

use: Md Шаблон За Еден Документ Без Преглед

Шаблонот Md и шаблонот Toc се исти и обајцата се користат за прикажување на една датотека Markdown . Но, шаблонот Md не го прикажува прегледот во страничната лента.

Можете да го измените use: Toc во горната конфигурација во use: Md , повторно да извршите i18n.site во директориумот md , а потоа да ја посетите URL-адресата за преглед на развојот за да ги набљудувате промените на почетната страница.

use: Blog Шаблони За Блогови

Шаблонот за блог прикажува листа на статии (наслови и апстракти) по редослед на времето на објавување.

→ Кликнете овде за да дознаете за конкретната конфигурација

use: Doc Шаблони За Документи Со Повеќе Датотеки

Во конфигурациската датотека:

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

Покажува користење Doc за прикажување на шаблоните.

Шаблонот Doc поддржува интегрирање на повеќе MarkDown за генерирање на контури на документи за единечни или повеќе проекти.

Повеќе Проекти И Повеќе Датотеки

Конфигурацијата .i18n/conf.yml во i18n:doc е режим на рендерирање со повеќе датотеки со повеќе проекти.

Овде, menu: NB demo1,demo2 , значи користење на шаблонот NB за прикажување на паѓачкото мени.

NB , што е кратенка од Name Breif , значи дека паѓачкото мени може да ги прикаже името и слоганот на проектот.

NB е проследено со параметарот demo1,demo2 кој му е предаден.

: ** Не треба да има празни места ** пред и по запирката , во demo1,demo2 .

За горенаведените параметри, соодветната датотека со индекс на директориуми е:

Еден Проект Повеќе Датотеки

Ако имате само еден проект, можете да го конфигурирате на следниов начин.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] Еден проект со повеќе датотеки не поддржува конфигурирање на url како основна патека / Ако conf.yml nav: Не е конфигурирана root патека, кога пристапувате до почетната страница на веб-локацијата, таа автоматски ќе се препише на првата URL-адреса под конфигурацијата nav: . Овој дизајн е за подобро да ги разликува проектните документи, блоговите и другите содржини преку директориуми. Се препорачува да се користи една датотека и една страница како почетна страница.

[!TIP] Ако url не е напишано, url стандардно ја става вредноста на i18n Ова правило стапува на сила и за други шаблони.

Индекс На Содржина На TOC

Ако шаблонот use: Doc е овозможен во конфигурацијата, ве молиме овозможете го приклучокот i18n.addon/toc во .i18n/conf.yml Конфигурацијата е следна :

addon:
  - i18n.addon/toc

i18n.site автоматски ќе го инсталира и изврши овој приклучок, ќе ја прочита TOC датотеката со индекс на директориумот и ќе генерира json преглед на директориумот.

Ако е еден проект со повеќе датотеки, root директориумот TOC е директориумот што одговара на url: во директориумот на изворниот јазик На пример, ако изворниот јазик е кинески: датотеката што одговара на url: flashduty е zh/flashduty/TOC .

Ако се работи за повеќе проекти и повеќе датотеки, нема потреба да се конфигурира url: Коренскиот директориум на TOC е директориумот што одговара на вредноста од i18n .

Детално Објаснување За Содржината

en/blog/TOC е следна :

README.md

news/README.md
  news/begin.md
Користете Вовлекување За Да Ги Означите Нивоата

README.md во првиот ред од en/blog/TOC погоре одговара на i18n.site на сликата подолу, што е името на проектот.

Следните две линии се како што е прикажано на екранот подолу.

news/README.md одговара на News , news/begin.md одговара на Our Product is Online !

TOC датотеки се вовлечени за да се означи хиерархиската врска на прегледот, да се поддржи вовлекувањето на повеќе нивоа и коментарите на линиите кои започнуваат со # .

Родителското Ниво Го Пишува Само Насловот, А Не Содржината.

Кога има повеќе нивоа на вовлекување, родителското ниво го пишува само насловот, а не и содржината. Во спротивно, типографијата ќе биде збркана.

Проект README.md

Содржината може да биде напишана во точка README.md , како што е en/demo2/README.md .

Имајте предвид дека содржината на оваа датотека не прикажува преглед на табелата со содржини, па затоа се препорачува да се ограничи должината и да се напише краток вовед.

Слоган На Проектот

Можете да видите дека Deme Two ја има својата ознака Your Project slogan :

Ова одговара на првиот ред од en/demo2/README.md :

# Demo Two : Your Project slogan

Содржината по првата точка : од насловот на првото ниво на проектот README.md ќе се смета како слоган на проектот.

Корисници од Кина, Јапонија и Кореја, имајте предвид дека треба да користите две точки со половина ширина : наместо две точки со целосна ширина.

Како Да Го Преместите TOC На Големо?

TOC датотеки треба да се стават во директориумот на изворниот јазик.

На пример, ако изворниот јазик е кинески, тогаш TOC погоре е zh/blog/TOC .

Ако изворниот јазик е изменет, треба сериски да ги преместите TOC датотеките од одреден јазик во проектот на друг јазик.

Можете да се повикате на следните команди:

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

Изменете ги en/ и zh/ во горната команда во кодот на вашиот јазик.

Стандардно Вчитување Без Патека За Конфигурација

За одредена патека до која се пристапува, ако префиксот на патеката не е конфигуриран во nav: , датотеката MarkDown што одговара на патеката ќе биде стандардно вчитана и прикажана со помош на шаблонот Md .

На пример, ако се пристапи до /test , а nav: е конфигуриран без префиксот на оваа патека, а тековниот јазик на прелистување е англискиот (шифра en ), /en/test.md ќе се вчита стандардно и ќе се прикажува со користење на шаблонот Md .

Ако /en/test.md оваа датотека не постои, ќе се прикаже стандардната 404 страница.