markdown - 如何在 Markdown 中列出键/值对

Question

有办法编写键/值对列表吗？

我已经尝试过这个:

+ key1: value1
+ key2: value2
+ key3: value3

但结果对我来说不是很干净..

我也尝试过表格:

|    |      |
|----|------|
|key1|value1|
|key2|value2|
|key3|value3|

但是表格不适用于键/值列表(例如，我将标题行留空，这对我来说听起来很难看......)

Answer 1

答案在很大程度上取决于您使用的 Markdown 风格和处理器。常规 Markdown doesn't support tables or definition lists ，尽管它确实支持内联 HTML。

Pandoc和 PHP Markdown Extra两者都支持定义列表:

key1
: value 1

key2
: value 2

如果您使用的 Markdown 版本不支持定义列表，您可以添加 HTML <dl> , <dt> ，和<dd>手动标记。当然，所使用的样式表会影响它们的显示。 Stack Overflow 将它们显示为本质上没有项目符号的无序列表，这不是很有用。

或者，您可以使用常规列表并用四个空格重新缩进您的值，例如

* key1
    * value1
* key2
    * value2

您可以使用内联粗体或斜体在视觉上将键与值分开，例如

* **key1**: value1
* **key2**: value2

最后，正如您在问题中所建议的，如果您的 Markdown 版本支持，您可以使用表格。