# MKDocs Auto Refresh Build Pages Plugin
<p align="center">
<a href="https://hits.seeyoufarm.com/api/count/graph/dailyhits.svg?url=https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=👀&edge_flat=true"/></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://pypi.org/project/mkdocs-auto-refresh-build-pages/" target="_blank"><img alt="PyPI" src="https://img.shields.io/pypi/v/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/forks" target="_blank"><img src="https://img.shields.io/github/forks/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/issues" target="_blank"><img src="https://img.shields.io/github/issues/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/discussions" target="_blank"><img src="https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://pypistats.org/packages/mkdocs-auto-refresh-build-pages" target="_blank"><img src="https://static.pepy.tech/personalized-badge/mkdocs-auto-refresh-build-pages?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads"></a>
</p>
MkDocs plugin for live development in production. The plugin adds a popup window that asks the user if he wants to reload the (compiled) page when the page has been updated.
This tool is useful when you are deploying your MkDocs pages to production and you want to inform the user that the page has been updated.
We are using this plugin on the [Robotic Camp](https://robotickytabor.cz) when we quickly need to update the page and we want to inform the participants that the programming guide has been updated.
## Installation
Install the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-auto-refresh-build-pages/):
```bash
pip install mkdocs-auto-refresh-build-pages
```
## Usage
Add the following lines to your `mkdocs.yml`:
```yaml
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: 60
```
- `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: 60s (1 minute)
## Example screenshot
<img src="https://raw.githubusercontent.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/main/docs/media/popup.png" alt="example" style="border: 2px solid black;">
## 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:
- supporting me on GitHub Sponsors: [](https://github.com/sponsors/jakubandrysek)
## License
[MIT](https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages",
"name": "mkdocs-auto-refresh-build-pages",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mkdocs plugin, mkdocs, auto refresh, auto refresh build pages",
"author": "Jakub Andr\u00fdsek",
"author_email": "email@kubaandrysek.cz",
"download_url": null,
"platform": null,
"description": "# MKDocs Auto Refresh Build Pages Plugin\n\n\n<p align=\"center\">\n<a href=\"https://hits.seeyoufarm.com/api/count/graph/dailyhits.svg?url=https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages\"><img src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=\ud83d\udc40&edge_flat=true\"/></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/blob/main/LICENSE\" target=\"_blank\"><img src=\"https://img.shields.io/github/license/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square\"></a>\n<a href=\"https://pypi.org/project/mkdocs-auto-refresh-build-pages/\" target=\"_blank\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/mkdocs-auto-refresh-build-pages?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/stargazers\" target=\"_blank\"><img src=\"https://img.shields.io/github/stars/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/forks\" target=\"_blank\"><img src=\"https://img.shields.io/github/forks/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/issues\" target=\"_blank\"><img src=\"https://img.shields.io/github/issues/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/discussions\" target=\"_blank\"><img src=\"https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square\"></a>\n<a href=\"https://pypistats.org/packages/mkdocs-auto-refresh-build-pages\" target=\"_blank\"><img src=\"https://static.pepy.tech/personalized-badge/mkdocs-auto-refresh-build-pages?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads\"></a>\n</p>\n\n\n\nMkDocs plugin for live development in production. The plugin adds a popup window that asks the user if he wants to reload the (compiled) page when the page has been updated.\nThis tool is useful when you are deploying your MkDocs pages to production and you want to inform the user that the page has been updated.\n\nWe are using this plugin on the [Robotic Camp](https://robotickytabor.cz) when we quickly need to update the page and we want to inform the participants that the programming guide has been updated.\n\n\n## Installation\n\nInstall the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-auto-refresh-build-pages/):\n\n```bash\npip install mkdocs-auto-refresh-build-pages\n```\n\n## Usage\n\nAdd the following lines to your `mkdocs.yml`:\n\n```yaml\nplugins:\n - search\n - auto-refresh-build-pages:\n update_message: \"The page has been updated. Do you want to reload?\"\n yes_button_text: \"Yes\"\n no_button_text: \"No\"\n check_interval_seconds: 60\n```\n\n- `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?\"\n- `yes_button_text` (optional): The text of the \"Yes\" button. Default: \"Yes\"\n- `no_button_text` (optional): The text of the \"No\" button. Default: \"No\"\n- `check_interval_seconds` (optional): The interval in seconds at which the page will be checked for updates. Default: 60s (1 minute)\n\n## Example screenshot\n\n<img src=\"https://raw.githubusercontent.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/main/docs/media/popup.png\" alt=\"example\" style=\"border: 2px solid black;\">\n\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## Do You Enjoy My Work?\nThen you can consider:\n\n- supporting me on GitHub Sponsors: [](https://github.com/sponsors/jakubandrysek)\n\n## License\n\n[MIT](https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs plugin that automatically refreshes the build pages when the page has been rebuilt.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages"
},
"split_keywords": [
"mkdocs plugin",
" mkdocs",
" auto refresh",
" auto refresh build pages"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eef10d7244e34477345fdf5c1860eb78985f3b4672448ffcfbdea4e0d06e42e2",
"md5": "ca772a5e3c0dfb2106940c48173ad952",
"sha256": "7f761826199064371f740b84805fcfd9371d8064f62935c085e4ef2d6091eb8b"
},
"downloads": -1,
"filename": "mkdocs_auto_refresh_build_pages-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca772a5e3c0dfb2106940c48173ad952",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6589,
"upload_time": "2024-07-02T15:51:56",
"upload_time_iso_8601": "2024-07-02T15:51:56.800116Z",
"url": "https://files.pythonhosted.org/packages/ee/f1/0d7244e34477345fdf5c1860eb78985f3b4672448ffcfbdea4e0d06e42e2/mkdocs_auto_refresh_build_pages-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-02 15:51:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JakubAndrysek",
"github_project": "mkdocs-auto-refresh-build-pages",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "mkdocs-auto-refresh-build-pages"
}
JSON
