Skip to content

Releases: Neoteroi/mkdocs-plugins

v0.0.3

04 May 21:14
bef3bfc

Choose a tag to compare

  • Fixes bug #4

v0.0.2

01 May 20:11
a6cbe99

Choose a tag to compare

  • Adds the first extension for Python Markdown of the repository:
    spantable, custom Markdown table with support for colspan and rowspan
  • Improves the support for Material for MkDocs themes in mkdocsoad

v0.0.1

20 Apr 23:07

Choose a tag to compare

MkDocsOAD

Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger documentation).

How to use:

  1. Install using pip install neoteroi-mkdocs
  2. Configure this plugin in the MkDocs configuration file:
plugins:
  - neoteroi.mkdocsoad
  1. Configure a source in your Markdown file, for example having a swagger.json
    file in your docs folder:
[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:

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)]