mcpField
V
verifying-markdown-formatting

verifying-markdown-formatting

github.com/spencerpaulyドキュメント868410 回インストール13 週間前に更新
リポジトリ

verifying-markdown-formatting について

Markdown ファイルの書式を確認・修正し、意図された構成を保つスキルです。見出し、リスト、リンク、コード、表、空白などの規則を扱います。

主な機能

  1. 01見出しの階層と間隔の確認
  2. 02リスト記号とインデントの統一確認
  3. 03リンク、画像、コード書式の確認
  4. 04表、空白、水平線の確認
  5. 05執筆者の構成を維持

活用シーン

  1. 01公開前の Markdown 文書の点検
  2. 02プロジェクト文書の書式統一

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/spencerpauly/awesome-cursor-skills --skill verifying-markdown-formatting

インストール後、Claude Code で/verifying-markdown-formattingを入力して読み込まれたか確認します。

詳細

Markdown の書式を検証する

Markdown ファイルの書式の問題を確認し、修正します。

確認項目

構造
  • ファイルの先頭に # H1 見出しがちょうど 1 つある
  • 見出しのレベルが 1 つずつ上がっている(## から #### に飛ばない)
  • すべての見出しの前後に空行がある
  • すべてのコードブロック、リスト、引用ブロックの前後に空行がある
  • ファイルの末尾に改行が 1 つだけある
リスト
  • 各リスト内でマーカーのスタイルが統一されている(- と * や + を混在させない)
  • 入れ子の項目は 2 つまたは 4 つのスペースでインデントされ、全体を通して統一されている
  • トップレベルのリストの最初の項目の前に空行がある
  • 連続したリストでは項目間に空行がない(または、すべての項目を空行で区切る。どちらかを選ぶ)
リンクと画像
  • すべてのリンクに空でない表示テキストがある:[](url) ではなく [text](url)
  • コードブロック外に裸の URL がない。<url> または [text](url) で囲む
  • 参照形式のリンクに対応する定義がある
  • 画像に代替テキストがある:![](src) ではなく ![alt](src)
コードブロック
  • フェンス付きコードブロックにはチルダではなく、3 つのバッククォートを使う
  • すべてのフェンス付きコードブロックに言語識別子がある(```python、```bash など)
  • インラインコードでは短い参照に単一のバッククォートを使う
  • インデントされたコードブロックがない(明確にするため、代わりにフェンス付きコードブロックを使う)
書式
  • 太字には __text__ ではなく **text** を使う
  • 斜体には _text_ ではなく *text* を使う
  • 行末に余分な空白がない
  • 実用上可能な範囲で、行の長さを 120 文字未満にする(表を除く)
  • ATX 形式の見出し(下線形式ではなく # 見出し)を一貫して使う
表
  • ヘッダー行に、各列を --- で区切る行がある
  • セルの内容に余分な空白がない
  • 列の配置マーカー(:---、:---:、---:)を使う場合は、一貫して使用する
水平線
  • 水平線には、上下に空行を置いた単独行の --- を使う
  • スタイルを統一する(---、***、___ を混在させない)

ワークフロー

  1. 対象の Markdown ファイルを読みます
  2. 上記の各項目を確認します
  3. 見つかった問題を、文字列の完全一致置換で修正します
  4. ファイルを再読し、修正がすべて正しく適用されたことを確認します
  5. 修正した箇所と、もともと正しかった箇所を報告します

注意事項

  • このスキルで扱うのは書式のみです。内容の正確性、リンク切れ、スペルは検証しません
  • 作者の意図した構成を保ち、セクションを再編成しないでください
  • リストマーカーを修正する場合は、ファイル内で最もよく使われているスタイルに合わせてください

コメント