CSVからMarkdownへの変換ツール

README、プルリクエストの説明文、ドキュメントサイトでは、Markdownテーブルがとても美しく表示されます。ただし、パイプやダッシュを手作業で書く手間をいとわなければの話です。このコンバーターはCSVを読み取り、最初の行をヘッダーとして扱い、正しい区切り行を備えたGitHub Flavored Markdownテーブルを出力します。各セルは|で囲まれ、READMEやプルリクエストの説明文にそのまま貼り付けられます。

テーブルの構築方法

  1. 1

    CSVを貼り付ける

    デフォルトでは3列のサンプルが入っています。ご自身のデータに置き換えてください。

  2. 2

    区切り文字を選ぶ

    デフォルトはカンマです。データに合わせて、リストからタブ、セミコロン、パイプを選択してください。

  3. 3

    1行目がヘッダー

    最初の行はMarkdownのヘッダーとして出力され、続いて必須の`| --- | --- |`区切り行が出力されます。

  4. 4

    幅に合わせて行を補完

    データ行のセル数がヘッダーより少ない場合、コンバーターはテーブルを長方形に保つために空文字列で埋めます。

レンダリング、配置、および動作する場所とそうでない場所

GitHub Flavored Markdown(GFM)テーブルは広くサポートされていますが、すべての環境で使えるわけではありません。どこで表示されるかを把握しておくことが、見やすいREADMEとパイプ記号だらけの読みづらい表との分かれ目になります。

表示できる環境

  • GitHub、GitLab、Bitbucketのプルリクエストおよびウィキ
  • ほとんどの静的サイトジェネレーター(Docusaurus、VitePress、MkDocs Material)
  • VS CodeのMarkdownプレビュー
  • Notion(Markdownとして貼り付ける場合)

表示できない環境

  • GFM拡張なしのCommonMark
  • Reddit(独自のサブセットを使用)
  • 一部の旧式ウィキエンジン(DokuWiki、MoinMoin)

列の配置

GFMテーブルは、区切り行にコロンを使うことで左揃え、中央揃え、右揃えに対応しています。このコンバーターは通常の---区切りを出力します。配置が必要な場合は、後処理してください。

構文 効果
:--- 左揃え
:---: 中央揃え
---: 右揃え

揃えたい列に合わせて、区切り行を| :--- | :---: | ---: |に置換してください。

Markdownセル内での文字のエスケープ

  • セル内のパイプ文字(|)は、セルが分割されないように\\|としてエスケープする必要があります。コンバーターは自動ではエスケープしないため、データにパイプが含まれる場合は事前に処理してください。
  • セル内の改行はGFMの表示を崩します。セル内で改行を入れたい場合は、変換前に<br>に置き換えてください。
  • アスタリスク、アンダースコア、バッククォートはそのまま通過し、Markdownの強調やコードとして解釈されます。そのまま文字として表示したい場合は、先頭にバックスラッシュを付けてください。

よくある質問

デフォルトでは対応していません。区切り行は単純な---です。列を左、中央、または右に固定するには、変換後に:---:---:、または---:に置き換えてください。

変換前にバックスラッシュでエスケープし、|\|に変換してください。そうしないと、Markdownレンダラーがそれらを列の区切りとして扱い、テーブルが崩れてしまいます。

GFMテーブルはGitHub、GitLab、ほとんどの静的サイトジェネレーター、およびVS Codeで表示されます。一方、素のCommonMarkやReddit、プラグインのない一部の旧式ウィキでは表示されません。

はい。テーブルを生成するためにCSVはサーバーへ送信されます。保存はされず、ページのリンクにも追加されません。

関連ツール