mcpField
M
markdown-formatting

markdown-formatting

github.com/atholaドキュメント34390 回インストール1 日前に更新
リポジトリ

markdown-formatting について

ドキュメントの作成者やレビュー担当者向けに、Markdown の文章整形規則を定めるスキルです。コード、表、frontmatter を除き、行幅や見出し・リストの間隔、リンク形式を扱います。

主な機能

  1. 01文章を80文字幅で折り返し
  2. 02見出しとリストの前後に空行
  3. 03ATX形式の見出しを使用
  4. 04長いURLには参照形式のリンクを推奨

活用シーン

  1. 01Markdown ドキュメントの作成・編集
  2. 02文章の行折り返しのレビュー
  3. 03プラグインからの Markdown 生成

インストール

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

$npx skills add https://github.com/athola/claude-night-market --skill markdown-formatting

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

同梱ファイルmodules/wrapping-rules.md

詳細

Markdown の書式規則

使用する場面

  • Markdown ドキュメントを新規作成または編集する場合
  • 行の折り返し規則への準拠について文章をレビューする場合
  • プラグイン（scribe、sanctum など）から Markdown を生成する場合

使用しない場面

  • コードブロック、表、フロントマターを編集する場合（それぞれ 独自の書式規則があります）
  • コミットしない簡単なメモを書く場合

これらの規則は、プラグインが生成または変更するすべての Markdown ドキュメントに適用されます。目的は、Git の差分を見やすくレビューしやすくし、 モバイル端末でも読みやすい文章を作成することです。

クイックリファレンス

Markdown の文章を新規作成または編集する場合：

  1. 文章は 80 文字で折り返します。ハイブリッド方式で折り返し、 任意の単語の途中ではなく、文や節の区切りを優先します。
  2. すべての見出しの前後に空行を入れます
  3. ATX 形式の見出しのみを使用します（# 見出し。setext 形式の下線は使用しません）
  4. すべてのリストの前に空行を入れます
  5. インラインリンクによって行が 80 文字を超える場合は、 参照形式のリンクを使用します

折り返す対象

次の内容は 80 文字で折り返します。

  • 段落（折り返し可能な文章）
  • 引用文（> の後の内容）
  • リスト項目の説明（- または 1. の後のテキスト）
  • 定義リストの説明

折り返さない対象

次の内容は折り返したり、再配置したりしないでください。

  • 表：パイプで区切られた行は 1 行のままにします
  • コードブロック：フェンス形式（```）またはインデントされた内容
  • 見出し：# で始まる行
  • フロントマター：--- または +++ の間にある YAML／TOML
  • HTML ブロック：HTML の生要素
  • リンク定義：[id]: url 形式の参照行
  • 画像参照：![alt](url) を 1 行で記述します
  • 1 行のリスト項目：1 行に収まる短い箇条書き

折り返しアルゴリズム（概要）

各文章段落について、次の手順に従います。

  1. 文が 80 文字以内なら、1 行のままにします
  2. 文が 80 文字を超える場合、80 文字以内で最も近い 文の区切り（. ! ? ）で改行します
  3. 文の区切りがない場合、80 文字以内で最も近い 節の区切り（, ; : ）で改行します
  4. 節の区切りもない場合、80 文字以内で最も近い 接続詞（and but or ）の前で改行します
  5. 上記のいずれにも該当しない場合、80 文字以内で最後の 単語の区切りで改行します
  6. バッククォートで囲まれた範囲、リンクテキスト、URL の途中では 絶対に改行しないでください

完全なアルゴリズムと例については、modules/wrapping-rules.md を 参照してください。

構造上の規則

見出しの前後の空行
WRONG:
Some text.
## Heading
More text.

RIGHT:
Some text.

## Heading

More text.

例外：ファイルの最初の行が見出しの場合、その前に空行を入れる必要は ありません。

ATX 形式の見出しのみを使用
WRONG:
Heading
=======

WRONG:
Subheading
----------

RIGHT:
# Heading

RIGHT:
## Subheading
リストの前に空行を入れる
WRONG:
Some introductory text:
- Item one
- Item two

RIGHT:
Some introductory text:

- Item one
- Item two
長い URL には参照形式のリンクを使用

インラインリンクによって行が 80 文字を超える場合は、 参照形式の構文を使用します。

WRONG (line too long):
See the [formatting guide](https://google.github.io/styleguide/docguide/style.html) for details.

RIGHT:
See the [formatting guide][fmt-guide] for details.

[fmt-guide]: https://google.github.io/styleguide/docguide/style.html

リンク定義は、現在のセクションの末尾またはドキュメントの末尾に 配置します。同じ URL が複数回登場する場合は、参照定義を 1 つだけ 共有して使用します。

行が 80 文字未満に収まる短いインラインリンクは使用できます。

OK:
See [the guide](https://example.com) for details.

完了条件

  • 編集したファイルの文章行がすべて 80 文字以内で折り返されていること。 awk 'length>80' <file> を実行して、文章ブロックに該当する行が ないことを確認します（表、コード、見出し、フロントマターは除外）
  • 最初の行を除くすべての見出しの前後に空行があり、setext 形式の 下線による見出しがないこと
  • すべてのリストの前に空行があること
  • 行が 80 文字を超えるインラインリンクを参照形式の構文に変更し、 URL 定義をセクションまたはドキュメントの末尾に配置していること

コメント

Markdown 対応