.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
కి అనుగుణంగా ఉంటుంది, ఈ ఫైల్ పేరుకు పెద్ద అక్షరం ఉపసర్గ మరియు చిన్న అక్షర ప్రత్యయం అవసరం).
0 అవుట్లైన్ లేకుండా 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
ఖాళీలు ఉండకూడదు.
పై పారామితుల కోసం, సంబంధిత డైరెక్టరీ ఇండెక్స్ ఫైల్:
ఒకే ప్రాజెక్ట్ బహుళ ఫైల్లు
మీకు ఒక ప్రాజెక్ట్ మాత్రమే ఉంటే, మీరు దానిని ఈ క్రింది విధంగా కాన్ఫిగర్ చేయవచ్చు.
- i18n: doc
url: flashduty
use: Doc
[!WARN]
బహుళ ఫైల్లతో ఒకే ప్రాజెక్ట్ url
రూట్ పాత్ /
గా కాన్ఫిగర్ చేయడానికి మద్దతు ఇవ్వదు
conf.yml nav: nav:
ఈ డిజైన్ ప్రాజెక్ట్ డాక్యుమెంట్లు, బ్లాగులు మరియు ఇతర కంటెంట్లను డైరెక్టరీల ద్వారా బాగా వేరు చేయడానికి ఉద్దేశించబడింది.
ఒకే ఫైల్ మరియు ఒకే పేజీని హోమ్ పేజీగా ఉపయోగించాలని సిఫార్సు చేయబడింది.
[!TIP]
url
వ్రాయబడకపోతే, i18n
విలువకు url
డిఫాల్ట్ అవుతుంది. ఈ నియమం ఇతర టెంప్లేట్లకు కూడా ప్రభావం చూపుతుంది.
TOC విషయ సూచిక సూచిక
కాన్ఫిగరేషన్లో టెంప్లేట్ use: Doc
ప్రారంభించబడితే, దయచేసి .i18n/conf.yml
లో ప్లగ్-ఇన్ i18n.addon/toc
ప్రారంభించండి. కాన్ఫిగరేషన్ క్రింది విధంగా ఉంటుంది :
addon:
- i18n.addon/toc
i18n.site
ఈ ప్లగ్-ఇన్ని స్వయంచాలకంగా ఇన్స్టాల్ చేసి, అమలు చేస్తుంది, TOC
డైరెక్టరీ ఇండెక్స్ ఫైల్ను చదవండి మరియు json
డైరెక్టరీ అవుట్లైన్ను రూపొందిస్తుంది.
ఇది బహుళ ఫైల్లతో ఒకే ప్రాజెక్ట్ అయితే, మూల భాష డైరెక్టరీలోని url:
కి సంబంధించిన డైరెక్టరీ TOC
, ఉదాహరణకు, మూల భాష చైనీస్ అయితే: 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
కంటెంట్ en/demo2/README.md
వంటి అంశం README.md
లో వ్రాయవచ్చు.
ఈ ఫైల్ యొక్క కంటెంట్ విషయ సూచిక అవుట్లైన్ను చూపదని గుర్తుంచుకోండి, కాబట్టి నిడివిని పరిమితం చేసి చిన్న పరిచయాన్ని వ్రాయమని సిఫార్సు చేయబడింది.
ప్రాజెక్ట్ నినాదం
డ్రాప్-డౌన్ మెను మరియు కేటలాగ్ అవుట్లైన్ ప్రాజెక్ట్ పేరు Your Project slogan
క్రింద దాని ప్రాజెక్ట్ Deme Two
ఉందని మీరు చూడవచ్చు :
ఇది 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
పేజీ ప్రదర్శించబడుతుంది.