docscheck

command
v0.18.52 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Documentation

Overview

Command docscheck resolves every relative link and #anchor markdown documentation makes against the tree, and checks that every top-level docs/*.md page is reachable by following links starting at docs/README.md. See `task docs:check`.

Scope: README.md, CONTRIBUTING.md, and every *.md file under docs/ (recursively). Anchors are validated against GitHub's heading-slug rules (lowercase, strip punctuation, spaces become hyphens, duplicate headings get -1/-2/... suffixes) applied to the heading's rendered text — inline code spans and emphasis markers are stripped the way GitHub's renderer would strip them before slugging.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL