link-text

New Settings Since v0.1.0

Linter: a link's text says where it leads, not one of the phrases its settings list, such as here.

Example#

doc.md:

The guide is [here](docs/guide.md).

With docs/guide.md in the repository, markright check reports:

doc.md:1: link text says nothing about its target: here (link-text)
markright: 1 issue(s)

Fixed:

Read [the guide](docs/guide.md).

Settings#

Under linters.settings.link-text:

KeyMeaningDefault
phrasesThe texts that say nothing about where a link leads, compared without case and without the punctuation around themclick here, here, link, more, read more, this, this link

With the defaults, in .markright.yaml:

linters:
  settings:
    link-text:
      phrases: ["click here", here, link, more, "read more", this, "this link"]

or in .markright.toml:

[linters.settings.link-text]
phrases = ["click here","here","link","more","read more","this","this link"]

Turning it off#

linters:
  disable: [link-text]
[linters]
disable = ["link-text"]

More in Rules.

Settings

Appearance

ThemeColours of every page

Reading

Code blocksLines longer than the block
TablesCells wider than the page

Accessibility

Text sizeEvery page, in proportion
LinksLinks inside the text
MotionAnimations and smooth scrolling
ScrollbarsCode blocks, tables and other scrolling areas