mkdocs plugin to generate pages from asyncapi spec files
Project description
Mkdocs Async API Plugin
Setup
- Install
asyncapi/generator
npm install -g @asyncapi/generator
- Install this plugin.
pip install mkdocs-asyncapi-plugin
- Add
render_asyncapi
tomkdocs.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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs-asyncapi-plugin-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e3ed9af9952263880dbc41d1e416ced70bc71da9c705e2c9192498c776cf276 |
|
MD5 | 4a63cf0872dc1478521fb885be9cbd0b |
|
BLAKE2b-256 | 1d05b68ec099c9f5b602d7cfaac840561c1c5415657a591a74552a4ad4df77e4 |
Close
Hashes for mkdocs_asyncapi_plugin-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c4a6f12f020501c36db8bb5fba66d164607b7c5fedd1bf33778bbe82d32d86f |
|
MD5 | 42c5c1ec613772a0a6a66bf392d00bf8 |
|
BLAKE2b-256 | b891f918fe6fa31ea7649eb0965cf832202f13343e86edb793274c237584094c |