M3lkior / markdown-template

Markdown template for the AsyncAPI Generator

Markdown template for the AsyncAPI Generator

Usage

ag asyncapi.yaml @asyncapi/markdown-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 reusable parts. Adjust test/spec/asyncapi.yml to have more complexity if needed.
3. Generate output with watcher enabled by running the command npm run dev.
4. Check generated markdown file located in ./test/output/asyncapi.md.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Fran Méndez 💻 📖 👀 🤔

Lukasz Gornicki 💻 📖 👀 🚇

Ilya Buzlov 💻 🐛

Julian Rabe 💻

Maciej Urbańczyk 📖 💻

This project follows the all-contributors specification. Contributions of any kind welcome!