.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 Բլոգի Կաղապարներ

Բլոգի ձևանմուշը ցուցադրում է հոդվածների ցանկը (վերնագրերը և ամփոփագրերը) ըստ հրապարակման ժամանակի:

→ Սեղմեք այստեղ՝ կոնկրետ կոնֆիգուրացիայի մասին իմանալու համար

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: Ոչ մի արմատային ուղի կազմաձևված չէ, վեբ կայքի գլխավոր էջ մուտք գործելիս այն ինքնաբերաբար կվերագրվի առաջին URL-ին nav: կոնֆիգուրացիայի տակ: Այս դիզայնը նպատակ ունի ավելի լավ տարբերակել ծրագրի փաստաթղթերը, բլոգները և այլ բովանդակությունը գրացուցակների միջոցով: Որպես գլխավոր էջ խորհուրդ է տրվում օգտագործել մեկ ֆայլ և մեկ էջ:

[!TIP] Եթե url գրված չէ, url լռելյայն նշանակում է i18n ի արժեքը: Այս կանոնը գործում է նաև այլ ձևանմուշների համար:

TOC Բովանդակության Ինդեքս

Եթե use: Doc ձևանմուշը միացված է կազմաձևում, խնդրում ենք միացնել plug-in-ը i18n.addon/toc ը .i18n/conf.yml ում: Կազմաձևը հետևյալն է :

addon:
  - i18n.addon/toc

i18n.site ավտոմատ կերպով կտեղադրի և կգործարկի այս plug-in-ը, կկարդա 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

Բովանդակությունը կարող է գրվել 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 էջը: