markdownlint/doc-build/md059.md

16 lines
748 B
Markdown

This rule is triggered when a link is set with generic text like
"Click here", "here", or "learn more", giving it a generic accessible name.
Rationale: Screen reader users may navigate through a list of links
to quickly find content on a page. When the link name is something ambiguous
like "Learn more", there isn't sufficient context to help the user determine
whether to follow the link.
Link names should be descriptive and describe the purpose of the link, like:
`[Download the budget document]`, `[About markdownlint]`,`[View registration]`,
etc.
To override the default list and configure your own list of banned accessible
names, set `link_texts` in the config.
Note: This rule checks Markdown-style links and ignores HTML-style links.