.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 тәрҗемә ачкычын кушмагыз яки бетермәгез.

`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` Блог Шаблоннары

Блог шаблоны бастырылган вакыт тәртибендә мәкаләләр исемлеген (исемнәр һәм тезислар) күрсәтә.

Specific Конкрет конфигурация турында белү өчен монда басыгыз

`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 , кадәр һәм аннан соң ** урыннар булырга тиеш түгел.

Aboveгарыдагы параметрлар өчен тиешле каталог индексы файлы:

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/conf.yml i18n.addon/toc нче плагинны эшләгез. Конфигурация түбәндәгечә :

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

Дәрәҗәләрне Күрсәтү Өчен Индуктивлык Кулланыгыз

Aboveгарыдагы en/blog/TOC беренче рәтендәге README.md түбәндәге рәсемдәге i18n.site туры килә, бу проект исеме.

Киләсе ике юл түбәндәге скриншотта күрсәтелгәнчә.

news/README.md News туры килә, news/begin.md Our Product is Online ! туры килә

TOC файл планның иерархик бәйләнешен күрсәтү, күп дәрәҗә индуктивлыкны хуплау, # башлап сызык аңлатмалары.

Ата-Аналар Дәрәҗәсе Эчтәлекне Түгел, Исемне Генә Яза.

Берничә дәрәҗә индуктивлык булганда, ата-аналар дәрәҗәсе эчтәлекне түгел, ә исемне язалар. Otherwiseгыйсә, типография буталыр.

Проект README.md

Эчтәлек en/demo2/README.md кебек 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 бит күрсәтеләчәк.