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

Feature Request: Provide hotreload #34

Open
timo-reymann opened this issue Sep 6, 2024 · 0 comments
Open

Feature Request: Provide hotreload #34

timo-reymann opened this issue Sep 6, 2024 · 0 comments

Comments

@timo-reymann
Copy link

Foremost, thank you for this wonderful plugin, I use it in quite some projects now, and it works like a charm.

I am not too deep in the internals of mkdocs so I am not sure if this is even possible.

Motivation

Currently, most use cases are either generating “virtual” markdown files e.g., from special comments from code, or based on a file structure on disk.

The most prominent example for this is a set of YAML files that are generated into proper documentation. Every time one of those YAML files changes, one has to stop mkdocs serve and run again.

What I would love to have …

  • either a option to do periodic re-renders (e.g., rerender these pages every 10s, so they are almost always up to date)
  • provide a set of paths and rerender if they change (e.g. yaml file changed -> just trigger entire script again)

These should be opt-in so the plugin behaves as before, but allows e.g. setting a rerender_interval or paths_to_watch.

Thank you for considering! :)

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

No branches or pull requests

1 participant