Skip to content

MD059 - descriptive-link-text

Description

This rule is triggered when a link has generic text like "click here" or "link". Link text should be descriptive and communicate the purpose of the link (e.g., "Download document" or "Installation Guide"). This rule checks Markdown links only; HTML links are ignored.

Rationale

Descriptive link text is especially important for screen readers which sometimes present links without context. Generic text like 'click here' or 'more' does not communicate what the link leads to.

Configuration

prohibited_texts

List of prohibited link text values.

  • Default: ["click here", "here", "link", "more"]

Examples

Invalid

# Non-Descriptive Links

For more information, [click here](https://example.com/).

See the documentation [here](https://docs.example.com/).

Visit this [link](https://example.com/page) for details.

Read [more](https://example.com/article).

Valid

# Descriptive Links

Download the [document](https://example.com/document.pdf).

See the [Installation Guide](./install.md) for details.