Plugins for MkDocs
Project description
Plugins for MkDocs
pip install neoteroi-mkdocs
MkDocsOAD
Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger documentation).
How to use:
- Install using
pip install neoteroi-mkdocs - Configure this plugin in the MkDocs configuration file:
plugins:
- neoteroi.mkdocsoad
- Configure a source in your Markdown file, for example having a
swagger.jsonfile in yourdocsfolder:
[OAD(./docs/swagger.json)]
The plugin fetches the contents from the OpenAPI Specification source, generates Markdown using essentials-openapi, then writes them in the markdown file.
Example result:
Recommended: enable PyMDown and extra CSS
This plugin has been originally designed to generate Markdown that makes use of three extensions from PyMdown extensions. To achieve the best results, it is recommended to enable PyMdown extensions.
- Install PyMdown extensions
using
pip install pymdown-extensions - Configure the following PyMdown markdown extensions in the MkDocs configuration file:
markdown_extensions:
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
Enable PyMdown integration this way:
plugins:
- neoteroi.mkdocsoad:
use_pymdownx: true
Download a local copy of the provided extra.css file and configure it as extra
file in your MkDocs configuration:
extra_css:
- css/extra.css
Supported sources for OpenAPI Documentation
| Source | Example |
|---|---|
| YAML file | [OAD(./docs/swagger.yaml)] |
| JSON file | [OAD(./docs/swagger.json)] |
| URL returning YAML on HTTP GET | [OAD(https://example-domain.net/swagger/v1/swagger.yaml)] |
| URL returning JSON on HTTP GET | [OAD(https://example-domain.net/swagger/v1/swagger.json)] |
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
Hashes for neoteroi_mkdocs-0.0.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 06f278664c6dd9eeabdc704227d3f8b17206eac2814396453afbc24c13906d30 |
|
| MD5 | bf3bcd8ffab4d7efb1e3fdbed9fcf51d |
|
| BLAKE2b-256 | 3285188912e2b68b29b80dc97509adad334d13a422dcf5be631d2acb5b6589a4 |
