mirror of https://github.com/serokell/xrefcheck.git synced 2024-09-17 16:37:30 +03:00

martoon 0671986bcb

Problem: currently `crossref-verify` executable does not work without
configuration, and user was supposed to use one from the repository if
he does not have its own. This is very inconvenient.

Solution: make executable remember some config and use it by default.

2019-12-03 23:19:37 +03:00

1.2 KiB

Raw Blame History

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

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.2 KiB Raw Blame History