Bizepsdokumente
1.2.0
Beschreibung
Installation
Anforderungen
Verwendung
Mitwirken
Lizenz
bicep-docs ist ein Befehlszeilentool, das Dokumentation für Bicep-Vorlagen generiert.
Brühhahn christosgalano/christosgalano brew installiere bicep-docs
Gehen Sie und installieren Sie github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest
Laden Sie die neueste Binärdatei von der Release-Seite herunter.
Um bicep-docs auszuführen, muss entweder die Azure CLI oder die Bicep CLI installiert sein.
| CLI | Mindestens erforderliche Version |
|---|---|
| Azurblau | 2.64.0 |
| Bizeps | 0,29,0 |
bicep-docs ist ein Befehlszeilentool, das Dokumentation für Bicep-Vorlagen generiert.
Bei einer gegebenen Bicep-Eingabedatei oder einem Bicep-Verzeichnis analysiert es die Datei(en) und generiert die entsprechende Dokumentation im Markdown-Format.
Damit können Sie automatisch Dokumentationen für Ihre Bicep-Vorlagen erstellen und aktualisieren.
Wenn es sich bei der Eingabe um ein Verzeichnis handelt, wird für jede main.bicep eine README.md im selben Verzeichnis generiert. Dies geschieht rekursiv für alle Unterverzeichnisse.
Wenn die Eingabe eine Bicep-Datei ist, muss die Ausgabe eine Datei sein; andernfalls wird ein Fehler zurückgegeben.
Der Standardwert für die Ausgabe ist README.md relativ zum Verzeichnis, in dem der Befehl ausgeführt wird.
ACHTUNG: Wenn die Markdown-Datei bereits vorhanden ist, wird sie überschrieben .
Bezüglich der Argumente --include-sections und --exclude-sections sind die verfügbaren Abschnitte: description , usage , modules , resources , parameters , udfs , uddts , variables und outputs .
Die standardmäßig geordneten Abschnitte lauten description,usage,modules,resources,parameters,udfs,uddts,variables,outputs . Die Standardeingabe für --exclude-sections ist '' . Dadurch ist die Abwärtskompatibilität zur Vorgängerversion gewährleistet.
Bei der Einbindung wird die Reihenfolge der Abschnitte beachtet.
Beim Ausschließen von Abschnitten sind das Ergebnis die Standardabschnitte abzüglich der ausgeschlossenen Abschnitte (z. B. --exclude-sections description,usage umfasst modules,resources,parameters,udfs,uddts,variables,outputs in dieser Reihenfolge).
Beide Argumente können nicht gleichzeitig angegeben werden, es sei denn, das Argument --include-sections ist mit den Standardabschnitten identisch (z. B. --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ). .
Analysieren Sie eine Bicep-Datei und generieren Sie eine Markdown-Datei:
bicep-docs --input main.bicep --output readme.md
Analysieren Sie eine Bicep-Datei und generieren Sie eine README.md-Datei im selben Verzeichnis:
bicep-docs -i main.bicep
Analysieren Sie ein Verzeichnis und generieren Sie eine README.md-Datei für jede main.bicep-Datei mit ausführlicher Ausgabe:
bicep-docs -i ./bicep -V
Analysieren Sie eine Bicep-Datei und generieren Sie eine README.md ohne die benutzerdefinierten Abschnitte:
bicep-docs --input main.bicep --exclude-sections udfs,uddts
Analysieren Sie eine Bicep-Datei und generieren Sie eine README.md, die nur die Ressourcen und Module in dieser Reihenfolge enthält:
bicep-docs ---input main.bicep --include-sections resources,modules
Weitere Beispiele finden Sie hier.
Die Dokumentation hat folgendes Format:
# Modulname | Dateiname## Beschreibung...## Verwendung...## Modultabelle der Module## Ressourcentabelle der Ressourcen## Parametertabelle der Parameter## Tabelle der benutzerdefinierten Datentypen (UDDTs) der UDDTs## Tabelle der benutzerdefinierten Funktionen (UDFs). von UDFS## Variablentabelle der Variablen## Ausgabetabelle der Ausgaben
Dieses Tool ist äußerst nützlich, wenn Sie dieser Struktur für Ihre Bicep-Projekte folgen:
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...Informationen zur Mitarbeit an diesem Projekt finden Sie hier.
Dieses Projekt ist unter der MIT-Lizenz lizenziert.
