Metadata-Version: 2.1
Name: mkdocs-openapi-markdown-plugin
Version: 0.0.1
Summary: Mkdocs plugin to generate openapi document markdown
Project-URL: Homepage, https://github.com/vrerv/mkdocs-openapi-markdown-plugin
Project-URL: Bug Tracker, https://github.com/vrerv/mkdocs-openapi-markdown-plugin/issues
Author-email: soonoh <soonoh.jung@vrerv.com>
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# 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`
