doctores de bíceps
1.2.0
Descripción
Instalación
Requisitos
Uso
Contribuyendo
Licencia
bicep-docs es una herramienta de línea de comandos que genera documentación para plantillas de Bicep.
grifo de cerveza christosgalano/christosgalano instalación de cerveza bicep-docs
vaya a instalar github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest
Descargue el binario más reciente desde la página de lanzamientos.
Para ejecutar bicep-docs, se debe instalar la CLI de Azure o la CLI de Bicep.
| CLI | Versión mínima requerida |
|---|---|
| Azur | 2.64.0 |
| Bíceps | 0.29.0 |
bicep-docs es una herramienta de línea de comandos que genera documentación para plantillas de Bicep.
Dado un archivo o directorio de entrada de Bicep, analiza los archivos y genera la documentación correspondiente en formato Markdown.
Esto se puede utilizar para crear y actualizar automáticamente la documentación de sus plantillas de Bicep.
Si la entrada es un directorio, entonces para cada main.bicep generará un README.md en el mismo directorio. Esto sucede de forma recursiva para todos los subdirectorios.
Si la entrada es un archivo Bicep, la salida debe ser un archivo; de lo contrario, se devolverá un error.
El valor predeterminado para la salida es README.md , relativo al directorio donde se ejecuta el comando.
PRECAUCIÓN: Si el archivo Markdown ya existe, se sobrescribirá .
Respecto a los argumentos --include-sections y --exclude-sections , las secciones disponibles son: description , usage , modules , resources , parameters , udfs , uddts , variables , outputs .
Las secciones predeterminadas ordenadas son description,usage,modules,resources,parameters,udfs,uddts,variables,outputs . La entrada predeterminada para --exclude-sections es '' . Esto garantiza la compatibilidad con la versión anterior.
Se respeta el orden de los apartados a la hora de incluirlos.
Al excluir secciones, el resultado serán las secciones predeterminadas menos las excluidas (por ejemplo, --exclude-sections description,usage incluirá modules,resources,parameters,udfs,uddts,variables,outputs en ese orden).
Ambos argumentos no se pueden proporcionar al mismo tiempo, a menos que el argumento --include-sections sea el mismo que el de las secciones predeterminadas (por ejemplo --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ) .
Analice un archivo Bicep y genere un archivo Markdown:
bicep-docs --entrada principal.bicep --salida readme.md
Analice un archivo Bicep y genere un archivo README.md en el mismo directorio:
bicep-docs -i principal.bicep
Analice un directorio y genere un archivo README.md para cada archivo main.bicep con salida detallada:
bíceps-docs -i ./bicep -V
Analice un archivo Bicep y genere un README.md excluyendo las secciones definidas por el usuario:
bicep-docs --input main.bicep --exclude-sections udfs,uddts
Analice un archivo Bicep y genere un README.md que incluya solo los recursos y módulos en ese orden:
bicep-docs ---entrada main.bicep --incluye secciones recursos,módulos
Se pueden encontrar más ejemplos aquí.
La documentación tiene el siguiente formato:
# nombre del módulo | nombre de archivo## Descripción...## Uso...## Tabla de módulos de módulos## Tabla de recursos de recursos## Tabla de parámetros de parámetros## Tabla de tipos de datos definidos por el usuario (UDDT) de UDDT## Tabla de funciones definidas por el usuario (UDF) de UDFS## Variablestable de variables## Outputstable de salidas
Esta herramienta es extremadamente útil si sigues esta estructura para tus proyectos de Bicep:
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...Puede encontrar información sobre cómo contribuir a este proyecto aquí.
Este proyecto está bajo la licencia MIT.
