linkstat はドキュメントに記載されているリンクの疎通確認を行うスクリプトです。リンク切れの早期発見を行う事でドキュメントの健全性を保ちます。
現在対応しているのはMarkdownファイル(*.md)のみです。
本ライブラリは実行時にサービスへアクセスするため、大量に実行すると相手サービスに負荷が発生します。動作確認及びCI/CDに取り込む場合は、リンク先のサービス負荷は限りなく少なくして下さい。
pip install linkstatlinkstat {source_file_or_directory}オプションを使用することでJSON形式のレポートを出力できます。
linkstat --report-json {path} {source_file_or_directory}