bicep-docs

Кормите bicep-docs файлом или каталогом Bicep, и он анализирует шаблон или шаблоны, создавая соответствующую документацию в Markdown. Этот рабочий процесс командной строки помогает разработчикам создавать и обновлять документацию вместе с кодом инфраструктуры, а не вручную поддерживать ссылки на шаблоны.

Для ввода каталога bicep-docs выполняет рекурсивный поиск и создает README.md рядом с каждым основным. Бицепс находит. Однофайловый ввод должен использовать файл в качестве цели вывода; в противном случае команда сообщает об ошибке, а выход по умолчанию - README.md относительно каталога, в котором выполняется команда. Если файл Markdown уже существует, он перезаписывается.

Генерированные страницы могут содержать описание, использование, модули, ресурсы, параметры, udfs, uddts, переменные и выходные разделы. Опция -include-sections сохраняет запрашиваемый порядок, в то время как -exclude-sections удаляет названные разделы из последовательности по умолчанию; эти два варианта не могут быть объединены, если включение не указывает эту полную последовательность по умолчанию. Флаг -show-all-decorators добавляет столбцы для ограничений декоратора, таких как разрешенные значения, минимальные и максимальные пределы и экспортируемый статус, которые скрыты по умолчанию для краткости страниц.

Разработанный для авторов Bicep и рабочих процессов разработки на основе терминалов, он подходит для репозиториев, которые нуждаются в обновлении документации по мере изменения шаблонов. bicep-docs - это бесплатная программа Windows System Tools от Christos Galanopoulos, которая в настоящее время находится на версии 1.8.0 и требует запуска Azure CLI или Bicep CLI.