https://github.com/shopsys/readthedocs-version-warning-mkdocs-plugin

ReadTheDocs version warning MkDocs plugin replace placeholder text with warning banner for specific versions if deployed on Readthedocs.
https://github.com/shopsys/readthedocs-version-warning-mkdocs-plugin

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/shopsys/readthedocs-version-warning-mkdocs-plugin
• Owner: shopsys
• License: mit
• Created: 2019-09-30T22:23:34.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-30T22:52:39.000Z (about 5 years ago)
• Last Synced: 2024-04-24T03:16:36.043Z (8 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ReadTheDocs version warning MkDocs plugin

"ReadTheDocs version warning MkDocs plugin" is a very basic [mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/)

that replace placeholder text

```### VERSION-WARNING-BANNER-PLACEHOLDER ###```

in the theme template with warning admonition.

## Configuration

```yaml

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.