https://github.com/epwalsh/check-links

A command-line utility for finding unreachable links in your crate's documentation
https://github.com/epwalsh/check-links

ci cli rust rust-cli

Last synced: 11 months ago
JSON representation

A command-line utility for finding unreachable links in your crate's documentation

• Host: GitHub
• URL: https://github.com/epwalsh/check-links
• Owner: epwalsh
• Created: 2019-09-17T15:20:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-12T00:20:40.000Z (about 6 years ago)
• Last Synced: 2024-10-07T12:42:17.636Z (over 1 year ago)
• Topics: ci, cli, rust, rust-cli
• Language: Rust
• Homepage:
• Size: 57.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# check-links

[![Build Status](https://travis-ci.org/epwalsh/check-links.svg?branch=master)](https://travis-ci.org/epwalsh/check-links) [![Latest version](https://img.shields.io/crates/v/check-links.svg)](https://crates.io/crates/check-links) ![License](https://img.shields.io/crates/l/check-links.svg)

A command-line utility for finding stale links in your crate's documentation.

Run `check-links` in the root of your project to recursively search for bad links across Markdown files and documentation comments in source files.

## Installing

#### From cargo:

```

cargo install check-links

```

#### From source:

```

git clone https://github.com/epwalsh/check-links.git

cd check-links

make release

ln -s [current directory]/target/release/check-links ~/bin/

```

## A note about spamming the internet

This script can be a useful addition to your CI pipeline to catch stale documentation, but if you have a ton of HTTP links in your project you may want to avoid running `check-links` too often, as your CI server could end up being blocked or rate-limited by certain hosts.