https://github.com/survivorbat/azure-devops-extension-docs

Markdown generator for the documentation of Azure DevOps Pipeline extensions.
https://github.com/survivorbat/azure-devops-extension-docs

azedoc azure azure-devops azure-devops-extension-docs azuredevops azuredevopsextension devops documentation extension generate generator library markdown npm package

Last synced: 18 days ago
JSON representation

Markdown generator for the documentation of Azure DevOps Pipeline extensions.

• Host: GitHub
• URL: https://github.com/survivorbat/azure-devops-extension-docs
• Owner: survivorbat
• License: mit
• Created: 2022-06-27T15:50:28.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-19T08:48:17.000Z (almost 2 years ago)
• Last Synced: 2024-12-09T00:54:28.558Z (about 1 month ago)
• Topics: azedoc, azure, azure-devops, azure-devops-extension-docs, azuredevops, azuredevopsextension, devops, documentation, extension, generate, generator, library, markdown, npm, package
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/azure-devops-extension-docs
• Size: 521 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🪠 Azure DevOps Extension Documentation generator

[![Deploy Flow](https://github.com/survivorbat/azure-devops-extension-docs/actions/workflows/deploy.yaml/badge.svg)](https://github.com/survivorbat/azure-devops-extension-docs/actions/workflows/deploy.yaml)

![npm](https://img.shields.io/npm/dt/azure-devops-extension-docs)

![GitHub](https://img.shields.io/github/license/survivorbat/azure-devops-extension-docs)

_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 \

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/embed-in-existing).

## 🪧 Examples

Check out [the examples](./examples) to see how the markdown is generated.

## 🔭 Plans

- Better error handling