# @btodell/asyncapi-html-template > HTML template for the AsyncAPI generator. Latest version **0.24.10** (published 2022-09-06) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @btodell/asyncapi-html-template pnpm add @btodell/asyncapi-html-template yarn add @btodell/asyncapi-html-template bun add @btodell/asyncapi-html-template ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: no vulnerabilities; high maintenance score. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned. ## Facts | | | |---|---| | Version | 0.24.10 | | Published | 2022-09-06 | | First published | 2022-09-06 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 7 | | Unpacked size | 750.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 94 | | Author | Fran Mendez | | Maintainers | btodell | | Keywords | asyncapi, generator, html, template | ## Links - npm: https://www.npmjs.com/package/@btodell/asyncapi-html-template - Repository: https://github.com/asyncapi/html-template - Homepage: https://github.com/asyncapi/html-template#readme - Issues: https://github.com/asyncapi/html-template/issues - npm.io page: https://npm.io/package/@btodell/asyncapi-html-template ## Dependencies (7) - [react](https://npm.io/package/react.md) ^17.0.2 - [rimraf](https://npm.io/package/rimraf.md) ^3.0.2 - [puppeteer](https://npm.io/package/puppeteer.md) ^14.1.0 - [react-dom](https://npm.io/package/react-dom.md) ^17.0.2 - [highlight.js](https://npm.io/package/highlight.js.md) 10.7.3 - [@asyncapi/parser](https://npm.io/package/@asyncapi/parser.md) ^1.15.0 - [@btodell/asyncapi-react-component](https://npm.io/package/@btodell/asyncapi-react-component.md) ^1.0.0-next.40 ## Alternatives - [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads - [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads - [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads - [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads - [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads ## Recent versions - 0.24.10 (latest) — 2022-09-06 ## README [![AsyncAPI HTML Template](assets/github-repobanner-htmltemp.png)](https://www.asyncapi.com) HTML template for the [AsyncAPI Generator](https://github.com/asyncapi/generator) using an [AsyncAPI React Component](https://github.com/asyncapi/asyncapi-react) under the hood. --- [![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-) ![npm](https://img.shields.io/npm/dm/@asyncapi/html-template?style=flat-square) --- - [Usage](#usage) - [Supported parameters](#supported-parameters) - [Development](#development) - [Contributors ✨](#contributors-%E2%9C%A8) ## Usage ```bash ag asyncapi.yaml @asyncapi/html-template -o output ``` If you don't have the AsyncAPI Generator installed, you can install it like this: ```bash 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 versioning](https://semver.org/)) | `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` | | config | Inline stringified JSON or a path to a JSON file to override default React component config. The config override is merged with the default config using the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) algorithm. | No | `{ "show": { "sidebar": true }, "sidebar": { "showOperations": "byDefault" } }` | [JSON config for the React component](https://github.com/asyncapi/asyncapi-react/blob/next/docs/configuration/config-modification.md#definition) | `{"show":{"sidebar":false}}` | > **NOTE**: 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 The HTML-Template is built with an [AsyncAPI React Component](https://github.com/asyncapi/asyncapi-react). For any changes regarding the styling of the page, rendering of the missing/existing elements, please contribute to the [AsyncAPI React Component](https://github.com/asyncapi/asyncapi-react) repository. If you want make changes in template itself, please follow: 1. Make sure you have the latest generator installed: `npm install -g @asyncapi/generator`. 1. Modify the template or its helper functions. >**NOTE:** If you have to modify the [`dummy.yml`](https://github.com/asyncapi/generator/blob/master/test/docs/dummy.yml) file to develop your features, open a PR with the changes in the [asyncapi/generator](https://github.com/asyncapi/generator) repository. 1. 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 1. Open HTML in your browser: `open ./test/output/index.html`. ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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
💻
David Weber
💻
Maciej Urbańczyk
💻 ⚠️ 🐛 🚧 👀

Lukasz Gornicki
🚧 💻 🐛 👀 ⚠️
Fran Méndez
🚧 💻 🐛 👀 ⚠️
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! --- _Source: https://npm.io/package/@btodell/asyncapi-html-template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._