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
Metadata
Release files for mkdocs-openapi-markdown-plugin 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_openapi_markdown_plugin-0.2.1.tar.gz | 5.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_openapi_markdown_plugin-0.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.0 kB
Release files / mkdocs_openapi_markdown_plugin-0.2.1.tar.gz
| Download URL | mkdocs_openapi_markdown_plugin-0.2.1.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c20cd395865d2715797873006339711f882be08dac20b7ca1a8b1d5a8d188736
|
|
BLAKE2b-256 checksum How to use checksums |
634aa81f05b83c49630da21f46e2b0705c1afeb2b4f68445c156e6c87444f0e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|
Release files / mkdocs_openapi_markdown_plugin-0.2.1-py3-none-any.whl
| Download URL | mkdocs_openapi_markdown_plugin-0.2.1-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6b6870448796d7df0038aa8cea9fd9d6988190da0311ea9218048a66a04f70a9
|
|
BLAKE2b-256 checksum How to use checksums |
3e84d79a293db3286623338f32b58df0710dacc13e9a70f5ac7cf64e88d9f960
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|