ルールの一覧へ

見出しの深さが飛んでいる

heading-level-skip既定で動く(情報)日本語 / 英語

「##」の次に「####」が来るように、見出しの深さが一段以上飛んでいる所

例

指摘される文
# 手順書 ## 準備 道具をそろえます。 #### 注意 手袋をはめます。
chaff の出力
7:1 見出し「注意」の深さが 2 から 4 へ飛んでいます(3 のはず)
直した文
# 手順書 ## 準備 道具をそろえます。 ### 注意 手袋をはめます。
chaff の出力
指摘なし

直し方

一つ前の見出しより一段だけ深くしてください。文字の大きさを変えたいだけなら、深さではなく表示の設定で変えてください。

なぜ指摘するのか

「##」の次に「####」が来ると、間の一段が抜けます。目次や画面読み上げは見出しの深さで文書の形を伝えるので、抜けた段は「どこかの節が消えた」ように読めます。見た目の大きさのために深さを選ぶと起きます。最初の見出しは何段から始めてもよく、一つ前の見出しより二段以上深いときだけ指摘します(markdownlint の MD001 と同じ数え方)。

指摘しないもの

最初の見出しは何段から始めてもかまいません。浅くなる見出し(「####」の次の「##」)も指しません。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: heading-level-skip — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax heading-level-skip --why "理由"
チームで止める(chaff.yaml)
rules: heading-level-skip: 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}」の深さが {from} から {to} へ飛んでいます({expected} のはず)

このページはルールの定義ファイルから作られています:packages/chaff/rules/heading-level-skip.yaml