🎃

デッドリンクのチェックにはlycheeが良い!

に公開

はじめに

デッドリンクチェック好きな私が使いやすいと思ったツールlycheeを紹介します。

htmlファイルやmarkdownファイルに書かれているリンクが生きているかって、定期的に確認したいですよね?

そんなデッドリンクのチェックをするため、いくつかのツールを使用してきました。

私がデッドリンクチェックに求めるもの

私がデッドリンクのチェックに求めるものは以下です。

  • ツールをインストールしたくないから、dockerで動くこと
  • リンクチェックのスピードが速いこと
  • チェック対象外のURLを指定できること
  • htmlファイルやmarkdownファイルをチェックできること
  • 結果をファイルに出力できること

ツール

上記の求めるものにマッチするのがlycheeです。

lycheeverse/lychee: ⚡ Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!

スピードが速いし、

注意するのは再帰的にリンクをチェックする機能はないことです。例えば、ウェブサイトのルートから各記事のリンクを辿って、リンクをチェックするような機能はないんです。再帰的にチェックしたい場合は別のツールを使うことになります。

私の使い方

dockerで以下のように動かします。

定義ファイルのlychee.tomlにチェック対象外のURLを正規表現で書てます。

docker run --init -it --rm -w /input -v $(pwd):/input lycheeverse/lychee . -c lychee.toml

デッドリンクが大量に検出される場合は、-o file_name.txtのようにファイルに出力してゆっくり確認するようにしています。

GitHubで編集を提案

Discussion