https://github.com/jakubandrysek/mkdocs-auto-refresh-build-pages

MkDocs plugin that automatically refreshes the build pages when the documentation is updated.
https://github.com/jakubandrysek/mkdocs-auto-refresh-build-pages

auto-refresh auto-refresh-build-pages mkdocs mkdocs-build mkdocs-plugin

Last synced: 12 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jakubandrysek/mkdocs-auto-refresh-build-pages
• Owner: JakubAndrysek
• License: mit
• Created: 2024-06-28T13:02:40.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-02T15:52:19.000Z (6 months ago)
• Last Synced: 2024-12-13T17:53:55.744Z (18 days ago)
• Topics: auto-refresh, auto-refresh-build-pages, mkdocs, mkdocs-build, mkdocs-plugin
• Language: Python
• Homepage: https://jakubandrysek.github.io/mkdocs-auto-refresh-build-pages/
• Size: 708 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MKDocs Auto Refresh Build Pages Plugin





















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



## 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://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/jakubandrysek)

## License

[MIT](https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/blob/main/LICENSE)