Markdown フォーマッター
書き方がばらばらな Markdown を貼り付けると、多くのエディタで使われている Prettier で一貫した形に整えます。内容はアップロードされません。
Markdown
186 文字21 行
整形結果
整形しています…0 行
対応している内容
- Prettier のルール
- 結果は Prettier の出力と同じなので、エディタで整形し直しても変わりません。
- 書き方を統一
- 下線式の見出しは
#の見出しに、箇条書きの記号は-に、斜体は_文字_、太字は**文字**にそろえ、番号付きリストは振り直します。 - 表をそろえる
- 表の列の幅をそろえて縦線を並べます。日本語や中国語も含みます。
- 空行を整理
- 余分な空行を取り除き、見出し、リスト、コードブロックの前後は空行 1 つにします。
- 折り返し
- そのまま残す、80 や 100 文字で折り返す、段落ごとに 1 行にする、から選べます。
- コードはそのまま
- コードブロックとインラインコードの中身は一切変えません。
プロジェクトで Markdown を整形する
フォルダー内のすべての Markdown ファイルを Prettier で整形します。
npx prettier --write "**/*.md"
.prettierrc ファイルで、このページと同じオプション（80 文字での折り返しなど）を設定できます。
{
"proseWrap": "always",
"printWidth": 80
}
VS Code では Prettier 拡張機能を入れて「保存時にフォーマット」をオンにすると、保存のたびに整形されます。
よくある質問
Markdown ファイルを整形するには？
上に Markdown を貼り付けるかファイルを開き、整形した結果をコピーまたはダウンロードします。プロジェクトで自動的に整形するには、上のように Prettier を実行します。
整形すると表示が変わりますか？
変わりません。
* の箇条書きが - になるなど、ソースの書き方だけが変わり、表示されるページは同じです。「書き方を統一」は何をしますか？
Prettier の前に、下線式の見出しや
~~~ のコードフェンスなど、書き方が何通りもある要素を 1 つの書き方にそろえます。オフにすると、Prettier は下線式の見出しをそのまま残します。長い行は折り返すべきですか？
80 文字で折り返すと Git の差分が読みやすくなります。改行をそのまま表示するエディタや一部の Wiki に入れる場合は、そのまま残してください。
テキストはアップロードされますか？
されません。Prettier はブラウザ内で動くので、Markdown が端末の外に出ることはありません。