HTML template for the AsyncAPI Generator

Usage

ag asyncapi.yaml @asyncapi/html-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	Allowed values	Example
sidebarOrganization	Defines how the sidebar should be organized. Set its value to byTagsNoRoot to categorize operations by operations tags. Set its value to byTags when you have tags on a root level. These tags are used to model tags navigation and need to have the same tags in operations.	No	byTags, byTagsNoRoot	byTagsNoRoot
baseHref	Sets the base URL for links and forms.	No	Any	/docs

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 develop.
4. Open HTML in your browser open ./test/output/index.html.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

James Crowley 💻 🐛

Waleed Ashraf 💻 🐛

Julian Rabe 💻

Sebastián ⚠️ 💻

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