.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 ( / адпавядае каранёваму каталогу /README.md , гэта імя файла патрабуе прэфікса ў верхнім рэгістры і суфікса ў малым рэгістры).

`use: Md` Дакумента Без Контуру

Шаблоны Md і шаблоны Toc аднолькавыя і абодва выкарыстоўваюцца для адлюстравання аднаго файла Markdown . Але шаблон Md не паказвае контур на бакавой панэлі.

Вы можаце змяніць use: Toc у прыведзенай вышэй канфігурацыі на use: Md , зноў запусціць i18n.site у каталогу md , а затым наведаць URL папярэдняга прагляду распрацоўкі, каб назіраць за зменамі на галоўнай старонцы.

`use: Blog` Шаблонаў Блогаў

Шаблон блога адлюстроўвае спіс артыкулаў (назвы і анатацыі) у парадку часу публікацыі.

→ Націсніце тут, каб даведацца аб канкрэтнай канфігурацыі

0Шаблоны Дакументаў `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 павінна быць ** .

Для вышэйзгаданых параметраў адпаведны файл індэкса каталога:

en/demo1/TOC
en/demo2/TOC

Адзін Праект Некалькі Файлаў

Калі ў вас толькі адзін праект, вы можаце наладзіць яго наступным чынам.

  - i18n: doc
    url: flashduty
    use: Doc

[!WARN] Адзіны праект з некалькімі файламі не падтрымлівае канфігурацыю url у якасці каранёвага шляху / Калі conf.yml → nav: Каранёвы шлях не наладжаны, пры доступе да галоўнай старонкі вэб-сайта ён будзе аўтаматычна перапісаны на першы URL у канфігурацыі nav: . Гэты дызайн прызначаны для лепшага адрознення праектных дакументаў, блогаў і іншага кантэнту праз каталогі. Рэкамендуецца выкарыстоўваць адзін файл і адну старонку ў якасці хатняй старонкі.

[!TIP] Калі url не запісаны, url па змаўчанні мае значэнне i18n Гэта правіла таксама дзейнічае для іншых шаблонаў.

TOC Паказальнік Зместу

Калі ў канфігурацыі ўключаны шаблон use: Doc , уключыце плагін i18n.addon/toc у .i18n/conf.yml Канфігурацыя наступная :

addon:
  - i18n.addon/toc

i18n.site аўтаматычна ўсталюе і запусціць гэты плагін, прачытае TOC файл індэкса каталога і згенеруе json схему каталога.

Калі гэта адзіны праект з некалькімі файламі, каранёвы каталог 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 старонка па змаўчанні.