Skip to main content

A MkDocs plugin supports for add Redoc in page.

Project description

MkDocs Redoc Tag

PyPI version PyPI downloads Codecov

A MkDocs plugin supports adding Redoc to the page.

Features

  1. OpenAPI Specification file from online over URL or static file in docs
  2. All dependencies are using static files handled by the plugin not from CDN, especially suitable for those documents been deployed in the intranet
  3. Synchronized dark mode with Material for MkDocs

Dependency

  1. Python Package
    1. beautifulsoup4>=4.11.1
  2. Redoc standalone javascript from official CDN
    1. redoc==2.4.0

Usage

  1. Install the plugin from Pypi

    pip install mkdocs-redoc-tag
    
  2. Add redoc-tag plugin into your mkdocs.yml plugins sections:

    plugins:
       - redoc-tag
    
  3. Add redoc tag in markdown to include Redoc:

    <redoc src="https://petstore.swagger.io/v2/swagger.json"/>
    

    Redoc Sample Image

  4. You may customize the plugin by passing options in mkdocs.yml:

    plugins:
       - redoc-tag:
            background: White
    
    Options Type Description
    background String Default: "". Redoc iframe body background attribute value. You can use any css value for background for example "#74b9ff" or "Gainsboro" or "" for nothing.
    height String Default: "80vh". Height of Redoc iframe.

How it works

  1. Copy Redoc script file into site/assets/javascripts/ directory
  2. Search all redoc tags, then convert them to an iframe tag and generate the iframe target html with the given OpenAPI Specification src path

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Reference

  1. redark: source of dark mode javascript and css

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_redoc_tag-0.2.0.tar.gz (285.9 kB view details)

Uploaded Source

Built Distribution

mkdocs_redoc_tag-0.2.0-py3-none-any.whl (287.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_redoc_tag-0.2.0.tar.gz
  • Upload date:
  • Size: 285.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mkdocs_redoc_tag-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e50825c19586f2383b97b51d4b225fd83df83556dd2fe27515cb94ee25777897
MD5 f4b775bfc2e352901af5f258af188078
BLAKE2b-256 f7a48f868c441a2be902a44343c349c9d7a4cceefc4141bf18386162d2915478

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_redoc_tag-0.2.0.tar.gz:

Publisher: deploy-release.yml on blueswen/mkdocs-redoc-tag

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for mkdocs_redoc_tag-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e15c9d45699a05d182676d5a8baf6bc81579543a562891ff1deb3f1524589ca4
MD5 c28ebdf5c18fb5930561cdb67e7dc533
BLAKE2b-256 30ff63e91376c6198355246dcb2f78d2cccfea8601de9c53817f9682b622673e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_redoc_tag-0.2.0-py3-none-any.whl:

Publisher: deploy-release.yml on blueswen/mkdocs-redoc-tag

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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