{"repo":"serokell/xrefcheck","free":true,"listed":false,"github":"https://github.com/serokell/xrefcheck","clone":"git clone https://github.com/serokell/xrefcheck.git","description":"Check cross-references in repository documents","language":"Haskell","stars":57,"topics":["markdown","github","verifier","link-checker"],"license":"MPL-2.0","category":"productivity","readme_excerpt":"Xrefcheck Xrefcheck is a tool for verifying local and external references in a repository's documentation that is quick, easy to setup, and suitable to be run on a CI pipeline. Motivation ↑ As a project evolves, links in markdown documentation have a tendency to become broken. This is usually because: 1. A file has been moved; 2. A markdown header has been renamed; 3. An external site has ceased to exist. This tool will help you to keep references in order. You can run xrefcheck continuously in your CI pipeline, and it will let you know when it finds a broken link. Aims ↑ Comparing to alternative solutions, this tool tries to achieve the following points: Quickness References are verified in parallel. References with the same target URI are only verified once. It first attempts to verify external links with a HEAD request; only when that fails does it try a GET request. Resilience When you have many links to the same domain, the service is likely to start replying with \"429 Too Many Requests\". When this happens, xrefcheck will wait the requested amount of seconds before retrying. Easy setup - no extra actions required, just run xrefcheck in the repository root. Conservative verifier allows using this tool in CI, no false positives (e.g. on sites which require authentication) should be reported. Features ↑ Supports both GitHub and GitLab flavored markdown. Supports Windows and Unix systems. Supports relative and absolute local links. Supports external links ( http , https , ft","default_branch":null,"files":null,"tree":[],"storefront":"/r/serokell","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/serokell/xrefcheck/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}