bicep-docs

Feed bicep-docs a Bicep file or directory and it parses the template or templates, producing matching documentation in Markdown. This command-line workflow helps developers create and update documentation alongside their infrastructure code instead of maintaining template references manually.

For a directory input, bicep-docs searches recursively and creates a README.md beside every main.bicep it finds. A single-file input must use a file as its output target; otherwise the command reports an error, and the default output is README.md relative to the directory where the command runs. If the destination Markdown file already exists, it is overwritten.

Generated pages can contain description, usage, modules, resources, parameters, udfs, uddts, variables, and outputs sections. The --include-sections option preserves the requested order, while --exclude-sections removes named sections from the default sequence; the two options cannot be combined unless inclusion specifies that complete default sequence. The --show-all-decorators flag adds table columns for decorator constraints such as allowed values, minimum and maximum limits, and exportable status, which are hidden by default to keep pages concise.

Designed for Bicep authors and terminal-based development workflows, it suits repositories that need documentation refreshed as templates change. bicep-docs is Windows System Tools freeware from Christos Galanopoulos, currently at version 1.8.0, and requires either the Azure CLI or the Bicep CLI to run.