MDXフォーマッター
このMDX FormatterでMDXドキュメントを整えましょう。インポート、エクスポート、JSXコンポーネント、Markdownを含むMDXを貼り付けると、ドキュメントの先頭と末尾にある空行を削除し、すべてのパイプテーブルを整列させます。セルを列幅に合わせて調整し、配置を示すコロンを含めて区切り行を作り直します。インポート、コンポーネント、式は元のまま保持されるため、ドキュメント作成者はビルドを壊さずにテーブルを整えられます。
よくある質問
MDX Formatterでは何が変更されますか?
パイプテーブルを整列し、ドキュメントの先頭と末尾にある空行やスペースを削除します。Markdownのテキスト、インポート、エクスポート、JSXを含め、それ以外はすべて書いたとおりに保持されます。
インポート、エクスポート、JSXコンポーネントは変更されますか?
いいえ。インポートとエクスポートの文、<Callout type="info">のようなコンポーネントタグ、波括弧内の式は変更せずにコピーされます。フォーマッターはコードの改行位置を変えないため、MDXビルドが壊れることはありません。
テーブルはどのようにフォーマットされますか?
各行の先頭と末尾にパイプを付け、各セルには同じ列の最も幅の広いセルに合わせて、最低3文字分のスペースを入れます。区切り行は同じ幅のダッシュで作り直されます。
テーブルの配置は保持されますか?
はい。区切り行の配置用コロン(:---、:---:、---:など)は保持されます。フォーマット後も、左揃え、中央揃え、右揃えの列は同じように表示されます。
コードブロックは変更されますか?
いいえ。3つのバッククォートまたは3つのチルダで囲まれた内容はそのまま保持されます。コードブロック内のパイプを含む行がテーブルとして扱われることはありません。
テーブルの列幅が予想より広いのはなぜですか?
幅はUTF-8のバイト数で数えるため、アクセント付き文字や絵文字は1文字より多くカウントされます。余分なパディングはソースにのみ表示され、レンダリング後のテーブルは同じ見た目です。
MDX内のJavaScriptもフォーマットされますか?
いいえ。インポート、エクスポート、式の中のコードは再フォーマットされません。大きなコードブロックは、JavaScriptまたはJSXフォーマッターで個別にフォーマットしてください。
Markdownフォーマッターとの違いは何ですか?
どちらも同じルールを適用します。このツールは結果にmdxとして印を付けます。Docusaurus、Next.js、Astroなどのドキュメント環境で、.mdxファイルに使用してください。
結果がmdxのコードフェンスで囲まれるのはなぜですか?
出力はmdxとマークされたコードブロック内に返されるため、Markdownに貼り付けるとソースとして表示されます。外側のフェンスの間にある行をコピーして、.mdxファイルに貼り付けてください。
ドキュメントのサイズ上限はどれくらいですか?
1回あたり最大5 MBです。それを超える入力はメッセージとともに拒否されます。出力はコードフォーマッターのMDXオプションと同じです。