Генерування документів

Друге призначення configlet - генерування документів.

Використання

Команду generate можна використати, щоб згенерувати документи з інструкціями та вступами з шаблону.

configlet [global-options] generate

Global options:
  -h, --help                   Show this help message and exit
      --version                Show this tool's version information and exit
  -t, --track-dir <dir>        Specify a track directory to use instead of the current directory
  -v, --verbosity <verbosity>  The verbosity of output. Allowed values: q[uiet], n[ormal], d[etailed]

Документи

Ось документи, які configlet вміє генерувати.

Документ: файл introduction.md концептуальної вправи

Кожна концептуальна вправа має файл introduction.md. Кожна вправа також може мати необовʼязковий файл introduction.md.tpl.

Файл шаблону слід сприймати як звичайний файл Markdown, але з однією додатковою можливістю: вказувати заповнювачі. Підтримуються такі заповнювачі:

• %{concept:<slug>}: посилається на документ introduction.md цієї концепції

Коли configlet виявляє, що концептуальна вправа має файл introduction.md.tpl, він генерує з нього файл introduction.md. Згенерований вступ матиме той самий вміст, що й шаблон, за винятком заповнювачів, які буде замінено вмістом документів, на які вони вказують.

Документ: файл introduction.md практичної вправи

Коли configlet виявляє, що практична вправа реалізує вправу з Problem Specifications, яка має файл introduction.md, він синхронізує файл .meta/introduction.md практичної вправи з файлом introduction.md вправи з Problem Specifications.

Документ: файл instructions.md практичної вправи

Коли configlet виявляє, що практична вправа реалізує вправу з Problem Specifications, він синхронізує файл .meta/instructions.md практичної вправи або з файлом instructions.md цієї вправи з Problem Specifications, або, якщо файлу instructions.md не знайдено, з її файлом description.md.

Документ: файл .meta/config.json практичної вправи

Коли configlet виявляє, що практична вправа реалізує вправу з Problem Specifications, він синхронізує взяті з файлу metadata.yml ключі source і source_url вправи з Problem Specifications з однойменними властивостями практичної вправи у її файлі .meta/config.json.