Add plugin: mkdocs-auto-refresh-build-pages

mkdocs / catalog

:trophy: :books: A list of awesome MkDocs projects and plugins.

Creative Commons Attribution Share Alike 4.0 International

1.12k stars 68 forks source link

Add plugin: mkdocs-auto-refresh-build-pages #228

Closed JakubAndrysek closed 4 months ago

JakubAndrysek commented 4 months ago

What kind of change does this PR introduce?

[x] Add a project
[ ] Update a project
[ ] Remove a project
[ ] Add or update a category
[ ] Change configuration
[ ] Documentation
[ ] Other, please describe:

Description: Add plugin: mkdocs-auto-refresh-build-pages

MkDocs plugin that automatically refreshes the build pages when the documentation is updated.

Checklist:

[x] I have read the CONTRIBUTING guidelines.
[x] I have not modified the README.md file. Projects are only supposed to be added or updated within the projects.yaml file since the README.md file is automatically generated.

pawamoy commented 4 months ago

Thanks! What's the difference with the live reloading server?

pawamoy commented 4 months ago

@JakubAndrysek tagging you just to make sure you've seen my previous comment :relaxed:

JakubAndrysek commented 4 months ago

Hi, I have added information to the repo, but I have forgotten to provide the information here.

MkDocs plugin for informing users that the loaded page has been changed. 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 when we quickly need to update the page and we want to inform the participants that the programming guide has been updated.

Right now, we are using this tool in guides for our robot assembly (Czech) - https://robutek.robotikabrno.cz/

JakubAndrysek commented 4 months ago

JakubAndrysek commented 4 months ago

More info in my repo: https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages

pawamoy commented 4 months ago

Thanks, it's clear now! Basically you have Javascript code that runs and continuously get the same page from the server to check if there's a more recent version. Do I understand correctly? Lets merge anyway :smile:

pawamoy commented 4 months ago

CI failure unrelated, merging :slightly_smiling_face: