CSV到Markdown转换器

README、拉取请求说明和文档站点都能精美地渲染 Markdown 表格,前提是你愿意费心手写那些竖线和短横线。该转换器读取 CSV,将首行作为标题,并生成带有正确分隔行的 GitHub Flavored Markdown 表格。每个单元格都会被 | 包围,可直接粘贴到 README 或 pull request 描述中。

表格的构建方式

  1. 1

    粘贴 CSV 文件

    默认使用三列样本;可根据自身数据进行替换。

  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 文件会发送到我们的服务器以便转换器生成表格,但不会被存储,也不会被添加到页面链接中。

相关工具