This repository has been archived by the owner on Feb 18, 2024. It is now read-only.
Update to mkdocs v1 #1005
Comments
edmorley
added a commit
that referenced
this issue
Aug 15, 2018
1) Update to mkdocs v1 and mkdocs-material v3 In addition: * Renames the now deprecated `pages` setting to `nav`. * Pins the dependencies to exact versions, since Renovate now also supports updating Python dependencies, so we can have both convenience and closer to deterministic build (sub-deps aren't pinned, but likely it's worth listing them all explicitly). Upgrading guides: https://www.mkdocs.org/about/release-notes/#version-10-2018-08-03 https://squidfunk.github.io/mkdocs-material/release-notes/#material-2x-to-3x Fixes #1005. Closes #1012. Closes #1013. 2) Build the docs on Netlify using Python 3.6 Rather than the default of Python 2.7: https://github.com/netlify/build-image/#included-software 3) Docs: Use mkdocs native external links support instead of redirects The workaround is no longer required, since mkdocs now supports using external links in the `nav` configuration: https://www.mkdocs.org/about/release-notes/#internal-refactor-of-pages-files-and-navigation https://www.mkdocs.org/user-guide/configuration/#nav This also required a tightening of the regex in build docs, so the "convert URLs to relative paths" step didn't also now catch the new absolute URL used for the "v8 Documentation" nav link.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Since it amongst other things, adds support for external links in the sidebar, meaning we don't have to use the "fake pages and Netlify redirects" workaround.
The final version isn't yet released, but there's a first beta:
https://github.com/mkdocs/mkdocs/releases/tag/1.0b1
I've hit two issues so far:
The text was updated successfully, but these errors were encountered: