GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → asyncapi → html-template

asyncapi / html-template

Licence: other
HTML template for AsyncAPI Generator

Programming Languages

javascript
184084 projects - #8 most used programming language
HTML
75241 projects

Labels

nodejshtmltemplategeneratorasyncapi

Projects that are alternatives of or similar to html-template

java-spring-cloud-stream-template
Java Spring Cloud Stream template for the AsyncAPI Generator
Stars: ✭ 26 (-31.58%)
Mutual labels:  asyncapi
jasyncapi
/jay-sync-api/ is a Java code-first tool for AsyncAPI specification
Stars: ✭ 29 (-23.68%)
Mutual labels:  asyncapi
asynction
SocketIO python framework driven by the AsyncAPI specification. Built on top of Flask-SocketIO. Inspired by Connexion.
Stars: ✭ 40 (+5.26%)
Mutual labels:  asyncapi
openapi-filter
Filter internal paths, operations, parameters, schemas etc from OpenAPI/Swagger/AsyncAPI definitions
Stars: ✭ 112 (+194.74%)
Mutual labels:  asyncapi
nestjs-asyncapi
NestJS AsyncAPI module - generate the documentation of your event-based services using decorators
Stars: ✭ 88 (+131.58%)
Mutual labels:  asyncapi
parser-go
It parses AsyncAPI documents.
Stars: ✭ 43 (+13.16%)
Mutual labels:  asyncapi
converter-go
Convert AsyncAPI documents from older to newer versions with Golang
Stars: ✭ 17 (-55.26%)
Mutual labels:  asyncapi
java-spring-template
Java Spring template for the AsyncAPI Generator
Stars: ✭ 41 (+7.89%)
Mutual labels:  asyncapi
go-watermill-template
Go template for the AsyncAPI Generator using Watermill module
Stars: ✭ 38 (+0%)
Mutual labels:  asyncapi
Spec
The AsyncAPI specification allows you to create machine-readable definitions of your asynchronous APIs.
Stars: ✭ 1,860 (+4794.74%)
Mutual labels:  asyncapi
modelina
Library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents.
Stars: ✭ 55 (+44.74%)
Mutual labels:  asyncapi
home
This is the home page for the API specification toolbox.
Stars: ✭ 16 (-57.89%)
Mutual labels:  asyncapi
boats
Beautiful Open Api Template System
Stars: ✭ 28 (-26.32%)
Mutual labels:  asyncapi
nodejs-template
Node.js template for the AsyncAPI Generator
Stars: ✭ 19 (-50%)
Mutual labels:  asyncapi
nestjs-asyncapi
Async API module for Nestjs that provides documentation generation using your existing code (similar to Nestjs swagger module)
Stars: ✭ 22 (-42.11%)
Mutual labels:  asyncapi
wsapix
Next generation Websocket framework for nodejs
Stars: ✭ 17 (-55.26%)
Mutual labels:  asyncapi
python-paho-template
Python Paho template for the AsyncAPI generator
Stars: ✭ 17 (-55.26%)
Mutual labels:  asyncapi
event-gateway
AsyncAPI Event Gateway
Stars: ✭ 35 (-7.89%)
Mutual labels:  asyncapi

AsyncAPI HTML Template

HTML template for the AsyncAPI Generator using an AsyncAPI React Component under the hood.

All Contributors

npm

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

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. For any changes regarding the styling of the page, rendering of the missing/existing elements, please contribute to the AsyncAPI React Component 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.

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

  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
💻
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 specification. Contributions of any kind welcome!

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].