Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raviqqe/liche
Fast Link Checker for Markdown and HTML in Go
https://github.com/raviqqe/liche
go html linter markdown
Last synced: 5 days ago
JSON representation
Fast Link Checker for Markdown and HTML in Go
- Host: GitHub
- URL: https://github.com/raviqqe/liche
- Owner: raviqqe
- License: mit
- Created: 2017-11-16T01:44:06.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T21:58:14.000Z (8 months ago)
- Last Synced: 2025-01-01T02:13:24.564Z (12 days ago)
- Topics: go, html, linter, markdown
- Language: Go
- Homepage:
- Size: 124 KB
- Stars: 125
- Watchers: 5
- Forks: 31
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## DEPRECATION NOTICE
Sorry this project is not actively maintained anymore! 😢 Please consider migrating to one of the alternatives listed below.
### Alternatives
- [muffet](https://github.com/raviqqe/muffet)
- Fast website link checker in Go
- [lychee](https://github.com/lycheeverse/lychee)
- A glorious link checker
- This tool supports testing links both in local files and on websites.
- [hyperlink](https://github.com/untitaker/hyperlink)
- Checks folder of HTML for relative/internal links (no markdown or external websites)
### Why is it not maintained anymore?
It's because we found several problems with the goals of the project and the amount of work it needs.
The goal of this software was originally to check links in Markdown files which are **compiled into HTML files and served via HTTP servers**. But that raises the following problems.
- We cannot test links which do not exist in the Markdown files.
- For example, some markdown-based static site generators generate links at compile time.
- e.g. automatic generation of table of contents
- We cannot test the behaviour of HTTP servers.
- Different HTTP servers handles URLs differently.
- e.g. trailing slashes, inference of page file extensions, ...
It needs a lot of work to support all these different use cases. In short, we need to emulate different Markdown file compilers and HTTP servers as well as web browsers.
### But I still want this...
If you think this software is still valuable for you even in comparison with the alternatives listed above and want it to be maintained, please let us know by posting a new issue.
# liche
[](https://circleci.com/gh/raviqqe/liche)
[](https://codecov.io/gh/raviqqe/liche)
[](https://goreportcard.com/report/github.com/raviqqe/liche)
[](LICENSE)
[](https://asciinema.org/a/148896)
`liche` is a command to check links' connectivity in Markdown and HTML files.
It checks all `a` and `img` tags in specified files.
## Installation
```sh
go get -u github.com/raviqqe/liche
```
- requires [Go Modules]("https://github.com/golang/go/wiki/Modules#how-to-use-modules")
## Usage
```sh
> liche --help
Link checker for Markdown and HTML
Usage:
liche [-c ] [-d ] [-r] [-t ] [-x ] [-v] ...
Options:
-c, --concurrency Set max number of concurrent HTTP requests. [default: 512]
-d, --document-root Set document root directory for absolute paths.
-r, --recursive Search Markdown and HTML files recursively
-t, --timeout Set timeout for HTTP requests in seconds. Disabled by default.
-x, --exclude Regex of links to exclude from checking.
-v, --verbose Be verbose.
```
## Examples
```sh
> liche file.md
> liche file1.md file2.md
> liche file.html
> liche file1.html file2.html
> liche -r directory # Search all Markdown and HTML files recursively.
```
## Supported properties
- File extensions: `.md`, `.html`, `.htm`
- HTML tags: `a`, `img`
- HTML attributes: `href`, `src`
- URL schemes: `http`, `https`
Also supports relative and absolute paths.
(Absolute paths need `--document-root` option.)
## License
[MIT](LICENSE)