• #markdownlint
  • #eslint
  • #設定
未分類

概要

apps/web/.markdownlint.jsonで、以下のルールを無効化している。

{
  "MD022": false,
  "MD025": false,
  "MD032": false,
  "MD036": false
}

無効化したルール

MD022: blanks-around-headings

ルール内容: 見出し(#, ## など)の前後に空行が必要

無効化理由: Nuxt Content / MDXでは、フロントマター直後の見出しやコンポーネント直後の見出しで空行がない場合がある。コンテンツの可読性に影響しないため無効化した。

<!-- 警告が出るパターン -->
---
title: "Example"
---
## 見出し  ← フロントマター直後に空行なし

MD025: single-title/single-h1

ルール内容: ドキュメント内に H1(#)は1つだけであるべき

無効化理由: フロントマターのtitleフィールドがページタイトルとして使用されるため、本文中にも#を使用することがある。また、MDXコンポーネントのドキュメントなどで複数のH1が必要な場合もある。

---
title: "ページタイトル"  ← これが H1 相当
---

# セクション1  ← MD025 警告

# セクション2  ← MD025 警告

MD032: blanks-around-lists

ルール内容: リスト(-, *, 1. など)の前後に空行が必要

無効化理由: MDXでは、コンポーネント内のリストや見出し直後のリストで空行を省略することがある。スタイル上の好みであり、レンダリングに影響しないため無効化した。

## 項目一覧
- Item 1  ← 見出し直後に空行なし
- Item 2

MD036: no-emphasis-as-heading

ルール内容: 強調(**太字**)を見出し代わりに使用してはいけない

無効化理由: コンテンツによっては、見出しレベルを増やさずに視覚的な区切りとして強調テキストを使用する場合がある。特に翻訳ドキュメントや引用では、元のフォーマットを維持するため無効化した。

**重要なポイント**  ← 見出しではなく強調として使用

ここに説明文...

参考リンク