Overview:

The AsyncAPI HTML Template is a HTML template for the AsyncAPI Generator. It utilizes an AsyncAPI React Component to generate the HTML output. The template allows the user to customize various parameters such as the organization of the sidebar, the base URL for links and forms, the version of the application, and more. The template can also generate output as a PDF and provides options for overriding default configuration. Development of the template can be done by contributing to the AsyncAPI React Component repository.

Features:

• AsyncAPI React Component: The HTML template uses an AsyncAPI React Component under the hood for generating the HTML output.
• Customizable Parameters: Users can customize various parameters such as sidebar organization, base URL, version, output file name, and more.
• PDF Generation: The template has the ability to generate output as a PDF.
• Config Override: Users can override default configuration by providing inline stringified JSON or a path to a JSON file.
• Development Support: The template is built with an AsyncAPI React Component and allows for contribution and modification for styling and rendering.

Installation:

To install the AsyncAPI Generator, use the following command:

npm install -g @asyncapi/generator

To modify the template or its helper functions, follow these steps:

1. Make sure you have the latest generator installed:

npm install -g @asyncapi/generator

2. Modify the template or its helper functions.
3. Generate output with watcher enabled:

npm run develop

4. If your changes are not visible, try running:

npm run develop:install

5. If the command fails, delete the cached html-template module in your system and retry the command.
6. Open HTML in your browser:

open ./test/output/index.html

Summary:

The AsyncAPI HTML Template is a customizable HTML template for the AsyncAPI Generator. It uses an AsyncAPI React Component to generate the HTML output and provides options to customize parameters, generate output as a PDF, and override default configuration. Development of the template can be done by making changes to the AsyncAPI React Component.