documentos de bíceps
1.2.0
Descrição
Instalação
Requisitos
Uso
Contribuindo
Licença
bicep-docs é uma ferramenta de linha de comando que gera documentação para modelos Bicep.
torneira de cerveja christosgalano/christosgalano preparar instalação de bíceps-docs
vá instalar github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest
Baixe o binário mais recente na página de lançamentos.
Para executar bicep-docs, a CLI do Azure ou a CLI do Bicep devem estar instaladas.
| CLI | Versão Mínima Requerida |
|---|---|
| Azul | 2.64.0 |
| Bíceps | 0,29,0 |
bicep-docs é uma ferramenta de linha de comando que gera documentação para modelos Bicep.
Dado um arquivo ou diretório de entrada do Bicep, ele analisa o(s) arquivo(s) e gera a documentação correspondente no formato Markdown.
Isso pode ser usado para criar e atualizar automaticamente a documentação para seus modelos Bicep.
Se a entrada for um diretório, então para cada main.bicep será gerado um README.md no mesmo diretório. Isso acontece recursivamente para todos os subdiretórios.
Se a entrada for um arquivo Bicep, a saída deverá ser um arquivo; caso contrário, um erro será retornado.
O valor padrão para a saída é README.md , relativo ao diretório onde o comando é executado.
CUIDADO: Se o arquivo Markdown já existir, ele será substituído .
Em relação aos argumentos --include-sections e --exclude-sections , as seções disponíveis são: description , usage , modules , resources , parameters , udfs , uddts , variables , outputs .
As seções padrão ordenadas são description,usage,modules,resources,parameters,udfs,uddts,variables,outputs . A entrada padrão para --exclude-sections é '' . Isso garante compatibilidade retroativa com a versão anterior.
A ordem das seções é respeitada ao incluí-las.
Ao excluir seções, o resultado serão as seções padrão menos as excluídas (por exemplo, --exclude-sections description,usage incluirá modules,resources,parameters,udfs,uddts,variables,outputs nessa ordem).
Ambos os argumentos não podem ser fornecidos ao mesmo tempo, a menos que o argumento --include-sections seja o mesmo que as seções padrão (por exemplo --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ) .
Analise um arquivo Bicep e gere um arquivo Markdown:
bicep-docs --input main.bicep --output readme.md
Analise um arquivo Bicep e gere um arquivo README.md no mesmo diretório:
bicep-docs -i principal.bicep
Analise um diretório e gere um arquivo README.md para cada arquivo main.bicep com saída detalhada:
bicep-docs -i ./bicep -V
Analise um arquivo Bicep e gere um README.md excluindo as seções definidas pelo usuário:
bicep-docs --input main.bicep --exclude-sections udfs,uddts
Analise um arquivo Bicep e gere um README.md incluindo apenas os recursos e módulos nesta ordem:
bicep-docs ---input main.bicep --include-sections recursos, módulos
Mais exemplos podem ser encontrados aqui.
A documentação tem o seguinte formato:
# nome do módulo | nome do arquivo## Descrição...## Uso...## Tabela de módulos de módulos## Tabela de recursos de recursos## Tabela de parâmetros de parâmetros## Tabela de tipos de dados definidos pelo usuário (UDDTs) de UDDTs## Tabela de funções definidas pelo usuário (UDFs) de UDFS## Variávelestável de variáveis## Saídaestável de saídas
Esta ferramenta é extremamente útil se você estiver seguindo esta estrutura para seus projetos Bicep:
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...Informações sobre como contribuir para este projeto podem ser encontradas aqui.
Este projeto está licenciado sob a licença MIT.
