# mkdocs-asyncapi-plugin
The `mkdocs-asyncapi-tag-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:
```sh
pip install mkdocs-asyncapi-tag-plugin
```
Then, include the plugin in the `plugins` property of your `mkdocs.yml` file:
```sh
plugins:
- asyncapi-tag
```
## Usage
To render your schema, use the <asyncapi-tag> in your markdown files:
```HTML
<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](https://github.com/asyncapi/parser-js/blob/master/API.md#module_@asyncapi/parser..parse) |
| label customization | `publishLabel` | Any string value |
| label customization | `subscribeLabel` | Any string value |
Raw data
{
"_id": null,
"home_page": "https://github.com/Weesho-Lapara/mkdocs-asyncapi-tag-plugin",
"name": "mkdocs-asyncapi-tag-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "mkdocs asyncapi, asyncapi render markdown",
"author": "Weesho Lapara",
"author_email": "support@weesholapara.com",
"download_url": "https://files.pythonhosted.org/packages/6e/5e/571cafc404947e07162d5a3e2d02a32b2b59c9204af9089db4dc2d2e14fd/mkdocs-asyncapi-tag-plugin-0.9.0.tar.gz",
"platform": null,
"description": "# mkdocs-asyncapi-plugin\n\nThe `mkdocs-asyncapi-tag-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.\n\n## Installation\n\nTo install the plugin, run:\n\n```sh\npip install mkdocs-asyncapi-tag-plugin\n```\n\nThen, include the plugin in the `plugins` property of your `mkdocs.yml` file:\n\n```sh\n plugins:\n - asyncapi-tag\n```\n\n## Usage\n\nTo render your schema, use the <asyncapi-tag> in your markdown files:\n\n```HTML\n <asyncapi-tag src=\"/path/to/schema.json\"/>\n```\n\n## Accepted values\nIn addition to the `src` attribute, the following attributes can be used with the `<asyncapi-tag>`:\n\n| Action | Attribute | Accepted values |\n|---|---|---|\n| Show or hide | `sidebar` | `true` or `false` |\n| Show or hide | `info` | `true` or `false` |\n| Show or hide | `servers` | `true` or `false` |\n| Show or hide | `operations` | `true` or `false` |\n| Show or hide | `messages` | `true` or `false` |\n| Show or hide | `schemas` | `true` or `false` |\n| Show or hide | `errors` | `true` or `false` |\n| expand or collapse | `messageExamples` | `true` or `false` |\n| sidebar configuration| `showServers` | `byDefault` or `bySpecTags` or `byServersTags` |\n| sidebar configuration| `showOperations` | `byDefault` or `bySpecTags` or `byServersTags` |\n| asyncapi parser configuration | `parserOptions` | See available [options here](https://github.com/asyncapi/parser-js/blob/master/API.md#module_@asyncapi/parser..parse) |\n| label customization | `publishLabel` | Any string value |\n| label customization | `subscribeLabel` | Any string value |\n\n",
"bugtrack_url": null,
"license": null,
"summary": "MkDocs plugin to embed AsyncAPI HTML viewer in your markdown file.",
"version": "0.9.0",
"project_urls": {
"Homepage": "https://github.com/Weesho-Lapara/mkdocs-asyncapi-tag-plugin"
},
"split_keywords": [
"mkdocs asyncapi",
" asyncapi render markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20933f2d24b67c6ab4f3d1ae3e13e90a13021490c1259f092fddc654c12fb63c",
"md5": "33ac8c37481ce2dfe16ae52802337b64",
"sha256": "986fb514ba345d0f65a0ceccd72189796feb076076140d36509903383c1dbc99"
},
"downloads": -1,
"filename": "mkdocs_asyncapi_tag_plugin-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33ac8c37481ce2dfe16ae52802337b64",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6196,
"upload_time": "2024-11-26T03:03:20",
"upload_time_iso_8601": "2024-11-26T03:03:20.848246Z",
"url": "https://files.pythonhosted.org/packages/20/93/3f2d24b67c6ab4f3d1ae3e13e90a13021490c1259f092fddc654c12fb63c/mkdocs_asyncapi_tag_plugin-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e5e571cafc404947e07162d5a3e2d02a32b2b59c9204af9089db4dc2d2e14fd",
"md5": "6a4aa6f7cca08d75b9a14b7c50cd6b06",
"sha256": "804690c4552791ba16b2143631e911ab8db56248c41b0510a8719f3f362a3303"
},
"downloads": -1,
"filename": "mkdocs-asyncapi-tag-plugin-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "6a4aa6f7cca08d75b9a14b7c50cd6b06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5475,
"upload_time": "2024-11-26T03:03:22",
"upload_time_iso_8601": "2024-11-26T03:03:22.542526Z",
"url": "https://files.pythonhosted.org/packages/6e/5e/571cafc404947e07162d5a3e2d02a32b2b59c9204af9089db4dc2d2e14fd/mkdocs-asyncapi-tag-plugin-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 03:03:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Weesho-Lapara",
"github_project": "mkdocs-asyncapi-tag-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-asyncapi-tag-plugin"
}
JSON
