bicep-docs

Füttern Sie bicep-docs eine Bicep-Datei oder ein Bicep-Verzeichnis und analysieren Sie die Vorlage oder Vorlagen, wodurch eine übereinstimmende Dokumentation in Markdown erstellt wird. Dieser Befehlszeilen-Workflow hilft Entwicklern, Dokumentation neben ihrem Infrastrukturcode zu erstellen und zu aktualisieren, anstatt Vorlagenreferenzen manuell zu pflegen.

Für eine Verzeichniseingabe sucht bicep-docs rekursiv und erstellt neben jedem Main eine README.md. Bizeps findet er. Eine Single-File-Eingabe muss eine Datei als Ausgabeziel verwenden; Andernfalls meldet der Befehl einen Fehler und die Standardausgabe ist README.md relativ zu dem Verzeichnis, in dem der Befehl ausgeführt wird. Wenn die Ziel-Markdown-Datei bereits existiert, wird sie überschrieben.

Generierte Seiten können Beschreibung, Nutzung, Module, Ressourcen, Parameter, udfs, uddts, Variablen und Ausgabeabschnitte enthalten. Die Option --include-sections behält die angeforderte Reihenfolge bei, während --exclude-sections benannte Abschnitte aus der Standardsequenz entfernt; die beiden Optionen können nicht kombiniert werden, es sei denn, die Einbeziehung gibt die vollständige Standardsequenz an. Das Flag --show-all-decorators fügt Tabellenspalten für Dekorateureinschränkungen wie zulässige Werte, minimale und maximale Grenzen und exportierbaren Status hinzu, die standardmäßig ausgeblendet werden, um Seiten kurz zu halten.

Entwickelt für Bicep-Autoren und Terminal-basierte Entwicklungs-Workflows, passt es zu Repositories, die eine Aktualisierung der Dokumentation benötigen, wenn sich Vorlagen ändern. bicep-docs ist Windows System Tools Freeware von Christos Galanopoulos, derzeit Version 1.8.0, und erfordert entweder die Azure CLI oder die Bicep CLI.