.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 კონფიგურაციას, როგორც root გზა / თუ conf.yml nav: არ არის კონფიგურირებული root ბილიკი, ვებსაიტის მთავარ გვერდზე შესვლისას ის ავტომატურად გადაიწერება პირველ URL-ზე nav: კონფიგურაციის ქვეშ. ეს დიზაინი არის საპროექტო დოკუმენტების, ბლოგების და სხვა შინაარსის უკეთ გარჩევა დირექტორიების მეშვეობით. რეკომენდირებულია გამოიყენოთ ერთი ფაილი და ერთი გვერდი, როგორც მთავარი გვერდი.

[!TIP] თუ url არ არის დაწერილი, url ნაგულისხმევი იქნება i18n -ის მნიშვნელობა. ეს წესი ასევე მოქმედებს სხვა შაბლონებზე.

TOC Სარჩევის Ინდექსი

თუ შაბლონი use: Doc ჩართულია კონფიგურაციაში, გთხოვთ, ჩართოთ დანამატი i18n.addon/toc .i18n/conf.yml ში. კონფიგურაცია შემდეგია :

addon:
  - i18n.addon/toc

i18n.site ავტომატურად დააინსტალირებს და შეასრულებს ამ დანამატს, წაიკითხავს TOC დირექტორიას ინდექსის ფაილს და შექმნის json დირექტორიას.

თუ ეს არის ერთი პროექტი მრავალი ფაილით, root დირექტორია 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 გვერდი.