Skip to content

Commit d577678

Browse files
committed
chore: Update mkdocs-auto-refresh-build-pages version to 1.0.2 and check_interval_seconds to 60s
1 parent 4bb1594 commit d577678

File tree

3 files changed

+17
-7
lines changed

3 files changed

+17
-7
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@
1414

1515

1616

17-
MkDocs plugin that automatically refreshes the build pages when the documentation is updated.
17+
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.
18+
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.
19+
20+
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.
21+
1822

1923
## Installation
2024

@@ -45,7 +49,7 @@ plugins:
4549

4650
## Example screenshot
4751

48-
<img src="./docs/media/popup.png" alt="example" style="border: 2px solid black;">
52+
<img src="https://raw.githubusercontent.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/main/docs/media/popup.png" alt="example" style="border: 2px solid black;">
4953

5054

5155
## Contributing

docs/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@
1414

1515

1616

17-
MkDocs plugin that automatically refreshes the build pages when the documentation is updated.
17+
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.
18+
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.
19+
20+
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.
21+
1822

1923
## Installation
2024

@@ -35,17 +39,17 @@ plugins:
3539
update_message: "The page has been updated. Do you want to reload?"
3640
yes_button_text: "Yes"
3741
no_button_text: "No"
38-
check_interval_seconds: 5
42+
check_interval_seconds: 60
3943
```
4044
4145
- `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?"
4246
- `yes_button_text` (optional): The text of the "Yes" button. Default: "Yes"
4347
- `no_button_text` (optional): The text of the "No" button. Default: "No"
44-
- `check_interval_seconds` (optional): The interval in seconds at which the page will be checked for updates. Default: 5
48+
- `check_interval_seconds` (optional): The interval in seconds at which the page will be checked for updates. Default: 60s (1 minute)
4549

4650
## Example screenshot
4751

48-
<img src="./media/popup.png" alt="example" style="border: 2px solid black;">
52+
<img src="https://raw.githubusercontent.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/main/docs/media/popup.png" alt="example" style="border: 2px solid black;">
4953

5054

5155
## Contributing

setup.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from setuptools import setup, find_packages
22

3-
__version__ = "1.0.1"
3+
__version__ = "1.0.2"
44

55

66
def readme():
@@ -48,6 +48,8 @@ def import_dev_requirements():
4848
"Operating System :: OS Independent",
4949
],
5050
packages=find_packages(),
51+
# include file: auto_refresh_build_pages/js/auto_refresh_build_pages.js.jinja
52+
package_data={"auto_refresh_build_pages": ["js/auto_refresh_build_pages.js.jinja"]},
5153
include_package_data=True,
5254
entry_points={
5355
"mkdocs.plugins": [

0 commit comments

Comments
 (0)