Skip to content

Support mkdocs 1.6.0 #7076

@HonkingGoose

Description

@HonkingGoose

Note

Edit by @squidfunk: fix available, please check if your documentation builds successfully, see #7076 (comment)


Context

When I try to install mkdocs 1.6.0 I get a warning from pip that mkdocs-material only supports a 1.5.x version of mkdocs.

Copy/pasting a relevant comment from @squidfunk:

Happy to collaborate on the 1.6 transition! Former minor version MkDocs releases sometimes broke parts of Material for MkDocs, which is why we decided to be a little more selective about what version we support. I currently have other things on my plate, but if you'd like to collaborate on a PR to bring Material for MkDocs and Insiders to 1.6, I'm happy to help wherever I can. Reading the release notes of 1.6, I think it should be pretty straight forward to support.

Source for comment: renovatebot/renovatebot.github.io#439 (comment)

I don't feel confident to work on the code on mkdocs-material. I can at least make an issue for this work, so you can track it. Maybe someone from the community can help you work on this feature.

Description

Update Material for MkDocs so it works with 1.6.0. of mkdocs.

Related links

Read the mkdocs 1.6.0 changelog to check for important changes.

mkdocs 1.6.0 also has a new enabled setting for all plugins. I don't know if/how this affects Material for MkDocs. Maybe you should default to enabled: false on some parts, or explictly enabled: true on others...

Use Cases

MkDocs 1.6.0 has new validation options:

It's a good idea to validate the links before publishing the docs, that way readers don't suddenly end up with a broken link.

Visuals

No response

Before submitting

Metadata

Metadata

Assignees

No one assigned

    Labels

    change requestIssue requests a new feature or improvementresolvedIssue is resolved, yet unreleased if open

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions