serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-07-14 17:00:33 +03:00
Code Issues Projects Releases Wiki Activity
Check cross-references in repository documents
16 Commits 33 Branches 10 Tags 1.3 MiB
Haskell 80.4%
Shell 11.1%
Ruby 4.9%
Nix 2.3%
Makefile 1.3%
ad1ccccad7
Go to file
martoon ad1ccccad7
Add README and other required meta files
2019-03-14 20:29:36 +03:00
.github Add README and other required meta files 2019-03-14 20:29:36 +03:00
exec Make verbosity a CLI parameter, not config one 2019-03-13 13:30:39 +03:00
src/Crv Add README and other required meta files 2019-03-14 20:29:36 +03:00
tests Add tests on header to anchor conversion 2019-03-11 17:16:06 +03:00
.crossref-verifier.yaml Allow to specify virtual files 2019-03-13 15:29:33 +03:00
.gitignore [INT-31] Implement cross-references verifier 2018-10-11 02:51:28 +03:00
LICENSE Add README and other required meta files 2019-03-14 20:29:36 +03:00
package.yaml Allow to specify virtual files 2019-03-13 15:29:33 +03:00
README.md Add README and other required meta files 2019-03-14 20:29:36 +03:00
Setup.hs [INT-31] Implement cross-references verifier 2018-10-11 02:51:28 +03:00
stack.yaml [INT-31] Add config and CLI options 2018-10-11 17:27:59 +03:00

README.md

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.