Metadata-Version: 2.1
Name: mkdocs-auto-refresh-build-pages
Version: 1.0.0
Summary: MkDocs plugin that automatically refreshes the build pages when the page has been rebuilt.
Home-page: https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages
Author: Jakub Andrýsek
Author-email: email@kubaandrysek.cz
License: MIT
Keywords: mkdocs plugin,mkdocs,auto refresh,auto refresh build pages
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs ~=1.6.0
Provides-Extra: dev
Requires-Dist: mkdocs-material ~=9.5.27 ; extra == 'dev'
Requires-Dist: mkdocs-glightbox ~=0.4.0 ; extra == 'dev'
Requires-Dist: mkdocs-git-revision-date-localized-plugin ~=1.2.6 ; extra == 'dev'
Requires-Dist: mkdocs-open-in-new-tab ; extra == 'dev'
Requires-Dist: build ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: setuptools ~=70.0.0 ; extra == 'dev'

# MKDocs Auto Refresh Build Pages Plugin


<p align="center">
<a href="https://hits.seeyoufarm.com/api/count/graph/dailyhits.svg?url=https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=👀&edge_flat=true"/></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://pypi.org/project/mkdocs-auto-refresh-build-pages/" target="_blank"><img alt="PyPI" src="https://img.shields.io/pypi/v/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/forks" target="_blank"><img src="https://img.shields.io/github/forks/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/issues" target="_blank"><img src="https://img.shields.io/github/issues/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages/discussions" target="_blank"><img src="https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-auto-refresh-build-pages?style=flat-square"></a>
<a href="https://pypistats.org/packages/mkdocs-auto-refresh-build-pages" target="_blank"><img src="https://static.pepy.tech/personalized-badge/mkdocs-auto-refresh-build-pages?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads"></a>
</p>



MkDocs plugin that automatically refreshes the build pages when the documentation is 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: 5
```

- `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: 5

## Example screenshot

<img src="./docs/media/popup.png" alt="example" style="border: 2px solid black;">


## 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)
