Markdownフォーマッター
このMarkdown FormatterでMarkdownを整えましょう。README、ドキュメントページ、メモを貼り付けると、先頭と末尾の空行を削除し、すべてのパイプテーブルを整列させます。各列の最も幅の広いセルに合わせてセルに余白を入れ、区切り行のダッシュを同じ幅で作り直します。配置を示すコロンも保持されます。それ以外はすべて元のままなので、ライターや開発者は予期しない変更を心配せずにテーブルを整えられます。
よくある質問
Markdown Formatterでは何が変更されますか?
パイプテーブルを整列し、ドキュメントの先頭と末尾にある空行やスペースを削除します。見出し、段落、リスト、リンク、強調は、書いたとおりに保持されます。
テーブルはどのようにフォーマットされますか?
各行の先頭と末尾にパイプを付け、各セルにはその列で最も幅の広いセルに合わせてスペースを入れます。列幅は最低3文字です。区切り行は同じ幅のダッシュで作り直されます。
列の配置は保持されますか?
はい。区切り行のコロンは保持されます。:---、:---:、---:で指定した左揃え、中央揃え、右揃えは、再フォーマット後も維持されます。
コードブロック内のテーブルも変更されますか?
いいえ。3つのバッククォートまたは3つのチルダで囲まれた内容は変更されません。テーブルのように見えるコードブロック内のテキストも対象外です。
アクセント付き文字や絵文字がある列の配置がずれて見えるのはなぜですか?
セル幅はUTF-8のバイト数で測定されるため、ASCII以外の文字は2~4バイトとして数えられます。そのような文字を含む列は、プレーンテキストエディターで余分なスペースが入って見えることがありますが、レンダリング後のテーブルには影響しません。
リスト記号や見出しのスタイルは変更されますか?
いいえ。リスト記号、番号、見出し記号、段落内のスペースは、書いたとおりに保持されます。ドキュメントの表示方法を変えないよう、フォーマッターは意図的に変更を最小限にしています。
フォーマット後にドキュメントの表示は変わりますか?
いいえ。テーブルのセルに余白を入れたり、ドキュメントの先頭と末尾の空行を削除したりしても、表示結果は変わりません。GitHub、GitLabなどのレンダラーでは、フォーマット前後で同じテーブルが表示されます。
MDXファイルにも使えますか?
はい。ただし、MDX Formatterのほうが適しています。結果にmdxの指定が付くためです。どちらも同じルールを適用し、インポートとJSXは変更しません。
結果がmarkdownのコードフェンスで囲まれているのはなぜですか?
出力はmarkdownと指定されたコードブロック内に返されるため、Markdownビューアーに貼り付けるとソースとして表示されます。.mdファイルには、外側のフェンスの間にある行をコピーしてください。
ドキュメントのサイズ上限はどれくらいですか?
1回につき最大5 MBです。それより大きい入力はメッセージとともに拒否されます。出力はCode FormatterのMarkdownオプションと同じです。