.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 en/i18n.yml -де home: Home ге сәйкес келеді (мұнда en - жоба аудармасының бастапқы тілі).

en/i18n.yml мазмұны - конфигурациядағы fromTo ге сәйкес аударылатын, мысалы, zh/i18n.yml ге аударылатын шарлау мәзірінде көрсетілетін мәтін.

Аударма аяқталғаннан кейін yml аудармасының мәнін өзгертуге болады, бірақ yml аудармасының кілтін қоспаңыз немесе жоймаңыз.

0Сұлбасы Бар use: Toc Құжат Үлгісі

nav :

  - i18n: home
    use: Toc
    url: /

use: Toc жалғыз Markdown үлгіні көрсететін Toc үлгіні пайдаланып көрсетуді білдіреді.

TOC — Table of Contents аббревиатурасы. Бұл үлгі көрсетілгенде, осы Markdown файлдың контуры бүйірлік тақтада көрсетіледі.

url: Markdown файлының жолын білдіреді ( / түбірлік каталогқа сәйкес келеді /README.md , бұл файл атауы бас әріптер префиксін және кіші әріптерді қажет етеді).

use: Md Құжат Үлгісі

Md үлгісі мен Toc үлгісі бірдей және екеуі де бір Markdown файлды көрсету үшін пайдаланылады. Бірақ Md үлгі бүйірлік тақтада контурды көрсетпейді.

Жоғарыдағы конфигурациядағы use: Toc use: Md мәніне өзгертуге, md каталогында i18n.site қайта іске қосуға, содан кейін басты беттегі өзгерістерді бақылау үшін әзірлеуді алдын ала қарау URL мекенжайына кіруге болады.

use: Blog Блог Үлгілері

Блог үлгісі мақалалар тізімін (тақырыптар мен тезистер) жариялану уақытының ретімен көрсетеді.

→ Арнайы конфигурация туралы білу үшін осы жерді басыңыз

use: Doc Файлдық Құжат Үлгілері

Конфигурация файлында:

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

Үлгі көрсету үшін Doc мәнін пайдалануды көрсетеді.

Doc үлгісі бір немесе бірнеше жобалар үшін құжат контурларын жасау үшін бірнеше MarkDown біріктіруді қолдайды.

Бірнеше Жобалар Және Бірнеше Файлдар

i18n:doc -де .i18n/conf.yml конфигурациясы - көп жобалы көп файлды көрсету режимі.

Мұнда 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: Түбір жолы конфигурацияланбаса, веб-сайттың басты бетіне кіру кезінде ол nav: конфигурациясының астындағы бірінші URL мекенжайына автоматты түрде қайта жазылады. Бұл дизайн каталогтар арқылы жобалық құжаттарды, блогтарды және басқа мазмұнды жақсырақ ажыратуға арналған. Негізгі бет ретінде бір файлды және бір бетті пайдалану ұсынылады.

[!TIP] Егер url жазылмаса, url әдепкі i18n мәніне орнатылады. Бұл ереже басқа үлгілер үшін де күшіне енеді.

TOC Мазмұнының Индексі

Егер конфигурацияда use: Doc үлгісі қосылған болса, i18n.addon/toc in .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

Деңгейлерді Көрсету Үшін Шегінісін Пайдаланыңыз

Жоғарыдағы en/blog/TOC -дің бірінші жолындағы README.md төмендегі суреттегі i18n.site ге сәйкес келеді, бұл жоба атауы.

Келесі екі жол төмендегі скриншотта көрсетілгендей.

news/README.md News -ге сәйкес келеді, news/begin.md Our Product is Online ! -ге сәйкес келеді

TOC файлдары контурдың иерархиялық қатынасын, көп деңгейлі шегіністерді және # ден басталатын жол түсініктемелерін қолдау үшін шегініспен жазылған.

Негізгі Деңгей Мазмұнды Емес, Тақырыпты Ғана Жазады.

Шегіністің бірнеше деңгейі болған кезде, басты деңгей мазмұнды емес, тақырыпты ғана жазады. Әйтпесе, типография бұзылады.

README.md Жобасы

Мазмұнды en/demo2/README.md сияқты README.md тармағында жазуға болады.

Бұл файлдың мазмұны мазмұн кестесін көрсетпейтінін ескеріңіз, сондықтан ұзындықты шектеп, қысқаша кіріспе жазу ұсынылады.

Жоба Ұраны

Ашылмалы мәзір мен каталог контурының жобасының атауы Your Project slogan астында Deme Two жобаның негізгі сызығы бар екенін көруге болады :

Бұл 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 бет көрсетіледі.