如何在降价中列出键/值对

Question

有一种方法可以写一个键/值对列表吗？

我试过这个：

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

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

我也试过表：

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

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

Answer 1

答案很大程度上取决于您正在使用的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版本支持，您可以使用表格。

Answer 2

如果用三个破折号---

围栅，Github会将一个键值对的块呈现为带有标题行的表格

For example：

---
layout: classic-docs
title: "Caching in CircleCI"
short-title: "Caching"
description: "Caching strategies to increase build speeds"
categories: [configuring-jobs]
order: 20
---

呈现为：

Answer 3

GitHub Flavored Markdown does not apparently provide for definition lists。它表示在原始HTML中执行此操作：

<dl>
    <dt>Definition list</dt>
    <dd>Is something people use sometimes.</dd>

    <dt>Markdown in HTML</dt>
    <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>