.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 , ово име датотеке захтева префикс великим словима и суфикс малим словима).

0 Шаблон use: Md Документа Без Оквира

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

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

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: Није конфигурисана основна путања, када се приступа почетној страници веб локације, она ће аутоматски бити преписана на прву УРЛ адресу под конфигурацијом nav: . Овај дизајн има за циљ да боље разликује документе пројекта, блогове и други садржај кроз директоријуме. Препоручљиво је користити једну датотеку и једну страницу као почетну страницу.

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

Индекс Садржаја ТОЦ-А

Ако је шаблон 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 , као што је en/demo2/README.md .

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

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

Можете видети да Deme Two има свој слоган пројекта испод падајућег менија и назива пројекта Your Project slogan :

Ово одговара првом реду од en/demo2/README.md :

# Demo Two : Your Project slogan

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

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

Како Преместити ТОЦ На Велико?

У директоријум изворног језика треба ставити 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 .