Skip to main content

ReadTheDocs version warning MkDocs plugin replace placeholder text with warning banner for specific versions if deployed on Readthedocs

Project description

ReadTheDocs version warning MkDocs plugin

"ReadTheDocs version warning MkDocs plugin" is a very basic mkdocs plugin that replace placeholder text (### VERSION-WARNING-BANNER-PLACEHOLDER ###) in the theme template with warning admonition.

Configuration

plugins:
    - readthedocs-version-warning:
        project_id: "000000"
        show_on_versions:
            - latest

project_id - Id of the target project on ReadTheDocs. From this project will be used the default version to render link to the stable version. show_on_versions - List of versions on which the banner should appear.

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

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