md-lint について
md-lintは、Markdown文書の整形とルール確認を行うスキルです。編集後にmarkdownlint-cli2とPrettierを実行し、自動修正できる項目と手動対応が必要な項目を分けます。
主な機能
- 01編集後のMarkdown整形
- 02一般的なMarkdown問題の修正
- 03手動修正が必要なルールの提示
- 04準拠するMarkdown記法の説明
活用シーン
- 01編集後のMarkdown書式統一
- 02見出し・空白・リンクの確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ jimweller/ clanker-skills --skill md-lintインストール後、Claude Code で/md-lintを入力して読み込まれたか確認します。
詳細
STARTER_CHARACTER = 🔏
Markdown フォーマッターの仕様
PostToolUse フックは、.llmtmp/、.llmdocs/、SKILL.md、プランファイルを除く、書き込みまたは編集されたすべての Markdown ファイルに対して、markdownlint-cli2 --fix を実行してから prettier --write を実行します。この仕様ファイルへの書き込みは書き換えを回避します。書き換えが発生すると、ファイルのコンテキスト内コピーが無効になります。
prettier が書き換える内容
| 入力 | 出力 |
|---|---|
* item、+ item | - item |
1) の順序付きリストマーカー | 1. |
*emphasis* | _emphasis_ |
__strong__ | **strong** |
*** の水平線 | --- |
| 2 行以上の空行 | 1 行の空行 |
| 行内の連続するスペース | 単一のスペース |
| パディングのない表のセル | 列幅に合わせてパディングされたセル |
| 末尾の改行なし | 末尾に改行を追加 |
文章は折り返されません。長い行も記述されたとおりに保たれます。
markdownlint が修正する内容
# の後のスペース不足、見出しとフェンス付きブロックの前後の空行不足、末尾の空白、ベア URL。
4 つのルールは無効になっています。MD013(行の長さ)、MD024(見出しの重複)、MD029(順序付きリストのプレフィックス)、MD033(インライン HTML)。
どちらでも修正できない内容
これらはフックのフィードバックとしてモデルに届くため、手動で編集する必要があります。
- MD003、見出しのスタイル。
===または---で下線を付けた Setext 見出しはエラーです。ATX(#、##)を使用してください。 - MD025、ドキュメント内の H1 は 1 つだけにしてください。
- MD045、画像には代替テキストが必要です。
- MD042、リンクにはリンク先が必要です。
- MD040、フェンス付きコードブロックには言語の指定が必要です。
準拠する Markdown の書き方
先頭に単一の # Title を記述してください。ATX 見出し、- の箇条書き、_emphasis_、**strong** を使用し、ブロック間には空行を 1 行入れ、すべてのコードフェンスに言語を指定し、すべての画像に代替テキストを付け、末尾に改行を入れてください。
コメント
Markdown 対応