Mkdocs plugin to generate openapi document markdown
Project description
MkDocs OpenApi Markdown Plugin
This plugin generates markdown file from openapi spec file. (json or yaml)
Configuration
Add following lines to your mkdocs.yml configuration file:
plugins:
- openapi_markdown:
enabled: true
openapi_file: openapi.json
output_file: api_doc.md
Install
pip install mkdocs-openapi-markdown-plugin
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
File details
Details for the file mkdocs_openapi_markdown_plugin-0.2.1.tar.gz.
File metadata
- Download URL: mkdocs_openapi_markdown_plugin-0.2.1.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c20cd395865d2715797873006339711f882be08dac20b7ca1a8b1d5a8d188736 |
|
| MD5 | 7da740de4eb550fe56e0417746da8083 |
|
| BLAKE2b-256 | 634aa81f05b83c49630da21f46e2b0705c1afeb2b4f68445c156e6c87444f0e1 |
File details
Details for the file mkdocs_openapi_markdown_plugin-0.2.1-py3-none-any.whl.
File metadata
- Download URL: mkdocs_openapi_markdown_plugin-0.2.1-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6b6870448796d7df0038aa8cea9fd9d6988190da0311ea9218048a66a04f70a9 |
|
| MD5 | e0dac627cec141a4f07f7e9bfb55b152 |
|
| BLAKE2b-256 | 3e84d79a293db3286623338f32b58df0710dacc13e9a70f5ac7cf64e88d9f960 |
