readme-links

New Settings Repository Since v0.1.0

Linter: the README links each of the configured documents that exists.

Example#

README.md:

# Project

A tool.

With CONTENTS.md in the repository, markright check reports:

README.md:1: does not link CONTENTS.md (readme-links)
markright: 1 issue(s)

Fixed:

# Project

A tool. See the [contents](CONTENTS.md).

Under linters.settings.readme-links:

Key	Meaning	Default
`file`	The README	`README.md`
`links`	Documents the README must link, when they exist	`CONTENTS.md`, `GLOSSARY.md`, `STANDARDS.md`

With the defaults, in .markright.yaml:

linters:
  settings:
    readme-links:
      file: README.md
      links: [CONTENTS.md, GLOSSARY.md, STANDARDS.md]

or in .markright.toml:

[linters.settings.readme-links]
file = "README.md"
links = ["CONTENTS.md","GLOSSARY.md","STANDARDS.md"]

linters:
  disable: [readme-links]

[linters]
disable = ["readme-links"]