Перевод документации

Чтобы сделать Axios доступным для большего количества людей, важно, чтобы эти документы можно было читать на всех языках. Мы всегда ценим каждого, кто хочет помочь перевести документацию. Данное руководство содержит инструкции по добавлению перевода в эту документацию.

Структура

Каждый перевод состоит из файла конфигурации, {language-shortcut}.lang.js (например, en.lang.js или de.lang.js) и переведенных файлов документации в posts/{language-shortcut}/*.md (например, posts/en или posts/de). {language-shortcut} следует заменить двухбуквенным кодом вашего языка ISO 639-1.

Настройка вашего языка

• Скопируйте en.lang.js.
• Переименуйте его в {language-shortcut}.lang.js.
• Замените display названием вашего языка на вашем языке. Например, если вы переводите на немецкий язык, вместо "немецкого" поставьте "Deutsch".
• Замените префикс /{language-shortcut}/.
• Переведите значения в полях p и t.
• Переведите все свйоства с отметкой text на боковой панели. Примечание: Начиная с последней версии документации, ссылки на боковой панели больше не требуют обновления.

Регистрация конфигурации

После завершения настройки языка и перевода фраз и ссылок в файле конфигурации необходимо зарегистрировать его в корневой конфигурации. Для этого откройте inert.config.js и добавьте следующую строку сверху:

const {language-shortcut}Config = require('./{language-shortcut}.config.js');

Конечно, не забудьте заменить {language-shortuct} правильным кодом ISO 639-1 (также в названии переменной!).

Теперь ищите константу langs. Если эта константа находится над оператором require, переместите его над ним. В список langs добавьте следующий объект:

const langs = [
  ...
  {
    name: 'Some name that uniquely identifies your language, for example "English" or "German"',
    prefix: "The same prefix as in the configuration file",
    config: {language-shortcut}Config // Объект конфигурации, импортированный ранее
  }
  ...
];

Теперь можно начать перевод файлов. Скопируйте папку posts/en в новую папку posts/{language-shortcut} и переведите все файлы (конечно, не переводите названия файлов).

Если у вас возникли проблемы, не стесняйтесь создать issue.