M3lkior / 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 Default 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 undefined byTags, byTagsNoRoot byTagsNoRoot
baseHref Sets the base URL for links and forms. No / Any /docs
version Override the version of your application provided under info.version location in the specification file. No Version is taken from the spec file. Any (See Semver versionning) 1.0.0
singleFile Set output into one html-file with styles and scripts inside No false true,false true
outFilename The filename of the output file. No index.html Any asyncapi.html
pdf Generates output HTML as PDF No false true,false false

If you only generate an html website, set the environment variable PUPPETEER_SKIP_CHROMIUM_DOWNLOAD to true and the generator will skip downloading chromium.

Development

  1. Make sure you have the latest generator installed: npm install -g @asyncapi/generator.

  2. 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.

  3. Adjust styling and generate tailwind.min.css with npm run generate:assets

  4. Generate output with watcher enabled: npm run develop.

    NOTE: If your changes are not visible, this is maybe because the ag use the already installed html-template so you should use the --install option

    • run npm run develop:install
    • if command failed, delete the cached html-template module in your system and re-rerun the command
  5. 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

📖

Julian S.

💻

Ludovic Dussart

💻

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

About

HTML template for AsyncAPI Generator


Languages

Language:HTML 62.7%Language:JavaScript 29.9%Language:CSS 7.4%