Перевод документации NOC¶
NOC использует плагин mkdocs-static-i18n для перевода документации.
Добавляем перевод¶
Документация NOC хранится в наборе Markdown файлов. Перевод осуществляется независимо для каждого файла. В качестве языка по умолчанию принят английский. Чтобы добавить перевод для файла <name>.md
необходимо создать файл <name>.<language code>.md
, где <language code>
выбирается из списка:
Language | Code |
---|---|
Русский | ru |
Добавьте свой перевод в созданный файл.
Перевод изображений¶
При необходимости, можно приложить переведенные изображения, просто добавив код языка перед расширением.
Для перевода изображения image.png
добавьте файл image.<laguage code>.png
. При этом в тексте перевода можно продолжать ссылаться на изобкажение как ![...](image.png)
. Плагин mkdocs-static-i18n автоматически поправит путь.
Вклад в проект¶
После завершения работы вы можете добавить перевод в кодовую базо проекта создав Merge Request.
Todo
Добавить ссылку на гайд