bicep-docs

Alimenta bicep-docs un archivo o directorio Bicep y analiza la plantilla o plantillas, produciendo documentación de emparejamiento en Markdown. Este flujo de trabajo de línea de comandos ayuda a los desarrolladores a crear y actualizar la documentación junto con su código de infraestructura en lugar de mantener manualmente las referencias de plantilla.

Para una entrada de directorio, bicep-docs busca recursivamente y crea un README.md junto a cada principal. Bíceps que encuentra. Una entrada de un solo fichero debe utilizar un archivo como su objetivo de salida; de lo contrario el comando reporta un error, y la salida predeterminada es README.md relativa al directorio donde se ejecuta el comando. Si el archivo de destino Markdown ya existe, está sobrescrito.

Las páginas generadas pueden contener secciones de descripción, uso, módulos, recursos, parámetros, udfs, Uddts, variables y salidas. La opción --include-sections preserva el pedido solicitado, mientras que --exclude-sections elimina las secciones nombradas de la secuencia predeterminada; las dos opciones no se pueden combinar a menos que la inclusión especifica que la secuencia por defecto completa. La bandera --show-all-decorators añade columnas de tabla para limitaciones de decorador, tales como valores permitidos, límites mínimos y máximos, y estado exportable, que se ocultan por defecto para mantener las páginas concisas.

Diseñado para autores Bicep y flujos de trabajo de desarrollo basados en terminales, se adapta a los repositorios que necesitan documentación refrescada a medida que cambian las plantillas. bicep-docs es Windows System Tools freeware de Christos Galanopoulos, actualmente en la versión 1.8.0, y requiere que el Azure CLI o el Bicep CLI funcionen.