問題

問題パネルは、執筆中に見落としやすい問題をプロジェクト全体からスキャンします。とりわけ重要なのが、すでに存在しないものを指すリンクや画像の検出です。ウィンドウ下部にドッキングされたパネルで、ターミナルや検索パネルと同じ領域を共有します。

問題パネルを開く

左端のアクティビティバーにある 問題 アイコンをクリックすると、パネルの表示・非表示を切り替えられます。初めて開いたときは、スキャンを開始するための 参照をチェック カードが表示されます。

参照をチェック

参照をチェック は、プロジェクト内のすべての Markdown ファイルをスキャンし、解決できない参照を報告します。次のような問題を検出します。

  • ファイルが見つかりません — リンクまたは画像が存在しないファイルを指している(たとえば、名前を変更したり削除したりしたファイル)
  • 見出しが見つかりません#anchor リンクが、対象ドキュメントに存在しない見出しを指している
  • 到達できない外部 URL — 任意で、エラーを返す外部リンクを HTTP ステータスとともに表示

スキャンは 参照をチェック カードから、またはメニューの ツール > 参照をチェック から開始できます。スキャン中はパネルに進捗が表示され、完了すると結果がファイルごとにグループ化されて表示されます。

結果を読む

問題を含む各ファイルはツリー内のグループとして表示され、展開するとそのファイル内のすべての壊れた参照が一覧表示されます。各項目には次の内容が表示されます。

  • 参照が現れる 行番号
  • ドキュメントに記述されているままの 参照テキスト
  • 簡潔な 理由 — 「ファイルが見つかりません」「見出し … が見つかりません」、または到達できない URL の HTTP ステータス

項目をクリックすると、そのファイルが開き該当行にジャンプするので、その場で修正できます。修正後は 再スキャン を使ってチェックを再実行し、問題が解消されたことを確認してください。

使いどころ

参照のチェックが最も役立つのは、ドキュメントを公開または共有する前、ファイルの名前変更や再構成を一通り行った後、あるいはドキュメント間でコンテンツを移動したときです。解決できないリンクをクリックしたときに表示されるインラインの壊れたリンク通知を補完するもので、問題パネルなら同種の問題をプロジェクト全体から一度にまとめて見つけられます。1 件ずつ対処する必要はありません。