二頭肌文檔
1.2.0
描述
安裝
要求
用法
貢獻
執照
bicep-docs是一個命令列工具，可產生 Bicep 範本的文件。
克里斯多斯加拉諾釀造龍頭 釀造安裝二頭肌文檔
去安裝 github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest
從發布頁面下載最新的二進位。
要執行 bicep-docs，必須安裝 Azure CLI 或 Bicep CLI。
| 命令列介面 | 所需的最低版本 |
|---|---|
| 天藍色 | 2.64.0 |
| 二頭肌 | 0.29.0 |
bicep-docs 是一個命令列工具，可產生 Bicep 範本的文件。
給定輸入 Bicep 檔案或目錄，它會解析檔案並產生 Markdown 格式的對應文件。
這可用於自動建立和更新二頭肌模板的文件。
如果輸入是一個目錄，那麼對於每個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 --輸入 main.bicep --輸出 readme.md
解析 Bicep 檔案並在同一目錄中產生 README.md 檔案：
二頭肌文檔-i main.bicep
解析目錄並為每個 main.bicep 文件產生一個 README.md 文件，並帶有詳細輸出：
二頭肌文檔-i ./bicep -V
解析 Bicep 檔案並產生 README.md（不包括使用者定義的部分）：
bicep-docs --輸入 main.bicep --排除部分 udfs、uddts
解析 Bicep 檔案並產生 README.md，其中僅按順序包含資源和模組：
bicep-docs ---input main.bicep --include-sections 資源、模組
更多範例可以在這裡找到。
該文件具有以下格式：
# 模組名稱 |檔案名稱## 說明...## 用法...## 模組模組表## 資源資源表## 參數參數表## 使用者定義資料型別(UDDT) UDDT 表## 使用者定義函數(UDF) 表UDFS ##變數變數穩定##輸出輸出穩定
如果您的二頭肌項目遵循以下結構，則該工具非常有用：
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...有關為該項目做出貢獻的資訊可以在此處找到。
該項目已獲得 MIT 許可證的許可。
