Mkdocs Async API Plugin

Setup

1. Install asyncapi/generator

npm install -g @asyncapi/generator

2. Install this plugin.

pip install mkdocs-asyncapi-plugin

3. Add render_asyncapi to mkdocs.yml:

plugins:
  - render_asyncapi

Usage

Create a new markdown file which contains only this line:

!!asyncapi <path-to-spec-file>!!

path-to-spec-file is the path to the AsyncAPI spec file relative to the root of the repository (where you run mkdocs).

Then, the entire content of this file will be the AsyncAPI spec.