документы на бицепс
1.2.0
Описание
Установка
Требования
Использование
Содействие
Лицензия
bicep-docs — это инструмент командной строки, который генерирует документацию для шаблонов Bicep.
кран для заваривания christosgalano/christosgalano варить установку бицепс-документов
иди и установи github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest
Загрузите последнюю версию двоичного файла со страницы выпусков.
Для запуска bicep-docs необходимо установить Azure CLI или Bicep CLI.
| интерфейс командной строки | Минимальная необходимая версия |
|---|---|
| Лазурный | 2.64.0 |
| Бицепс | 0.29.0 |
bicep-docs — это инструмент командной строки, который генерирует документацию для шаблонов Bicep.
Учитывая входной файл или каталог Bicep, он анализирует файл(ы) и генерирует соответствующую документацию в формате Markdown.
Это можно использовать для автоматического создания и обновления документации для ваших шаблонов бицепсов.
Если входными данными является каталог, то для каждого main.bicep будет создан файл README.md в том же каталоге. Это происходит рекурсивно для всех подкаталогов.
Если входные данные представляют собой файл Bicep, выходные данные должны быть файлом; в противном случае будет возвращена ошибка.
Значение по умолчанию для вывода — README.md относительно каталога, в котором выполняется команда.
ВНИМАНИЕ. Если файл Markdown уже существует, он будет перезаписан .
Что касается аргументов --include-sections и --exclude-sections , доступны следующие разделы: description , usage , modules , resources , parameters , udfs , uddts , variables , outputs .
По умолчанию упорядочены следующие разделы: description,usage,modules,resources,parameters,udfs,uddts,variables,outputs . По умолчанию для --exclude-sections используется '' . Это обеспечивает обратную совместимость с предыдущей версией.
Порядок разделов при их включении соблюдается.
При исключении разделов результатом будут разделы по умолчанию минус исключенные (например, --exclude-sections description,usage будет включать modules,resources,parameters,udfs,uddts,variables,outputs в указанном порядке).
Оба аргумента не могут быть предоставлены одновременно, если только аргумент --include-sections не совпадает с разделами по умолчанию (например, --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ). .
Разберите файл Bicep и создайте файл Markdown:
bicep-docs --input main.bicep --output readme.md
Разберите файл Bicep и создайте файл README.md в том же каталоге:
бицепс-документы -i main.bicep
Проанализируйте каталог и сгенерируйте файл README.md для каждого файла main.bicep с подробным выводом:
бицепс-документы -i ./бицепс -V
Разберите файл Bicep и сгенерируйте README.md, исключая определяемые пользователем разделы:
bicep-docs --input main.bicep --exclude-sections udfs,uddts
Разберите файл Bicep и сгенерируйте README.md, включающий только ресурсы и модули в следующем порядке:
bicep-docs ---input main.bicep --include-sections resources,modules
Больше примеров можно найти здесь.
Документация имеет следующий формат:
# имя модуля | имя файла## Описание...## Использование...## Таблица модулей## Таблица ресурсов## Таблица параметров## Таблица пользовательских типов данных (UDDT) для UDDT## Таблица пользовательских функций (UDF) UDFS## Переменнаятаблица переменных## Выходнаятаблица выходов
Этот инструмент чрезвычайно полезен, если вы следуете этой структуре в своих проектах по бицепсу:
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...Информацию об участии в этом проекте можно найти здесь.
Этот проект распространяется по лицензии MIT.
