jaydoubleu/bicep-toolkit

Tool to generate markdown for a Bicep file

bicep-toolkit

Multi-purpose toolkit for working with Bicep files, supporting the following functionality:

• Markdown documentation generation
• Batch compilation

Usage

This tool can either be run standalone using npx, or installed as a global tool.

Usage via npx:

npx bicep-toolkit --help

Installation as a global tool:

npm install -g bicep-toolkit

Usage as a global tool:

bicep-toolkit --help

Markdown Generation

The following will generate a .md file in the same directory as the bicep file:

bicep-toolkit markdown --bicep-file <path_to_bicep>

Building

The following will build one or more .bicep files:

bicep-toolkit build --bicep-file <path_to_bicep>

Help

To view command line options, run:

bicep-toolkit --help

Customizing

Currently there are no options to tweak the format of the markdown output. However I'm very happy to take feature requests or contributions for this!