Add a decorator that sets a priority value for plugins' events. Events with higher priority are called first. Events without a chosen priority get a default of 0. Events that have the same priority are ordered as they appear in the config.
"One-time events" `on_startup(command)`, `on_shutdown`.
Their presence also shows that a plugin *wants* to persist across builds. Otherwise they will be re-created, to not change any existing behavior.
* Create real (no-op) methods for each event in the base class.
* Refactor event dispatcher to not check for methods' existence, instead just call them.
* Move documentation from Markdown into docstrings of these methods.
* Activate the 'mkdocstrings' plugin.
* Use 'mkdocstrings' to insert documentation from those docstrings into the site.
The result is exactly equivalent, just different syntax -- one that doesn't look weird in vanilla Markdown parsers such as on GitHub.
The output HTML before/after is equivalent , other than adding `<p class="admonition-title">Block</p>` in two cases, which I hid with CSS.
This also contributes to fixing the currently-present markdownlint MD053 violations, as it can't scan inside admonitions.
Add 'markdown-callouts' to dependencies and bump Markdown dep.
There are small typos in:
- docs/user-guide/writing-your-docs.md
- mkdocs/contrib/search/templates/search/lunr.js
- mkdocs/utils/meta.py
Fixes:
- Should read `delimiters` rather than `deliminators`.
- Should read `environments` rather than `enviroments`
* adds a `watch` property to the `mkdocs.yaml` schema. Accepts a list of directories to watch.
* adds a `-w`/`--watch` command line option to `mkdocs serve` that can be passed multiple times
* options from `mkdocs.yaml` and CLI flags are combined
* the livereload server will also print the directories that it watches
* docs updated
Co-authored-by: Oleh Prypin <oleh@pryp.in>
Includes all upgrades 0.4.1->0.4.2->0.4.3->0.5.0rc->0.5.0rc2->0.5.0->0.5.1->1.0.0rc1->1.0.0
* Add the ability to use a logo in place of site_name in base.html
* New option `anonymize_ip`
* Drop Modernizr.js
* Upgrade jQuery (to 3.6.0) and others