mkdocs-asyncapi-tag-plugin 0.6.0

MkDocs plugin to embed AsyncAPI HTML viewer in your markdown file.

mkdocs-asyncapi-plugin

The mkdocs-asyncapi-plugin helps render AsyncAPI schemas in your MkDocs markdown pages. It uses the AsyncAPI Standalone React component to render your AsyncAPI schema files. This plugin supports both .json and .yml files.

Installation

To install the plugin, run:

pip install mkdocs-asyncapi-tag-plugin

Then, include the plugin in the plugins property of your mkdocs.yml file:

    plugins:
        - asyncapi

Usage

To render your schema, use the in your markdown files:

    <asyncapi-tag src="/path/to/schema.json"/>

Accepted values

In addition to the src attribute, the following attributes can be used with the <asyncapi-tag>:

Action	Attribute	Accepted values
Show or hide	sidebar	true or false
Show or hide	info	true or false
Show or hide	servers	true or false
Show or hide	operations	true or false
Show or hide	messages	true or false
Show or hide	schemas	true or false
Show or hide	errors	true or false
expand or collapse	messageExamples	true or false
sidebar configuration	showServers	byDefault or bySpecTags or byServersTags
sidebar configuration	showOperations	byDefault or bySpecTags or byServersTags
asyncapi parser configuration	parserOptions	See available options here
label customization	publishLabel	Any string value
label customization	subscribeLabel	Any string value