在 GitHub Markdown 中使用表格
介绍
Markdown 是 Github 上编写文档的绝佳工具,因为文档的实用性取决于其可读性。除此之外,Github 的 Markdown 版本还允许创建表格以行和列的形式显示数据。
基础知识
- Markdown 中的表格由两部分组成。
- 标题
- 表中的数据行
- 表中的各个列由管道字符分隔:|。
- 表中的行由换行符分隔。
- HTML 标签可用于对单个单元格进行额外的格式化。
标题
Markdown 表格的标题由两行组成。第一行是表格的列标题。要指定标题,只需用空格和竖线分隔每个标题即可。确保在行首和行末也包含竖线。
| Header Column One | Header Column Two | Header Column Three | Header Column Four |
第二行只是表格的元数据,用于确定文本的垂直对齐方式。每列可以左对齐、右对齐或居中对齐。对齐方式是使用由空格和管道分隔的破折号和冒号模式来设置的。
- 要使列左对齐,请在两个破折号的左边放置一个冒号:--。
- 也可以使用三个破折号--- 。
- 要右对齐,请在两个破折号的右侧放置一个冒号--:。
- 要居中对齐,请用两个冒号:-:括住破折号。
用管道围绕上述任意一项来创建标题的第二行。
| Default Header | Left Align | Right Align | Center Align |
| --- | :-- | --: | :-: |
为了使原始标记更易于阅读,可以增加破折号的数量。
| Default Header | Left Align | Right Align | Center Align |
| -------------- | :--------- | ----------: | :----------: |
也可以使用空格。
| Default Header | Left Align | Right Align | Center Align |
| --- | :-- | --: | :-: |
空格或破折号的数量并不重要,只要至少有三个破折号或冒号即可。
身体
表格主体由任意数量的行组成,行与行之间用换行符分隔。与标题一样,每个单元格都由竖线字符|分隔。将其与标题放在一起可创建一个完整的表格:
| Column 1 Header | Column 2 Header | Column 3 Header |
| --------------- | --------------- | --------------- |
| Row 1 Column 1 | Row 1 Column 2 | Row 1 Column 3 |
| Row 2 Column 1 | Row 2 Column 2 | Row 2 Column 3 |
| Row 3 Column 1 | Row 3 Column 2 | Row 3 Column 3 |
渲染后它将看起来像这样:
第 1 列标题 | 第 2 列标题 | 第 3 列标题 |
---|---|---|
第 1 行 第 1 列 | 第 1 行 第 2 列 | 第 1 行 第 3 列 |
第 2 行 第 1 列 | 第 2 行 第 2 列 | 第 2 行 第 3 列 |
第 3 行 第 1 列 | 第 3 行 第 2 列 | 第 3 行 第 3 列 |
空格
单元格中文本前后的空格无关紧要。它将被自动添加或截断以创建列。
以下表格的渲染效果完全相同。这里唯一需要考虑的是原始 markdown 文件的可读性。
| Header 1 | Another header here | This is a long header |
| -------- | ------------------- | --------------------- |
| Some data | Some more data | data |
| data | Some long data here | more data |
| Header 1 | Another header here | This is a long header |
| --- | --- | --- |
| Some data | Some more data | data |
| data | Some long data here | more data |
空单元格
标题是表格中列数的真实来源。如果正文中的某一行包含的单元格少于标题,则将在末尾呈现空单元格。
这里主体的第一行末尾将填充 2 个空单元格。
| Header 1 | Header 2 | Header 3 |
| --- | --- | --- |
| Some data |
| data | Some long data here | more data |
如果正文行包含的单元格多于标题行,则多余的单元格将被忽略
这里主体的第一行将从末端修剪 2 个单元格。
| Header 1 | Header 2 | Header 3 |
| --------- | ------------------- | --------- |
| Some data | Cell 2 | Cell 3 | Ignored | Ignored |
| data | Some long data here | more data |
要在行中间添加一个空单元格,只需将其留空即可。
这里第一行的第二个单元格将为空。
| Header 1 | Header 2 | Header 3 |
| --------- | ------------------- | --------- |
| Some data | | Cell 3 |
| data | Some long data here | more data |
可以使用空格来实现这一点(如上所示),也可以不使用空格(如下所示)。它们的渲染效果相同。
| Header 1 | Header 2 | Header 3 |
| --- | --- | --------- |
| Some data | | Cell 3 |
| data | Some long data here | more data |
特殊字符和格式
在表格单元格中,大多数 Markdown 格式语法(斜体、粗体、URL、内联代码块)仍可使用。可以使用文字管道字符,方法是使用斜线转义管道,如下所示:
| This is a single cell containing a \| character |
可以使用 HTML 标签进行更高级的格式化。支持哪些标签超出了本指南的范围,但我要说的是,我最常用的是<br />,用于强制单元格跨越多行。
| Header 1 | Header 2 |
| -------- | -------- |
| data | Some long data that <br /> spans multiple lines |
注意:Markdown 表格将自动为包含大量文本的单元格换行。仅当您需要在特定位置强制换行时才需要<br /> 。
结论
Github 的 Markdown 风格允许您创建一些复杂的表格,但在很多情况下,最好保持简单易读。Markdown 原生语法(例如粗体或内联代码块)很容易添加到表格中,也可以使用 HTML 标签。有关 Github 如何生成表格的更多信息,请参阅Github 的 Markdown 文档。您现在应该可以开始创建表格来改进 Github 中的文档了!
了解更多
探索 Pluralsight 的这些 Github 和 Markdown 课程以继续学习:
免责声明:本内容来源于第三方作者授权、网友推荐或互联网整理,旨在为广大用户提供学习与参考之用。所有文本和图片版权归原创网站或作者本人所有,其观点并不代表本站立场。如有任何版权侵犯或转载不当之情况,请与我们取得联系,我们将尽快进行相关处理与修改。感谢您的理解与支持!
请先 登录后发表评论 ~