Skip to content

Markdown template for the AsyncAPI Generator

Notifications You must be signed in to change notification settings

asyncapi/markdown-template

Repository files navigation

Markdown template for the AsyncAPI Generator

All Contributors

Usage

Install AsyncAPI CLI

npm install -g @asyncapi/cli

Generate using CLI

asyncapi generate fromTemplate <asyncapi.yaml> @asyncapi/markdown-template@1.2.1

You can replace <asyncapi.yaml> with local path or URL pointing to any AsyncAPI document. Look into Releases of this template to pick up the version you need. It is not recommended to always use the latest in production. Always use a specific version.

Supported parameters

Name Description Required Default Allowed values Example
frontMatter The name of a JSON or YAML formatted file containing values to provide the YAML frontmatter for static-site or documentation generators, just like this one. The file may contain {{title}} and {{version}} tags. They are replaced with information for the AsyncAPI document that is under info.title and info.version. You can overwrite the version with version parameter. Here you can see an example that uses tags in frontmatter compatible with slate No None Any JSON or YAML formatted file slate.yaml
outFilename The filename of the output file. No asyncapi.md Any with .md extension index.md
toc Include a Table-of-Contents in the output markdown. No true boolean false
version Override the version of your application provided under info.version location in the specification file. No Version is taken from the specification file. Version is taken from the spec file. 1.0.0

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.

Parameters for the template are defined in package.json.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Fran Méndez
Fran Méndez

💻 📖 👀 🤔 🚧 🐛 ⚠️
Lukasz Gornicki
Lukasz Gornicki

💻 📖 👀 🚇 🚧 🐛 ⚠️
Ilya Buzlov
Ilya Buzlov

💻 🐛
Julian Rabe
Julian Rabe

💻
Maciej Urbańczyk
Maciej Urbańczyk

📖 💻 🚧 🐛 👀 ⚠️
Ludovic Dussart
Ludovic Dussart

💻
Mike Ralphson
Mike Ralphson

💻
stuartforrest-infinity
stuartforrest-infinity

🐛 💻
Dale Lane
Dale Lane

💻 🤔
Michael Gerischer
Michael Gerischer

💻 🐛 ⚠️
Arya Gupta
Arya Gupta

📖
Kirill Efimov
Kirill Efimov

💻 ⚠️

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