bicep docs
1.2.0
Description
Installation
Exigences
Usage
Contribuer
Licence
bicep-docs est un outil en ligne de commande qui génère de la documentation pour les modèles Bicep.
robinet d'infusion christosgalano/christosgalano Brew installer biceps-docs
allez installer github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest
Téléchargez le dernier binaire depuis la page des versions.
Pour exécuter bicep-docs, Azure CLI ou Bicep CLI doivent être installés.
| CLI | Version minimale requise |
|---|---|
| Azuré | 2.64.0 |
| Biceps | 0.29.0 |
bicep-docs est un outil en ligne de commande qui génère de la documentation pour les modèles Bicep.
Étant donné un fichier ou un répertoire Bicep d'entrée, il analyse le(s) fichier(s) et génère la documentation correspondante au format Markdown.
Cela peut être utilisé pour créer et mettre à jour automatiquement la documentation de vos modèles Bicep.
Si l'entrée est un répertoire, alors pour chaque main.bicep elle générera un README.md dans le même répertoire. Cela se produit de manière récursive pour tous les sous-répertoires.
Si l'entrée est un fichier Bicep, la sortie doit être un fichier ; sinon, une erreur sera renvoyée.
La valeur par défaut de la sortie est README.md , relative au répertoire dans lequel la commande est exécutée.
ATTENTION : Si le fichier Markdown existe déjà, il sera écrasé .
Concernant les arguments --include-sections et --exclude-sections , les sections disponibles sont : description , usage , modules , resources , parameters , udfs , uddts , variables , outputs .
Les sections par défaut ordonnées sont description,usage,modules,resources,parameters,udfs,uddts,variables,outputs . L'entrée par défaut pour --exclude-sections est '' . Cela garantit une compatibilité descendante avec la version précédente.
L'ordre des sections est respecté lors de leur inclusion.
Lors de l'exclusion de sections, le résultat sera les sections par défaut moins celles exclues (par exemple --exclude-sections description,usage inclura modules,resources,parameters,udfs,uddts,variables,outputs dans cet ordre).
Les deux arguments ne peuvent pas être fournis en même temps, à moins que l'argument --include-sections soit le même que les sections par défaut (par exemple --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ) .
Analysez un fichier Bicep et générez un fichier Markdown :
bicep-docs --input main.bicep --output readme.md
Analysez un fichier Bicep et générez un fichier README.md dans le même répertoire :
bicep-docs -i main.bicep
Analysez un répertoire et générez un fichier README.md pour chaque fichier main.bicep avec une sortie détaillée :
bicep-docs -i ./bicep -V
Analysez un fichier Bicep et générez un README.md excluant les sections définies par l'utilisateur :
bicep-docs --input main.bicep --exclude-sections udfs,uddts
Analysez un fichier Bicep et générez un README.md incluant uniquement les ressources et les modules dans cet ordre :
bicep-docs ---input main.bicep --include-sections ressources, modules
D’autres exemples peuvent être trouvés ici.
La documentation a le format suivant :
# nom du module | nom du fichier## Description...## Utilisation...## Modulestable des modules## Ressourcestableau des ressources## Paramètrestable des paramètres## Table des types de données définis par l'utilisateur (UDDT) des UDDT## Table des fonctions définies par l'utilisateur (UDF) de UDFS## Variablestable des variables## Sortiestable des sorties
Cet outil est extrêmement utile si vous suivez cette structure pour vos projets Bicep :
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...Des informations sur la contribution à ce projet peuvent être trouvées ici.
Ce projet est sous licence MIT.
