Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.04 KB

README.md

File metadata and controls

30 lines (22 loc) · 1.04 KB

Asciidoctor template for the AsyncAPI Generator

All Contributors

Based on https://github.com/asyncapi/markdown-template

Usage

ag asyncapi.yaml @michalmela/asyncapi-asciidoctor-template -o output

If you don't have the AsyncAPI Generator installed, you can install it like this:

npm install -g @asyncapi/generator

Supported parameters

Name Description Required Default Example
outFilename The filename of the output file. No asyncapi.md index.md

Development

  1. Make sure you have the latest generator installed npm install -g @asyncapi/generator.
  2. Modify the template or it's helper functions. Adjust test/spec/asyncapi.yml to have more features if needed.
  3. Generate output with watcher enables npm run dev.
  4. Check generated markdown file located in ./test/output/asyncapi.md.