YamlBox

网络和编码 · 5 分钟阅读

Markdown 表:生成它们而不是计算管道数

Markdown 表格是用管道和破折号编写的单元格网格,它是 Markdown 中手写起来确实不舒服的一部分。计算管道数、保持分隔符行与标题的宽度相同以及转义出现在单元格内的管道都在争夺注意力。生成该表可以立即解决所有三个问题。

已更新

语法,在一个例子中

                | Tool          | Input       | Offline |
| :------------ | :---------: | ------: |
| YAML to JSON  | YAML        | yes     |
| JWT decoder   | JWT         | yes     |
              

第一行是标题,第二行是分隔符行,后面的所有内容都是数据。分隔符行中的冒号设置对齐方式:`:---` 左、`:---:` 居中、`---:` 右。 GitHub 并且大多数渲染器接受前导管道和尾随管道作为可选,但包含它们可以使原始文本在编辑器中可读。

打破桌子的三件事

  • 单元格内的管道 - 将其转义为 `\|`,或者该行被分成过多的一列。
  • 分隔符行的列数错误 - 标题发生变化并且表格呈现未对齐。
  • 表格内的空行 - 渲染器将其视为表格的末尾并将其余部分打印为文本。

对于单元格中的代码和正则表达式来说,转义最为重要:`a|b` 和 `\bfoo\b` 都需要引起注意,然后才能在表中愉快地生活。

从电子表格中获取数据

自然的工作流程是粘贴电子表格或 CSV 导出中的选择,然后让生成器进行引用和对齐。这比键入行更快、更不容易出错,而且它还可以处理无聊的情况——可变的列宽、应该右对齐的数字、包含逗号的单元格。在粘贴之前修剪尾随的空列,以避免表格中出现呈现为间隙的虚拟列。

何时不使用表格

表格用于比较:功能矩阵、标志参考、兼容性列表、环境变量。它们不适合散文,不适合长描述,而且在窄屏幕上也很痛苦,因为 Markdown 没有响应行为——渲染器要么水平滚动,要么将列挤成不可读的碎片。如果单元格需要段落,请使用定义列表、每个条目的标题或项目符号列表。没有人可以在手机上阅读的表格比它所取代的列表更糟糕。

生成,然后粘贴到任何地方

输出是简单的降价,因此它直接放入自述文件、拉取请求描述、wiki 页面、Jira 票证或评论中。 YamlBox Markdown 表生成器在浏览器中运行,为您对齐列,转义管道,并保持离线工作 — 因此您可以粘贴内部数据,而无需将其发布到任何地方。

Markdown 表格生成器 — 常见问题

如何将管道字符放入 Markdown 表格单元格中?

使用反斜杠将其转义 — `\|` — 否则渲染器会将其视为单元格的末尾。生成器会自动处理此问题,这是使用工具而不是手动构建表的主要原因。

如何在 Markdown 中对齐列?

在分隔行中使用冒号:`:---` 为左侧,`:---:` 为中间,`---:` 为右侧。对齐方式适用于整个列,因此将数字列右对齐并将文本左对齐以获得最易读的结果。

为什么我的 Markdown 表格没有呈现?

检查三件事:分隔符行的列数与标题完全相同,表格内没有空行,并且标题行直接位于分隔符行之前。这三个中的任何一个都会破坏 GitHub风格的 Markdown 的渲染。

这篇文章中提到的工具

浏览 19 工具的完整列表

更多文章可供阅读

所有19帖子→