Bump mkdocs from 1.5.3 to 1.6.0
Bumps mkdocs from 1.5.3 to 1.6.0.
Release notes
Sourced from mkdocs's releases.
1.6.0
Local preview
mkdocs serve
no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: #3391New flag
serve --open
to open the site in a browser.
After the first build is finished, this flag will cause the default OS Web browser to be opened at the home page of the local site.
Context: #3500Drafts
[!warning] Changed from version 1.5:
The
exclude_docs
config was split up into two separate concepts.The
exclude_docs
config no longer has any special behavior formkdocs serve
- it now always completely excludes the listed documents from the site.If you wish to use the "drafts" functionality like the
exclude_docs
key used to do in MkDocs 1.5, please switch to the new config keydraft_docs
.See documentation.
Other changes:
- Reduce warning levels when a "draft" page has a link to a non-existent file. Context: #3449
Update to deduction of page titles
MkDocs 1.5 had a change in behavior in deducing the page titles from the first heading. Unfortunately this could cause unescaped HTML tags or entities to appear in edge cases.
Now tags are always fully sanitized from the title. Though it still remains the case that
Page.title
is expected to contain HTML entities and is passed directly to the themes.Images (notably, emojis in some extensions) get preserved in the title only through their
alt
attribute's value.Themes
- Built-in themes now also support Polish language (#3613)
"readthedocs" theme
Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. (#3464)
Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. (#3435)
"readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. (#3613, #3625)
"mkdocs" theme
... (truncated)
Commits
-
0998fec
Release 1.6.0 (#3631) -
bce85bf
Fix for showing repository icon even when a file has no edit_uri (#3657) -
0ac05da
Re-generate localization files (#3634) -
6244500
Remove jQuery frommkdocs
theme (#3649) -
f85d429
Prevent a flash of white color when dark mode is enabled (#3647) -
e39cce2
Fix style of modal close button (#3651) -
652813d
Prevent a crash if stdin is not defined (#3609) -
59a295f
Merge pull request #3493 from waylan/2248 -
6f5e748
Merge pull request #3625 from mkdocs/themepo -
1451fb3
Babel setuptools frontend is still used in the install hook - Additional commits viewable in compare view