bicep-docs

Feed bicep-docs um arquivo ou diretório Bícep e analisa o modelo ou modelos, produzindo documentação correspondente no Markdown. Este fluxo de trabalho de linha de comando ajuda os desenvolvedores a criar e atualizar documentação ao lado de seu código de infraestrutura em vez de manter referências de modelo manualmente.

Para uma entrada de diretório, bicep-docs busca recursivamente e cria um README.md ao lado de cada principal. Bíceps encontra. Uma entrada de arquivo único deve usar um arquivo como seu alvo de saída; caso contrário, o comando reporta um erro, e a saída padrão é README.md em relação ao diretório onde o comando é executado. Se o arquivo Markdown de destino já existe, ele é substituído.

As páginas geradas podem conter seções de descrição, uso, módulos, recursos, parâmetros, udfs, uddts, variáveis e saídas. A opção --include-sections preserva a ordem solicitada, enquanto --exclude-sections remove as seções nomeadas da sequência padrão; as duas opções não podem ser combinadas a menos que a inclusão especifique essa sequência padrão completa. A bandeira --show-all-decorators adiciona colunas de tabela para restrições de decoradores, tais como valores permitidos, limites mínimos e máximos, e status exportável, que estão ocultos por padrão para manter as páginas concisas.

Projetado para autores do Bíceps e fluxos de trabalho de desenvolvimento baseados em terminais, ele atende repositórios que precisam de documentação atualizada como mudança de modelos. bicep-docs é Windows System Tools freeware de Christos Galanopoulos, atualmente na versão 1.8.0, e requer o Azure CLI ou o Bicep CLI para ser executado.