二头肌文档
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，其中仅按顺序包含资源和模块：
二头肌docs ---输入main.bicep-包括式资源，模块
更多示例可以在这里找到。
该文档具有以下格式：
# 模块名称 |文件名##说明... ##用法... ##模块的模块可##资源的资源##参数参数##参数##用户定义的数据类型（UDDTS）uddts ##用户定义功能（udfs）表UDFS##变量变量稳定##输出输出稳定
如果您的二头肌项目遵循以下结构，则该工具非常有用：
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...有关为该项目做出贡献的信息可以在此处找到。
该项目已获得 MIT 许可证的许可。
