如何在降價中列出鍵/值對

Question

有一種方法可以編寫鍵/值對列表嗎？

我已經試過這樣：

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

但結果不是很乾淨我..

我也試着表：

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

但表不意思是鍵/值列表（例如，我把標題行留空，這聽起來很醜陋..）

Answer 1

ans這很大程度上取決於您使用的Markdown風味和處理器。定期Markdown doesn't support tables or definition lists，雖然它支持內聯HTML。

Pandoc和PHP Markdown Extra均支持自定義列表：

key1 
: value 1 

key2 
: value 2 

如果沒有一個版本降價的支持自定義列表，你可以添加HTML <dl>，<dt>，並手動<dd>標籤的工作。當然，正在使用的樣式表會影響它們的顯示。堆棧溢出將它們顯示爲基本上沒有子彈的無序列表，這不是非常有用。

或者，您可以使用常規列表並使用四個空格重新縮進您的值，例如，

* key1 
    * value1 
* key2 
    * value2 

您可以使用內聯粗體或斜體在視覺上將鍵與值分開，例如，

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

最後，如您在您的問題中所建議的，如果您的Markdown版本支持它，可以使用表格。

Answer 2

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> 

Answer 3

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 
--- 

呈現爲：