{"_id":"@btodell/asyncapi-html-template","name":"@btodell/asyncapi-html-template","dist-tags":{"latest":"0.24.10"},"versions":{"0.24.10":{"name":"@btodell/asyncapi-html-template","version":"0.24.10","description":"HTML template for the AsyncAPI generator.","keywords":["asyncapi","generator","html","template"],"author":{"name":"Fran Mendez","email":"fmvilas@gmail.com","url":"fmvilas.com"},"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/asyncapi/html-template.git"},"bugs":{"url":"https://github.com/asyncapi/html-template/issues"},"homepage":"https://github.com/asyncapi/html-template#readme","scripts":{"lint":"echo \"No linter specified yet\"","release":"semantic-release","develop":"npm run generate:assets && ag https://raw.githubusercontent.com/asyncapi/generator/v1.1.5/test/docs/dummy.yml ./ -o test/output --force-write --watch-template","//develop:install":"Force ag to install your local html-template source code","develop:install":" npm run develop -- --install","generate:assets":"npm run copy:sources && npm run generate:readme:toc","generate:readme:toc":"markdown-toc -i README.md","bump:version":"npm --no-git-tag-version --allow-same-version version $VERSION","copy:sources":"node ./scripts/copy-sources.js","prepublishOnly":"npm run generate:assets","test":"jest --coverage"},"publishConfig":{"access":"public"},"dependencies":{"@asyncapi/parser":"^1.15.0","@btodell/asyncapi-react-component":"^1.0.0-next.40","highlight.js":"10.7.3","puppeteer":"^14.1.0","react":"^17.0.2","react-dom":"^17.0.2","rimraf":"^3.0.2"},"devDependencies":{"@semantic-release/commit-analyzer":"^8.0.1","@semantic-release/github":"^7.0.4","@semantic-release/npm":"^7.0.3","@semantic-release/release-notes-generator":"^9.0.1","conventional-changelog-conventionalcommits":"^4.2.3","cross-env":"^7.0.3","jest":"^26.6.3","jest-esm-transformer":"^1.0.0","markdown-toc":"^1.2.0","semantic-release":"^19.0.3"},"release":{"branches":["master"],"plugins":[["@semantic-release/commit-analyzer",{"preset":"conventionalcommits"}],["@semantic-release/release-notes-generator",{"preset":"conventionalcommits"}],"@semantic-release/npm","@semantic-release/github"]},"generator":{"parameters":{"sidebarOrganization":{"description":"Defines how the sidebar should be organized. 'byTags' to categorize operations by tags in the root of the document, `byTagsNoRoot` does the same but for pub/sub tags.","required":false},"baseHref":{"description":"Sets the base URL for links and forms.","required":false},"version":{"description":"Override the version of your application provided under `info.version` location in the specification file.","required":false},"singleFile":{"description":"If set this parameter to true generate single html file with scripts and styles inside","required":false,"default":false},"outFilename":{"description":"The name of the output HTML file","default":"index.html","required":false},"pdf":{"description":"Set to `true` to get index.pdf generated next to your index.html","default":false},"config":{"description":"Stringified JSON or a path to a JSON file to override the 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.","default":"","required":false}},"generator":">=1.8.27 <2.0.0","nonRenderableFiles":["js/asyncapi-ui.min.js"]},"jest":{"transform":{"\\.m?jsx?$":"jest-esm-transformer"}},"gitHead":"af68f807a86fd4b8c74cc8965e66792303d34efe","_id":"@btodell/asyncapi-html-template@0.24.10","_nodeVersion":"16.15.1","_npmVersion":"8.10.0","dist":{"integrity":"sha512-Im4EWadaW3Zg0bMlOatZCVDXpOChZzSPROnpi1I5Ys26AEF4nKAMfXfuqY9D1jwVmv9BF2SNkbvvz8fX6sT9XA==","shasum":"b530997b52f196375c77903c13a46bcf591bb2ae","tarball":"https://registry.npmjs.org/@btodell/asyncapi-html-template/-/asyncapi-html-template-0.24.10.tgz","fileCount":15,"unpackedSize":768904,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGElR++D2f2SmSzuk/LlEziiWY2wzKZsu5/liFJOzG4NAiEA5W+62iq+seV+tL7dTL2PaXAijxLJQlrn2GGbAIi62xE="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjF2a8ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrP5Q//cfngSZqdFhu6WvU/Vl+tvV5xxqexEagqmk3hAWBhU3d1OZXe\r\nNVVx6+rz6n40/DI2h2jApk6zAQDA+LJNW3yJrTGaQzMzTgqenerio5Jkk6Rp\r\nDjPSGq6etlwkgeeGALFYixdfNNNkzVO52bBL2YQ7uQaXe5E9q60C0Egeo6Jo\r\n1JLgcY6bHWJ0zvg/MW9I1hgPquzxhMJlRl4JVrwQQEtNRuAtf3rmIxdxKZnD\r\nNxDL/SJn9iDh4xo7N1uS1V87H8BXHnQ19EdF9hMal5w8cofFQirNvB0qhgwh\r\nvzAvkzJmAZHTvQIFVDnj1fNxovg09wep8JH+yjxG52WH3ZKUxgrRAfxgU6Bs\r\ntZ46SYv8vN7LKACvbOT3m1LJefMD6hKrqZSfPX5JN1XOMeLLK7NX9ILg5JBr\r\ncn8IaH8yRniEpnvO2YfXf0PddQr9N0tQStaKSIfXD7TP2hS24gq4iJKUDxU0\r\ntmjCydc+2OlkaESH1GcE0WOOQ88T13HfVAK5o4S4Bluwg3Q+6br1SkeIb+gd\r\n/fgYiKIyEmNNU61DE9DtGo4uF34ksMxrA/wDZkYjTcwWTITeTT5kqUpczbVo\r\n5lIvPRiRNGXx226Jn2aMZcTlSuTS7d9vLkSen5QGmhocErbF0VVNx37/PRJ9\r\ncPmwpzecBB3mlJdvNVQPnq86PK0sX4PFGoA=\r\n=Q4Vl\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"btodell","email":"btodell@hotmail.com"},"directories":{},"maintainers":[{"name":"btodell","email":"btodell@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/asyncapi-html-template_0.24.10_1662478012541_0.1651715441616901"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-06T15:26:52.468Z","0.24.10":"2022-09-06T15:26:52.821Z","modified":"2022-09-06T15:26:52.968Z"},"maintainers":[{"name":"btodell","email":"btodell@hotmail.com"}],"description":"HTML template for the AsyncAPI generator.","homepage":"https://github.com/asyncapi/html-template#readme","keywords":["asyncapi","generator","html","template"],"repository":{"type":"git","url":"git+https://github.com/asyncapi/html-template.git"},"author":{"name":"Fran Mendez","email":"fmvilas@gmail.com","url":"fmvilas.com"},"bugs":{"url":"https://github.com/asyncapi/html-template/issues"},"license":"Apache-2.0","readme":"[![AsyncAPI HTML Template](assets/github-repobanner-htmltemp.png)](https://www.asyncapi.com)\r\n\r\nHTML template for the [AsyncAPI Generator](https://github.com/asyncapi/generator) using an [AsyncAPI React Component](https://github.com/asyncapi/asyncapi-react) under the hood.\r\n\r\n---\r\n\r\n\r\n[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)\r\n\r\n![npm](https://img.shields.io/npm/dm/@asyncapi/html-template?style=flat-square)\r\n\r\n---\r\n\r\n\n\n\n\n- [Usage](#usage)\n- [Supported parameters](#supported-parameters)\n- [Development](#development)\n- [Contributors ✨](#contributors-%E2%9C%A8)\n\n\n\n## Usage\r\n\r\n```bash\r\nag asyncapi.yaml @asyncapi/html-template -o output\r\n```\r\n\r\nIf you don't have the AsyncAPI Generator installed, you can install it like this:\r\n\r\n```bash\r\nnpm install -g @asyncapi/generator\r\n```\r\n\r\n## Supported parameters\r\n\r\n| Name | Description | Required | Default | Allowed values | Example |\r\n|---|---|---|---|---|---|\r\n| 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` |\r\n| baseHref | Sets the base URL for links and forms. | No | `/` | *Any* | `/docs` |\r\n| 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` |\r\n| singleFile | Set output into one html-file with styles and scripts inside | No | `false` | `true`,`false` | `true` |\r\n| outFilename | The filename of the output file. | No | `index.html` | *Any* | `asyncapi.html` |\r\n| pdf | Generates output HTML as PDF | No | `false` | `true,false` | `false` |\r\n| 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}}` |\r\n\r\n> **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.\r\n\r\n## Development\r\n\r\nThe 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.\r\n\r\nIf you want make changes in template itself, please follow:\r\n\r\n1. Make sure you have the latest generator installed: `npm install -g @asyncapi/generator`.\r\n1. Modify the template or its helper functions. \r\n\r\n >**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.\r\n\r\n1. Generate output with watcher enabled: `npm run develop`.\r\n \r\n >**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\r\n > * run `npm run develop:install`\r\n > * if command failed, delete the cached `html-template` module in your system and re-rerun the command\r\n \r\n1. Open HTML in your browser: `open ./test/output/index.html`.\r\n\r\n## Contributors ✨\r\n\r\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\r\n\r\n\r\n\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\"\"/
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
🚧 πŸ’» πŸ› πŸ‘€ ⚠️
\r\n\r\n\r\n\r\n\r\n\r\n\r\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","readmeFilename":"README.md"}