MkDocs plugin that automatically refreshes the build pages when the page has been rebuilt.
Project description
MKDocs Auto Refresh Build Pages Plugin
MkDocs plugin that automatically refreshes the build pages when the documentation is updated.
Installation
Install the plugin using pip from PyPI:
pip install mkdocs-auto-refresh-build-pages
Usage
Add the following lines to your mkdocs.yml
:
plugins:
- search
- auto-refresh-build-pages:
update_message: "The page has been updated. Do you want to reload?"
yes_button_text: "Yes"
no_button_text: "No"
check_interval_seconds: 5
update_message
(optional): The message that will be displayed when the page is updated. Default: "The page has been updated. Do you want to reload?"yes_button_text
(optional): The text of the "Yes" button. Default: "Yes"no_button_text
(optional): The text of the "No" button. Default: "No"check_interval_seconds
(optional): The interval in seconds at which the page will be checked for updates. Default: 5
Example screenshot
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Do You Enjoy My Work?
Then you can consider:
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for mkdocs_auto_refresh_build_pages-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c29ad0f8bc46109572aecc00d7fccf6fa2fdcdff91e30749585e8cc7daee9473 |
|
MD5 | 212eea4fa2c9315368d415d9fc1a476b |
|
BLAKE2b-256 | 1587ee1f2905cbde0b373dcb1e3be48a4e0e5c1438a6516cb96baeef13eb256e |