https://github.com/mtso/docusaurus-asyncapi

Async API for Docusaurus V3
https://github.com/mtso/docusaurus-asyncapi

asyncapi docusaurus typescript

Last synced: 5 months ago
JSON representation

Async API for Docusaurus V3

• Host: GitHub
• URL: https://github.com/mtso/docusaurus-asyncapi
• Owner: mtso
• Created: 2023-11-01T06:24:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-09-04T08:21:14.000Z (9 months ago)
• Last Synced: 2025-09-30T05:21:24.907Z (9 months ago)
• Topics: asyncapi, docusaurus, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/docusaurus-asyncapi
• Size: 1.47 MB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# docusaurus-asyncapi

[![npm version](https://badge.fury.io/js/docusaurus-asyncapi.svg)](https://badge.fury.io/js/docusaurus-asyncapi)

Async API Documentation for Docusaurus V3.

![docusaurus-asyncapi example screenshot](./example/static/img/docusaurus-asyncapi-example-screenshot-0.png)

## Installation

```

npm install docusaurus-asyncapi

```

## Usage

```js

// docusaurus.config.js

const config = {

  presets: [

    [

      "docusaurus-asyncapi",

      {

        specs: [

          {

            spec: "path/to/asyncapi.yml",

            route: "/asyncapi",

          },

        ],

        // See defaults for ConfigInterface at:

        // https://github.com/asyncapi/asyncapi-react/blob/42a349ad/library/src/config/default.ts#L7

        config: {

          show: {

            sidebar: true,

          },

        },

      },

    ],

    ...

  ],

  ...

}

module.exports = config;

```

## Local Development

### Requirements

- node >=v18

### Building Example

```

npm install --workspaces

npm run build --workspaces

cd example

npm start

```

This builds the packages and starts the local docusaurus server.