.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

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 म्हणजे Toc टेम्प्लेट वापरून रेंडरिंग, जे एकच Markdown टेम्प्लेट रेंडर करत आहे.

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/conf.yml इन i18n:doc चे कॉन्फिगरेशन मल्टी-प्रोजेक्ट मल्टी-फाइल रेंडरिंग मोड आहे.

येथे, 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 लिहिलेले नसेल, तर i18n च्या मूल्यावर url डिफॉल्ट असेल. हा नियम इतर टेम्पलेटसाठी देखील लागू होतो.

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

पातळी दर्शविण्यासाठी इंडेंटेशन वापरा

वरील 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 पृष्ठ प्रदर्शित केले जाईल.