.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 .

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 , знову запустити i18n.site у каталозі md , а потім відвідати URL попереднього перегляду розробки, щоб спостерігати за змінами на домашній сторінці.

use: Blog Шаблонів Блогів

Шаблон блогу відображає список статей (назви та анотації) у порядку часу публікації.

→ Натисніть тут, щоб дізнатися про конкретну конфігурацію

0Шаблони 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 Це правило також діє для інших шаблонів.

Покажчик Змісту Змісту

Якщо в конфігурації ввімкнено шаблон 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 .