Crossref-verifier

Tool for verifying local and external references in repository documentation.

For now, support for markdown files only is provided.

Build instructions ↑

Run stack build to build everything.

Usage ↑

To find all broken links in repository run

stack exec crossref-verify -- --root <repository>

By default, only repo-local references are verified; to include references to external resources provide corresponding value for --mode parameter:

stack exec crossref-verify -- -root <repository> --mode full

This tool requires configuration file (./.crossref-verifier.yaml is used by default) where you can specify external links checker timeout, list of excluded files and other parameters.

Issue tracker ↑

We use YouTrack as our issue tracker. You can login using your GitHub account to leave a comment or create a new issue.

For Contributors ↑

Please see CONTRIBUTING.md for more information.

About Serokell ↑

Crossref-verifier is maintained by Serokell.

We love open source software. See which services we provide and drop us a line if you are interested.

1.4 KiB Raw Blame History