太字にならずに見える「**」
unrendered-emphasis既定で動く日本語 / 英語
対にならず、太字にならないまま記号として見える「**」「__」
例
指摘される文
締め切りは**金曜日です。遅れないようにしてください。
chaff の出力
1:6 「**」が太字にならず、そのまま表示されます
直した文
締め切りは**金曜日**です。遅れないようにしてください。
chaff の出力
指摘なし
直し方
閉じ忘れなら閉じる「**」を足してください。括弧や句読点の内側に置いた記号は、括弧の外に出すか(「**「重要」**」の外側に空白を置く)、括弧ごと太字にしないでください。
なぜ指摘するのか
「**」や「__」は、Markdown が対にできたときだけ太字になり、対にできなければそのまま記号として表示されます。閉じ忘れ(「**重要」)のほか、日本語では「**「重要」**です」のように括弧や句読点の内側に記号を置き、外側に字が続くと、CommonMark の決まりで閉じられず、読み手には「**」が見えます。
指摘しないもの
語の中の記号(「2**10」「snake__case」)、前後が空白の記号、三つ以上並んだ記号(区切りや記入欄の「____」)、「__init__」のような名前、コードと引用の中の記号は指しません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: unrendered-emphasis — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax unrendered-emphasis --why "理由"
チームで止める(chaff.yaml)
rules:
unrendered-emphasis: 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
指摘の文
「{mark}」が太字にならず、そのまま表示されます
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/unrendered-emphasis.yaml