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 |
singleFile | Set output into one html-file with styles and scripts inside | No | true ,false |
true |
outFilename | The filename of the output file. | No | Any | asyncapi.html |
Generates output HTML as PDF | No | true,false |
false |
Development
-
Make sure you have the latest generator installed:
npm install -g @asyncapi/generator
. -
Modify the template or its helper functions.
NOTE: If you have to modify the
dummy.yml
file to develop your features, open a PR with the changes in the asyncapi/generator repository. -
Generate output with watcher enabled:
npm run develop
. -
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 |
Gordeev Artem |
Mitchell Sawatzky |
Talmiz Ahmed |
Jürgen B. |
Gabriel Claudino |
Barbara Szwarc |
This project follows the all-contributors specification. Contributions of any kind welcome!