Skip to main content

MKDocs plugin for rendering swagger & openapi files.

Project description

mkdocs-render-swagger-plugin

A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.

Usage

Add the following lines to your mkdocs.yml:

plugins:
  - render_swagger

Enter !!swagger <filename>!! at the appropriate location inside a markdown file.

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-render-swagger-plugin-0.0.1.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file mkdocs-render-swagger-plugin-0.0.1.tar.gz.

File metadata

  • Download URL: mkdocs-render-swagger-plugin-0.0.1.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6

File hashes

Hashes for mkdocs-render-swagger-plugin-0.0.1.tar.gz
Algorithm Hash digest
SHA256 2c99df36add9adc41793020584831069606fb98a72c96ee0a496fa46ecc7350e
MD5 21e025fc7782e396eb9509451c79e018
BLAKE2b-256 26739f87105b53024bac44ece53493c771ddbc58a7b6e159ecaed515057bd7ae

See more details on using hashes here.

File details

Details for the file mkdocs_render_swagger_plugin-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_render_swagger_plugin-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6

File hashes

Hashes for mkdocs_render_swagger_plugin-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 035660565e07535cd5f6761985f91e5199c6eb818f2b193a54aa8e91e866c3f0
MD5 49b1a1af2e248acd34be057d87ad695c
BLAKE2b-256 5ebf66330e9e1a28549d61353f7ee3d4cc68662fe1b05a2376e0babccc04699f

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