.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/conf.yml
σε i18n:doc
είναι η λειτουργία απόδοσης πολλών αρχείων πολλών έργων.
Εδώ, menu: NB demo1,demo2
, σημαίνει ότι χρησιμοποιείτε το πρότυπο NB
για την απόδοση του αναπτυσσόμενου μενού.
NB
, που είναι η συντομογραφία του Name Breif
, σημαίνει ότι το αναπτυσσόμενο μενού μπορεί να εμφανίσει το όνομα και το σλόγκαν του έργου.
NB
ακολουθείται από την παράμετρο demo1,demo2
που μεταβιβάζεται σε αυτό.
: ** Δεν πρέπει να υπάρχουν κενά ** πριν και μετά το κόμμα ,
στο demo1,demo2
.
Για τις παραπάνω παραμέτρους, το αντίστοιχο αρχείο ευρετηρίου καταλόγου είναι:
Ένα Έργο Πολλαπλά Αρχεία
Εάν έχετε μόνο ένα έργο, μπορείτε να το διαμορφώσετε ως εξής.
- i18n: doc
url: flashduty
use: Doc
[!WARN]
Το μεμονωμένο έργο με πολλά αρχεία δεν υποστηρίζει τη διαμόρφωση url
ως ριζικής διαδρομής /
conf.yml → nav: Δεν έχει ρυθμιστεί η διαδρομή ρίζας, κατά την πρόσβαση στην αρχική σελίδα του ιστότοπου, θα ξαναγραφεί αυτόματα στην πρώτη διεύθυνση URL κάτω από τη διαμόρφωση nav:
.
Αυτός ο σχεδιασμός είναι για να διακρίνει καλύτερα τα έγγραφα έργου, τα ιστολόγια και άλλο περιεχόμενο μέσω καταλόγων.
Συνιστάται η χρήση ενός μόνο αρχείου και μιας σελίδας ως αρχική σελίδα.
[!TIP]
Εάν δεν είναι γραμμένο url
, url
ορίζει την τιμή του i18n
Αυτός ο κανόνας ισχύει και για άλλα πρότυπα.
Ευρετήριο Πίνακα Περιεχομένων 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
Χρησιμοποιήστε Εσοχή Για Να Υποδείξετε Τα Επίπεδα
README.md
στην πρώτη σειρά του en/blog/TOC
παραπάνω αντιστοιχεί στο 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
σελίδα.