bicep-docs

bicep-docs を Bicep ファイルやディレクトリに送り、テンプレートやテンプレートを解析し、Markdown で一致するドキュメントを作成します。 このコマンド・ライン・ワークフローは、テンプレート・リファレンスを手動で維持する代わりに、開発者がインフラストラクチャ・コードとともにドキュメントを作成および更新するのに役立ちます。

ディレクトリの入力では、bicep-docs は再帰的に検索し、すべてのメインの横にある README.md を作成します。 見つけるbicep。 単一ファイル入力は、その出力対象としてファイルを使用する必要があります。 それ以外の場合は、コマンドはエラーを報告し、デフォルト出力は、コマンドが実行するディレクトリに対して README.md です。 すでにMarkdownファイルが存在している場合、それは上書きです。

生成されたページには、説明、使用法、モジュール、リソース、パラメータ、udfs、uddts、変数、および出力セクションを含むことができます。 --include-sections オプションは、リクエストされた順番を保存します。 --exclude-sections は、デフォルトシーケンスから名前付けられたセクションを削除します。 2 つのオプションは、コンクルードが、デフォルトのシーケンスを満たさない限り結合できません。 --show-all-decorators フラグは、許可された値、最小限、最大限、およびエクスポート可能なステータスなどのデコレータ制約の表列を追加します。これにより、ページを簡潔に保つことができます。

Bicepの作者とターミナルベースの開発ワークフロー用に設計された、テンプレート変更として更新されたドキュメントが必要なリポジトリに適しています。 bicep-docsは、Christos GalanopoulosからWindowsシステムツールフリーウェアで、バージョン1.8.0で、Azure CLIまたはBicep CLIを実行する必要があります。