https://github.com/client9/linkcheck
Checks links in static html websites before being published
https://github.com/client9/linkcheck
Last synced: over 1 year ago
JSON representation
Checks links in static html websites before being published
- Host: GitHub
- URL: https://github.com/client9/linkcheck
- Owner: client9
- License: mit
- Created: 2018-12-29T07:57:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-01T07:28:57.000Z (over 7 years ago)
- Last Synced: 2025-02-01T11:41:28.296Z (over 1 year ago)
- Language: Shell
- Size: 20.5 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# linkcheck
Checks links in static websites before being published
## What Problem Does It Solve?
Making sure internal links (links pointing to other documents in the same site) are working.
While there are a few other services that test links on the live site, it's even better to find problems before they are published.
Likewise, most static website generators have a method to do cross-referencing (e.g. [Hugo](https://gohugo.io/content-management/cross-references/)) but it's sometimes clunky and it's not enforced. Most of the time that only works for content. Another problem is that links can be in the template, and be generated as well.
LinkCheck works off the output of the static site generator and checks all cross-references.
## Status
Embarrassing alpha, but works.
## Todo
* Clean up code so other people can work on this
* Check linking to non-HTML internal resources
* Remove hostname from fully specified internal links
* Check for URL normalization
* Check for external dead links
* Allow or warn on links that are not HTTPS
* Checking URL fragments match anchors
* Find links to aliases that should the primary permalink (See [Hugo and Aliases](https://gohugo.io/content-management/urls/#aliases)).