如何在 Github 的 README.md 文件中显示表格？答案

【问题标题】：How to display Table in README.md file in Github?如何在 Github 的 README.md 文件中显示表格？
【发布时间】：2017-01-15 14:58:30
【问题描述】：

我想在 readme.md 文件中显示一个表格。我阅读了GitHub Flavored Markdown 并按照它所说的进行操作。这是我的桌子：

| Attempt | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | #9 | #10 | #11 | #12 |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Seconds | 301 | 283 | 290 | 286 | 289 | 285 | 287 | 287 | 272 | 276 | 269 | 254 |

但是，我没有看到任何表格，结果看起来像：

【问题讨论】：

我的经验 (12/2021) 表明文档对于 git 存储库中的 .md 文件不可靠，例如 README.md 文件。我从 Azure DevOps Wiki 迁移了大约 300 个.md 文件，并且大多数表都遇到并呈现得很好。这没有“前面的空白行”和“必需的”3 个连字符（破折号）。少数未正确呈现的表是由于列标题行指定的列多于包含的表。 Azure DevOps Wiki 引擎并不介意。 GitHub 的渲染做到了。寻找问题的根源是痛苦的。修复它很简单。

标签： github markdown readme

【解决方案1】：

您需要再次查看文档。你可以看到这个cheatsheet

在您的情况下，您需要像下面的示例一样制作第二行：

Attempt | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | #9 | #10 | #11
--- | --- | --- | --- |--- |--- |--- |--- |--- |--- |--- |---
Seconds | 301 | 283 | 290 | 286 | 289 | 285 | 287 | 287 | 272 | 276 | 269

此代码与您在 repo 中的代码之间的区别在于，带有分隔符的第二行与标题具有相同的列。之后将显示此表

【讨论】：

是的，谢谢。甚至我的 Android 工作室上的 readme.md 插件仍然没有显示表格，而 Github 显示。感谢您分享您的知识。
@Hesam 我建议你使用一些在线 Markdown 编辑器。我用this

【解决方案2】：

| Attempt | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | #9 | #10 | #11 | #12 |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Seconds | 301 | 283 | 290 | 286 | 289 | 285 | 287 | 287 | 272 | 276 | 269 | 254 |

使您的示例更短，以便于理解。

| Attempt | #1 | #2 |
| :---: | :---: | :---: |
| Seconds | 301 | 283 |

并进行了格式化以使其更易于阅读。

| Attempt | #1  | #2  |
| :---:   | :-: | :-: |
| Seconds | 301 | 283 |

标题必须用竖线| 字符分隔，并用- 短划线字符加下划线。

您可以通过组合单词列表并用连字符-（第一行）分隔它们，然后用竖线| 分隔每一列来创建表格。
First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell
为了美观，您还可以在末端添加额外的管道：
| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |
——GitHub Flavored Markdown

我们的例子变成：

| Attempt | #1  | #2  |
| ------- | --- | --- |
| Seconds | 301 | 283 |

最后，通过在标题行中包含冒号 :，您可以将文本定义为左对齐、右对齐或居中对齐：
| Left-Aligned  | Center Aligned  | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is      | some wordy text | $1600 |
| col 2 is      | centered        |   $12 |
| zebra stripes | are neat        |    $1 |
——GitHub Flavored Markdown

所以为了居中对齐，我们的例子变成了：

| Attempt | #1  | #2  |
| :-----: | :-: | :-: |
| Seconds | 301 | 283 |

【讨论】：

最后一个例子不正确，因为documentation says至少需要3个连字符。

【解决方案3】：

不要忘记在表格前添加一个空行，否则格式将不正确。

【讨论】：

这没有提供有用的答案，如果你想指出一些你可以使用 cmets 的东西
这个！这解决了我的问题。额外的行是格式的一部分，我没有意识到这一点。

【解决方案4】：

我使用 Markdown Table 工具 (https://www.tablesgenerator.com/markdown_tables)，它可以帮助我从 csv 导入数据或将我的 html 表转换为 Markdown，我可以简单地将其复制到我的 README.md 文件中，这对我来说是一个真正的节省时间。

我通常会在我的 README 文件中将要发布的内容写在 excel 文件中，并将其保存为 csv 并导入到此工具中并复制粘贴 Generated Markdown，它会创建一个表格，供其他人阅读您的说明。

希望对您有所帮助。

【讨论】：

【解决方案5】：

将您的自述文件保存为 README.md 而不是 READ.ME

【讨论】：

啊，对不起，这是我的拼写错误（我在我的问题中修正了它）。它实际上是 readme.md。这是我的回购github.com/Hesamedin/DatabaseTester