bicep-docs

Feed bicep-docs un fichier ou répertoire Bicep et il analyse le ou les modèles, produisant la documentation correspondante dans Markdown. Ce flux de travail en ligne de commande aide les développeurs à créer et à mettre à jour la documentation parallèlement à leur code d'infrastructure au lieu de maintenir les références de modèles manuellement.

Pour une entrée de répertoire, bicep-docs recherche récursivement et crée un README.md à côté de chaque main. Bicep qu'il trouve. Une entrée de fichier unique doit utiliser un fichier comme cible de sortie; sinon la commande signale une erreur, et la sortie par défaut est README.md par rapport au répertoire où la commande tourne. Si le fichier Markdown de destination existe déjà, il est écrasé.

Les pages générées peuvent contenir des sections description, utilisation, modules, ressources, paramètres, udfs, uddts, variables et sorties. L'option --include-sections conserve l'ordre demandé, tandis que --exclude-sections supprime les sections nommées de la séquence par défaut; les deux options ne peuvent être combinées que si l'inclusion spécifie cette séquence par défaut complète. Le drapeau --show-all-decorators ajoute des colonnes de table pour les contraintes de décorateur telles que les valeurs autorisées, les limites minimales et maximales, et le statut exportable, qui sont cachés par défaut pour garder les pages concises.

Conçu pour les auteurs Bicep et les workflows de développement basés sur terminal, il convient aux dépôts qui ont besoin de documentation rafraîchie à mesure que les modèles changent. bicep-docs est un logiciel gratuit pour Windows System Tools de Christos Galanopoulos, actuellement à la version 1.8.0, et nécessite soit l'Azure CLI ou le Bicep CLI pour fonctionner.