🪠 Azure DevOps Extension Documentation generator
Also known as azedoc
Markdown generator for the documentation of Azure DevOps Pipeline extensions.
We use the vss-extension.json
together with any task.json
files to generate
a overview of the extension from a template.
⬇️ Installation
npm i -g azure-devops-extension-docs
📋 Usage
azedoc generate <extension-directory>
Generates a markdown file using the vss-extension.json and task.json files.
Options
-
--output
: Allows you to specify the output file -
--template
: Allows you to specify a custom handlebars template to use -
--exclude
: Exclude one or more values from the output, ex.:--exclude extension.version --exclude tasks.id
You can also embed the generated markdown into an already existing file, check out this example.
🪧 Examples
Check out the examples to see how the markdown is generated.
🔭 Plans
- Better error handling