https://github.com/open-ch/checkdoc
Basic markdown documentation checker/linter: enforce basic quality standards for your repository's documentation.
https://github.com/open-ch/checkdoc
documentation linter markdown
Last synced: 5 months ago
JSON representation
Basic markdown documentation checker/linter: enforce basic quality standards for your repository's documentation.
- Host: GitHub
- URL: https://github.com/open-ch/checkdoc
- Owner: open-ch
- License: apache-2.0
- Created: 2020-05-12T10:22:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-23T16:02:50.000Z (5 months ago)
- Last Synced: 2026-01-24T02:41:21.255Z (5 months ago)
- Topics: documentation, linter, markdown
- Language: Go
- Homepage:
- Size: 311 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# checkdoc
`checkdoc` is a tool that helps you assess if a markdown documentation tree is in good shape, at least from a linking perspective.
Its main goal is to enforce minimal quality standards in a repository's documentation.
It will tell you if:
- Markdown files are not referenced (directly or through other files) from a readme in the root directory
of a repository
- There are broken internal links
## Sample Usage
Used on this repository, checkdoc yields the following:
```
$ checkdoc verify
INFO Running verify on tree root /tmp/checkdoc
INFO Considering basenames [] and extensions [.md]
DEBU Found 1 nodes at:
DEBU README.md:
INFO Checking for orphaned documents...
INFO No orphans found.
INFO Checking for dead links...
ERRO Located some files with dead links:
ERRO README.md
ERRO CHANGELOG.md
ERRO Verify failed on tree root /tmp/checkdoc
```
As shown above, it detects that we have a dead link to a non-existing file.
## Installation
```
go install github.com/open-ch/checkdoc@latest
```
Then run it with `checkdoc`, assuming your `$GOPATH/bin` is on your `PATH`. You should see something along these lines:
```
checkdoc
A markdown documentation validator intended to enforce a healthy documentation in settings such as a fat repo.
Usage:
checkdoc [command]
Available Commands:
help Help about any command
verify Runs sanity checks on the documentation
Flags:
-h, --help help for checkdoc
-r, --root string Path to the root of the markdown documentation hierarchy to validate (default ".")
-g, --use-git-root from the given root, fall back to the repository's root. This will cause checkdoc to fail if --root is not pointing to a repository. (default true)
Use "checkdoc [command] --help" for more information about a command.
```
## Note For GitHub Readers
While the content of this module is managed in an internal repository,
you may still submit PR's.
## License
Please see the LICENSE file.