行き先の無いリンク
broken-link既定で動く日本語 / 英語
行き先が空のリンク、文書に無い見出しを指すリンク、定義の無い参照の形のリンク
例
直し方
行き先を書いてください。見出しを指すなら、今の見出しの言葉に合わせてください。参照の形なら、文書のどこかに「[名前]: URL」の行を足してください。
なぜ指摘するのか
押しても何も起きないリンクは、読み手に「あるはずの情報が無い」と思わせます。三つを見ます。行き先が空のリンク（[資料]()）、同じページの見出しを指すのにその見出しが無いリンク（[手順](#手順) で「手順」の見出しを消した・書き換えた）、参照の形で書いたのに定義が無いもの（[資料][1] で「[1]:」の行が無い。そのまま字で表示されます）。見出しから名前を作る決まりは表示するものごとに違うので、字と数字だけを比べ、大文字小文字・空白・記号の違いは問いません。[1][2] のように数だけの括弧は文献の番号として数えません（markdownlint の MD042・MD051・MD052）。
指摘しないもの
見出しの名前は字と数字だけで比べ、大文字小文字や記号の違いは問いません。「[1][2]」のような文献の番号、「A[i][j]」のような添字、使われていない定義、サイトが定義を足す名前を省いた画像の参照（「![完了][]」の印）も指しません。
止める・ゆるめる
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
- 文書から読み取るもの
- markdown
強さ（段階）
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。
| strict | エラー |
|---|---|
| normal | 注意 |
| relaxed | 情報 |
このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, legal/contract, legal/statute, legal/judgment, legal/patent, docs/manual, docs/faq, docs/glossary, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
指摘の文
リンク「{link}」の行き先がありません
リンク「{link}」の行き先が空です
リンク「{link}」が指す「{target}」の見出しがこの文書にありません
「{link}」は参照の形ですが、名前の定義がありません（字のまま表示されます）
このページはルールの定義ファイルから作られています:packages/chaff/rules/broken-link.yaml