sjz / html-template

HTML template for AsyncAPI Generator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HTML template for the AsyncAPI Generator

All Contributors

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 'byTags' to categorize operations by tags. No byTags byTags
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

πŸ’»

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

About

HTML template for AsyncAPI Generator


Languages

Language:HTML 82.7%Language:JavaScript 9.2%Language:CSS 8.2%