index

Linter: the index document links every Markdown document of the repository.

Example#

CONTENTS.md:

# Contents

- [Guide](docs/guide.md)

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

CONTENTS.md:1: document not listed: docs/setup.md (index)
markright: 1 issue(s)

Fixed:

# Contents

- [Guide](docs/guide.md)
- [Setup](docs/setup.md)

Settings#

Under linters.settings.index:

With the defaults, in .markright.yaml:

linters:
  settings:
    index:
      file: CONTENTS.md

or in .markright.toml:

[linters.settings.index]
file = "CONTENTS.md"

Turning it off#

linters:
  disable: [index]

[linters]
disable = ["index"]

More in Rules.