Bump mkdocs from 1.3.1 to 1.4.0
Bumps mkdocs from 1.3.1 to 1.4.0.
Release notes
Sourced from mkdocs's releases.
1.4.0
Feature upgrades
#2978)
Hooks (The new
hooks:
config allows you to add plugin-like event handlers from local Python files, without needing to set up and install an actual plugin.See documentation.
edit_uri
flexibility (#2927)There is a new
edit_uri_template:
config.
It works likeedit_uri
but more generally covers ways to construct an edit URL.
See documentation.Additionally, the
edit_uri
functionality will now fully work even ifrepo_url
is omitted (#2928)Upgrades for plugin developers
NOTE: This release has big changes to the implementation of plugins and their configs. But, the intention is to have zero breaking changes in all reasonably common use cases. Or at the very least if a code fix is required, there should always be a way to stay compatible with older MkDocs versions. Please report if this release breaks something.
#2973)
Customize event order for plugin event handlers (Plugins can now choose to set a priority value for their event handlers. This can override the old behavior where for each event type, the handlers are called in the order that their plugins appear in the
plugins
config.If this is set, 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.
Recommended priority values:
100
"first",50
"early",0
"default",-50
"late",-100
"last".
As different plugins discover more precise relations to each other, the values should be further tweaked.See documentation.
New events that persist across builds in
mkdocs serve
(#2972)The new events are
on_startup
andon_shutdown
. They run at the very beginning and very end of anmkdocs
invocation.
on_startup
also receives information on howmkdocs
was invoked (e.g.serve
--dirtyreload
).See documentation.
Replace
File.src_path
to not deal with backslashes (#2930)The property
src_path
uses backslashes on Windows, which doesn't make sense as it's a virtual path.
To not make a breaking change, there's no change to how this property is used, but now you should:
- Use
File.src_uri
instead ofFile.src_path
- and
File.dest_uri
instead ofFile.dest_path
.These consistently use forward slashes, and are now the definitive source that MkDocs itself uses.
... (truncated)
Commits
-
927ee26
Release 1.4.0 (#2986) -
5cce501
Merge pull request #2962 from mkdocs/meta -
5015fa7
Add examples of class-based schema with ListOfItems -
cc627f7
Prevent wrapping into Optional when the option has a default -
aeffe61
Change config_options.URL's default from '' to None -
5156947
Add a test for subclassing a config schema -
ff8552a
Add tests for new class-based configs -
6d8c4d1
Preserve a copy of config_options_tests before reworking it -
452f56c
Move config_options_tests.py before reworking it -
cf9d237
Change ListOfItems' "default default" from [] to None - Additional commits viewable in compare view
Dependabot commands
You can trigger Dependabot actions by commenting on this MR
-
$dependabot rebase
will rebase this MR -
$dependabot recreate
will recreate this MR rewriting all the manual changes and resolving conflicts