.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 , ולאחר מכן לבקר בכתובת האתר של התצוגה המקדימה של הפיתוח כדי לצפות בשינויים בדף הבית.

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: אין נתיב שורש מוגדר, בעת גישה לדף הבית של האתר, הוא ייכתב אוטומטית לכתובת ה-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 יוצג.