上腕二頭筋のドキュメント
1.2.0
説明
インストール
要件
使用法
貢献する
ライセンス
bicep-docs は、 Bicep テンプレートのドキュメントを生成するコマンドライン ツールです。
ブリュータップ クリストスガラノ/クリストスガラノ 醸造インストール二頭筋ドキュメント
github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest をインストールしてください
リリース ページから最新のバイナリをダウンロードします。
bicep-docs を実行するには、Azure CLI または Bicep CLI のいずれかがインストールされている必要があります。
| CLI | 最低限必要なバージョン |
|---|---|
| アズール | 2.64.0 |
| 上腕二頭筋 | 0.29.0 |
bicep-docs は、Bicep テンプレートのドキュメントを生成するコマンドライン ツールです。
入力 Bicep ファイルまたはディレクトリを指定すると、ファイルを解析し、対応するドキュメントを Markdown 形式で生成します。
これを使用して、Bicep テンプレートのドキュメントを自動的に作成および更新できます。
入力がディレクトリの場合、 main.bicepごとに同じディレクトリにREADME.mdが生成されます。これはすべてのサブディレクトリに対して再帰的に発生します。
入力が Bicep ファイルの場合、出力はファイルである必要があります。それ以外の場合は、エラーが返されます。
出力のデフォルト値はREADME.mdで、コマンドが実行されるディレクトリに対する相対値です。
注意: Markdown ファイルがすでに存在する場合は上書きされます。
引数--include-sectionsおよび--exclude-sectionsに関して、使用可能なセクションは次のとおりです: description 、 usage 、 modules 、 resources 、 parameters 、 udfs 、 uddts 、 variables 、 outputs 。
順序付けされるデフォルトのセクションはdescription,usage,modules,resources,parameters,udfs,uddts,variables,outputsです。 --exclude-sectionsのデフォルトの入力は''です。 これにより、以前のバージョンとの下位互換性が確保されます。
セクションを含める場合、セクションの順序が尊重されます。
セクションを除外すると、結果はデフォルトのセクションから除外されたセクションを除いたものになります (例: --exclude-sections description,usage modules,resources,parameters,udfs,uddts,variables,outputsがこの順で含まれます)。
--include-sections引数がデフォルトのセクションと同じでない限り、両方の引数を同時に指定することはできません (例: --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs )。 。
Bicep ファイルを解析し、Markdown ファイルを生成します。
bicep-docs --input main.bicep --output readme.md
Bicep ファイルを解析し、同じディレクトリに README.md ファイルを生成します。
bicep-docs -i main.bicep
ディレクトリを解析し、詳細な出力を含む各 main.bicep ファイルの README.md ファイルを生成します。
二頭筋-docs -i ./二頭筋 -V
Bicep ファイルを解析し、ユーザー定義セクションを除いた README.md を生成します。
bicep-docs --input main.bicep --exclude-sections udfs,uddts
Bicep ファイルを解析し、リソースとモジュールのみをこの順序で含む README.md を生成します。
bicep-docs ---input main.bicep --include-sections リソース、モジュール
その他の例はここでご覧いただけます。
ドキュメントの形式は次のとおりです。
# モジュール名 |ファイル名## 説明...## 使用法...## モジュール モジュールのテーブル## リソース リソースのテーブル## パラメータ パラメータのテーブル## UDDT のユーザー定義データ型 (UDDT) テーブル## ユーザー定義関数 (UDF) テーブルUDFS## の変数変数の安定テーブル## 出力出力の安定テーブル
このツールは、Bicep プロジェクトで次の構造に従っている場合に非常に役立ちます。
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...このプロジェクトへの貢献に関する情報はここでご覧いただけます。
このプロジェクトは MIT ライセンスに基づいてライセンスされています。
