| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
|
Documentation preview for this PR is ready! 🎉 Built with commit: 77b999b |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
Description
Spotted a bad ref link (specifically the MD052 rule, we use "full" ref links), used a linter to search for any others and fixed those too.
Using linters on markdown aren't entirely reliable for our docs due to non-standard mkdocs syntax, notably admonitions not being recognized (thus indented content is treated as code blocks which causes false-positives such as with MD053 for detecting unused ref links).
Additionally added a note about false-positives when we have anchor links directly referencing admonitions content tabs:
The non-standard syntax doesn't allow us to add anchors (normally this can be done via mkdocs feature { #anchor-name }), and I think part of this false-positive is due to support implemented in mkdocs-material via an mkdocs extension.