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:
  - gen_nav:
      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.1.0.tar.gz (5.5 kB view hashes)

Uploaded Source

Built Distribution

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