https://github.com/norfairking/linkcheck

A fast link checker for CI
https://github.com/norfairking/linkcheck

Last synced: 2 months ago
JSON representation

A fast link checker for CI

• Host: GitHub
• URL: https://github.com/norfairking/linkcheck
• Owner: NorfairKing
• Created: 2020-07-02T19:10:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T10:50:15.000Z (6 months ago)
• Last Synced: 2024-10-30T09:26:20.258Z (2 months ago)
• Language: Haskell
• Size: 101 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Link check

A fast linkchecker for CI.

This is designed to be run on CI to make sure that you do not have dead links on the website that you are about to deploy.

## Using linkcheck

Start your server locally on `localhost:8000` and run `linkcheck` as follows:

```

linkcheck http://localhost:8000

```

### Using linkcheck as part of a nix derivation

```

stdenv.mkDerivation {

  name = "site";

  buildInputs = [ final.haskellPackages.linkcheck final.killall ];

  buildCommand = ''

    mkdir -p $out

    cp -r ${site}/. $out

    $out/bin/site &

    linkcheck http://localhost:8000

    killall site

  '';

};

```

## Limitations

* `linkcheck` does not try to run JavaScript

* Only supports these tags:

  - `href` in `a` tags 

  - `src` in `img` tags.

  - `href` in `link` tags.

* Does not honor `robots.txt`

* Does not try to fetch external links