Skip to main content

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_openapi_markdown_plugin-0.2.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file mkdocs_openapi_markdown_plugin-0.2.0.tar.gz.

File metadata

File hashes

Hashes for mkdocs_openapi_markdown_plugin-0.2.0.tar.gz
Algorithm Hash digest
SHA256 833a0c884390eaa2f0a5deb89533f26c5789b47b42977144815a987d0c46c229
MD5 ace9be9dbde389a243f45b145cdc59b2
BLAKE2b-256 8b487906d6a0195ccc2ded0b4a4bbd6a87fc75e1fe6b4accc540c28b65a97d6e

See more details on using hashes here.

File details

Details for the file mkdocs_openapi_markdown_plugin-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_openapi_markdown_plugin-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a79bd974e57c2672fb6c49f12d6542a912a50b6301e29d7fe42df36320de603d
MD5 2dd3e095ae7669d786c22f833f44284c
BLAKE2b-256 46091fcd4336fb5a5dcb4403e819f266dcfcd8e4da30edc099b19ec0b5494d92

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page