ほかのファイルへの行き先の無いリンク
cross-doc-broken-link既定で動く日本語 / 英語
一緒に見たほかのファイルへのリンクで、行き先のファイルか見出しが無いもの
例
直し方
行き先のファイルの今の名前と、今の見出しの言葉に合わせてください。ファイルや見出しを消したなら、リンクも消すか、代わりのページを指してください。
なぜ指摘するのか
説明書や文書の束では、ページどうしを相対パスのリンクでつなぎます([料金](./pricing.md#月額料金))。ファイルの名前を変えたり見出しを書き換えたりすると、ほかのページからのリンクが行き先を失います。一つのファイルだけを見ても、行き先のファイルや見出しがあるかは分かりません。一度に渡したファイルどうしを突き合わせ、行き先のファイルが無いリンクと、行き先のファイルに無い見出しを指すリンクを指します。見出しの名前は字と数字だけで比べます。
指摘しないもの
URL、サイトの根からのパス(/guide/)、同じページの中へのリンク(broken-link が見ます)、Markdown でないファイル(画像やスクリプト)へのリンクは見ません。行き先のファイルが無くても、一緒に見たファイルのどれも置かれていないフォルダのものと、フォルダを指すリンク(./guide/)は、確かめようがないので指しません。拡張子を書かないリンク(./reference)は、.md などを補って探します。
止める・ゆるめる
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
- 文書から読み取るもの
- markdown, documents
強さ(段階)
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}」が指すファイル「{target}」が、一緒に見たファイルの中にありません
リンク「{link}」が指す「{target}」の見出しが、そのファイルにありません
このページはルールの定義ファイルから作られています:packages/chaff/rules/cross-doc-broken-link.yaml