polyshSOP リンクチェッカー
文書の中で、読み手が開けないリンクを見つけられます。
- ブラウザ内で動作
- アップロード不要
- アカウント不要
このツールは英語のテキストを分析します。
ブラウザツールを読み込んでいます…
SOP リンクチェッカーでできること
手順書やヘルプ記事には、ダッシュボード、ランブック、ポリシーへのリンクがたまっていきますが、その多くは書いた本人にしか開けません。文書を貼り付けると、Markdown リンク、参照リンク、HTML リンク、むき出しの URL がすべて行ごとに一覧表示され、状態が OK、警告、エラーで示されます。
警告の対象は、http:// のリンク、https:// のない URL、localhost や wiki.corp のような内部ホスト、テキストが空のリンク、代替テキストのない画像、重複です。エラーの対象は、構文の誤り、URL 内のスペース、javascript: リンク、埋め込まれたパスワード、そして文書内のどの見出しからも作られない #アンカーです。長い SOP で最も多い壊れたリンクは、この #アンカーです。
例
入力
## Setup - [Admin console](http://admin.example.com) - [Runbook](https://wiki.corp/mfa) - [Back to setup](#setup) - [Policy](#security-policy)
結果
Links checked: 4 Errors: 1 (#security-policy: no heading creates it) Warnings: 2 (http:// link, internal host wiki.corp)
#setup は Setup の見出しと一致するので問題ありません。#security-policy には一致する見出しがありません。
SOP リンクチェッカーの使い方
- SOP、Markdown ファイル、HTML を貼り付けるか、「ファイルを開く」を使います。
- 「状態」の列でエラーと警告の行を探します。「注記」の列に、何を直せばよいかが書かれています。
- 元の文書のリンクを直してもう一度貼り付け、「コピー」を押してレポートを保存します。
知っておきたいこと
- アンカーは、Markdown の # 見出しと id 属性だけと照合します。すべて大文字の行やコロンで終わる行で書かれた見出しは、本来の Markdown の見出しにするまでアンカーを作りません。
- ../billing.md のような相対リンクは一覧に表示されますが、解決はしません。チェッカーからはサイトのほかの部分が見えないためです。
- 重複は大文字・小文字と末尾のスラッシュを無視して判定するので、クエリ文字列だけが違う 2 つのリンクは別のものとして扱います。
SOP リンクチェッカーについてよくある質問
Markdown のアンカーリンクが壊れるのはなぜですか？
アンカーは見出しのテキストから作られるため、見出しの名前を変えるとアンカーも変わります。GitHub では Setup & Install は #setup--install になり、句読点は削除され、スペースはハイフンになります。古い見出しに合わせて書いたリンクや、句読点が間違っているリンクは、どこも指さなくなります。
SOP のリンクは https にすべきですか？
はい、サイトが対応している限りそうしてください。ブラウザは http のページに警告を出し、企業ネットワークによってはブロックされ、多くのツールは http のリンクを書き換えたり削除したりします。手順書に http のリンクがあるのは、ページが移動したか、古い文書からリンクをコピーしたしるしであることがよくあります。
ページが停止しているかどうかもわかりますか？
いいえ。文書を読むだけでリクエストは送らないため、エラーを返すページやリダイレクトするページも、ここでは問題なく見えます。読み込めることを確かめるには、OK のリンクを自分で開くか、クローラーを使ってください。