Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jul 9, 2024

Conversation

JakubAndrysek
Copy link
Contributor

What kind of change does this PR introduce?

  • 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:

  • I have read the CONTRIBUTING guidelines.
  • 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
Copy link
Sponsor Collaborator

pawamoy commented Jun 29, 2024

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

@pawamoy
Copy link
Sponsor Collaborator

pawamoy commented Jul 9, 2024

@JakubAndrysek tagging you just to make sure you've seen my previous comment ☺️

@JakubAndrysek
Copy link
Contributor Author

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
Copy link
Contributor Author

example

@JakubAndrysek
Copy link
Contributor Author

@pawamoy
Copy link
Sponsor Collaborator

pawamoy commented Jul 9, 2024

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 😄

@pawamoy
Copy link
Sponsor Collaborator

pawamoy commented Jul 9, 2024

CI failure unrelated, merging 🙂

@pawamoy pawamoy merged commit 077b993 into mkdocs:main Jul 9, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants