You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,11 @@
14
14
15
15
16
16
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.
Copy file name to clipboardExpand all lines: docs/README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,11 @@
14
14
15
15
16
16
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
+
18
22
19
23
## Installation
20
24
@@ -35,17 +39,17 @@ plugins:
35
39
update_message: "The page has been updated. Do you want to reload?"
36
40
yes_button_text: "Yes"
37
41
no_button_text: "No"
38
-
check_interval_seconds: 5
42
+
check_interval_seconds: 60
39
43
```
40
44
41
45
- `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?"
42
46
- `yes_button_text` (optional): The text of the "Yes" button. Default: "Yes"
43
47
- `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)
0 commit comments