You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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! :)
The text was updated successfully, but these errors were encountered:
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 …
These should be opt-in so the plugin behaves as before, but allows e.g. setting a
rerender_interval
orpaths_to_watch
.Thank you for considering! :)
The text was updated successfully, but these errors were encountered: