Releases: Neoteroi/mkdocs-plugins
Releases · Neoteroi/mkdocs-plugins
v0.0.3
v0.0.2
- Adds the first extension for Python Markdown of the repository:
spantable, custom Markdown table with support forcolspanandrowspan - Improves the support for Material for MkDocs themes in
mkdocsoad
v0.0.1
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.json
file 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:
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)] |
