https://github.com/vrerv/mkdocs-openapi-markdown-plugin

https://github.com/vrerv/mkdocs-openapi-markdown-plugin

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vrerv/mkdocs-openapi-markdown-plugin
• Owner: vrerv
• License: apache-2.0
• Created: 2023-04-07T05:17:58.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-25T02:16:37.000Z (over 2 years ago)
• Last Synced: 2024-04-26T06:02:58.357Z (about 2 years ago)
• Language: Python
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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