同じ見出しが兄弟に二つある
duplicate-heading既定で動く日本語 / 英語
同じ親の見出しの下に、同じ言葉の見出しが二つある所
例
指摘される文
# 手順書
## 準備
道具をそろえます。
## 準備
手袋をはめます。
chaff の出力
7:1 見出し「準備」は、同じ親の下の 3 行目の見出しと同じです
直した文
# 手順書
## 準備
道具をそろえます。
## 安全の確認
手袋をはめます。
chaff の出力
指摘なし
直し方
二つの節を一つにまとめるか、違いが分かる見出しに直してください。
なぜ指摘するのか
同じ親の見出しの下に、同じ言葉の見出しが二つあると、目次では区別できず、ページ内リンクはどちらか一方にしか行けません。節を写して見出しを直し忘れたか、同じ話を二か所に書いたときに起きます。親が違えば同じ言葉でもかまいません(変更履歴の版ごとの「追加」「修正」、各章の「まとめ」)。全角と半角、大文字と小文字、空白の数は同じ見出しとして比べます。
指摘しないもの
親が違う見出しどうし(版ごとの「追加」「修正」、章ごとの「まとめ」)は比べません。事例ごとに決まった見出しの組(【相談事例】【回答】、Question と Answer)を同じ順でくり返す所も言いません。括弧の添え書き(【事例(約款)】)は除いて組を見ます。Markdown の文書でだけ動きます。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: duplicate-heading — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax duplicate-heading --why "理由"
チームで止める(chaff.yaml)
rules:
duplicate-heading: off
技術的な情報
- 層
- 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
指摘の文
見出し「{heading}」は、同じ親の下の {firstLine} 行目の見出しと同じです
このページはルールの定義ファイルから作られています:packages/chaff/rules/duplicate-heading.yaml