Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Try new validations in mkdocs 1.6.0 (after upgrading mkdocs-material) #439

Closed
7 tasks done
HonkingGoose opened this issue Apr 21, 2024 · 3 comments · Fixed by #458
Closed
7 tasks done

Try new validations in mkdocs 1.6.0 (after upgrading mkdocs-material) #439

HonkingGoose opened this issue Apr 21, 2024 · 3 comments · Fixed by #458
Assignees
Labels
enhancement New feature or request

Comments

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Apr 21, 2024

What would you like to be able to do?

mkdocs 1.6.0 can warn us about broken absolute links and broken anchors in links (#anchor). I would definitely like to try these new warnings on our docs, to help catch broken stuff before creating a new build of the docs.

But mkdocs-material does not support mkdocs 1.6.0 yet. So we need to wait for a version of mkdocs-material that support the new mkdocs.

Did you already have any implementation ideas?

Here's a list of todos:

  • Upgrade to a version of mkdocs-material that supports mkdocs 1.6.0
  • Read the mkdocs 1.6.0 changelog to check for important changes
  • Update to mkdocs 1.6.0
  • Try the new options for validation of hyperlinks between pages:
    • validate absolute links I think we should keep this set to absolute_links: warn so we're "forced" to use relative links.
    • validate anchors in links
    • Read the MkDocs validation section and try the recommended settings for most sites (maximal strictness):
      validation:
        omitted_files: warn
        absolute_links: warn  # Or 'relative_to_docs' - new in MkDocs 1.6
        unrecognized_links: warn
        anchors: warn  # New in MkDocs 1.6

I'm willing to try configuring the new settings for us, and helping to update. 😄

Do you want to write this feature yourself?

Yes

@HonkingGoose HonkingGoose added the enhancement New feature or request label Apr 21, 2024
@HonkingGoose HonkingGoose self-assigned this Apr 21, 2024
@squidfunk
Copy link

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.

@viceice
Copy link
Member

viceice commented Apr 30, 2024

now ready, see #451

@viceice
Copy link
Member

viceice commented Apr 30, 2024

when renovatebot/renovate#28690 is merged and updated here, then we should be able to enable additional warnings

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants