Создание проекта

Создать проект документации можно с помощью команды yfm init.

По умолчанию, команда запускает интерактивный режим ввода параметров — настройки проекта задаются последовательно.

При передаче --skip-interactive запускается ручной режим, в котором доступны следующие параметры:

• --output, -o — путь до директории для выходных данных (по умолчанию - текущая папка);
• --langs языки — список языков документации, разделенных запятыми (по умолчанию — "en");
• --default-lang язык — язык по умолчанию (если не указывать — берется первый из списка langs);
• --name имя — название проекта, подставляемое в заголовок оглавления (по умолчанию — название директории с проектом);
• --header — включить расширенную навигацию в проекте;
• --force — перезаписывать содержимое папки, если в ней есть файлы;
• --template шаблон — шаблон создаваемого проекта: minimal (по умолчанию) или full;
• --dry-run — показывать только то, что будет создано в результате вызова, вместо создания проекта.

# пример вызова без интерактивного режима
yfm init --skip-interactive -o ./output-folder --name example --langs ru,en

Актуальный список параметров инициализации можно вывести в консоли командой yfm init --help.