Automatic broken links / images detection

[doliG]

Hello,

Docusaurus support detection of broken links and broken Anchor during build (see https://docusaurus.io/docs/api/docusaurus-config#onBrokenLinks) .

I can't find anything i the documentation of mkdocs about it. It may be a good idea to add support for this feature, wdyt ?

Thanks.

[doliG]

Hey @squidfunk , any idea if it's a good idea ? If yes telle me if it's ok for me to contriubute. Thanks.

[kamilkrzyskow]

This is the discussion board for the Material theme not MkDocs.

MkDocs does have link validation. Check the validation config option in their documentation.

You can set the warn level and combine it with the strict flag to terminate the site build process in case of bad links.

This only checks internal links in your docs, and doesn't validate external links to outside resources, which of course makes sense.

If you want to add more validation you would probably add a markdown extension or MkDocs hook or MkDocs plugin.

In case of an installable package you could add it to the MkDocs catalog of external projects.

[squidfunk]

Always a good idea to check the catalog first, specifically links and references, and even more specifically:

• https://github.com/manuzhang/mkdocs-htmlproofer-plugin
• https://www.mkdocs.org/user-guide/configuration/#validation

I'm sorry that I can't answer each and every question, that's what this community is for. Tagging me doesn't make it better 😉

[doliG]

Hello, and thanks a lot for your answers!

It's my bad; I didn't know MkDocs and misunderstood that mkdocs-material is a framework on top of mkdocs, so I didn't check its documentation 🤡

All is clear now. I'm closing the discussion.