.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 को कुञ्जी थप्न वा मेटाउनुहुन्न।

० रूपरेखाको साथ 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: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 लेखिएको छैन भने, i18n को मानमा url पूर्वनिर्धारित हुन्छ। यो नियमले अन्य टेम्प्लेटहरूमा पनि प्रभाव पार्छ।

TOC सामग्रीको तालिका

यदि टेम्प्लेट use: Doc कन्फिगरेसनमा सक्षम छ भने, कृपया प्लग-इन i18n.addon/toc मा .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

सामग्री वस्तु 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 पृष्ठ प्रदर्शित हुनेछ।