降价格式:如何在项目符号列表后添加字符串?

时间:2018-02-22 16:04:03

标签: github markdown newline

我正在使用Markdown编辑模式编辑GitHub维基页面。

来源如下:

Parameters:
* ```param1```: string, contains a parameter 
* ```param2```: string, contains a parameter
* ```param3```: string, contains a parameter, could be:
   - `ONE`: one element.
   - `TWO`: two elements.

结果如下:

  • param1:string,包含参数
  • param2:string,包含参数
  • param3:string,包含一个参数,可以是:
    • ONE:一个元素。
    • TWO:两个元素。

现在我想添加以下句子,作为param3的附加说明:" param3可以是一个空字符串",以便句子与第三个点(param3之前)。

我发现的最佳解决方案如下:

  • param1:string,包含参数
  • param2:string,包含参数
  • param3:string,包含一个参数,可以是:

    • ONE:一个元素。
    • TWO:两个元素。

    param3可能是一个空字符串

但是,出于某种原因,它会在" - ONE之上增加一个额外的空间:一个元素。"。

我无法在GitHub上找到正确的语法,也无法在Stack Overflow上找到正确的语法。

2 个答案:

答案 0 :(得分:0)

您应该使用不间断的空格将段落向右移动,以使其与顶级列表项对齐。

 - `param1`: string, contains a parameter 
 - `param2`: string, contains a parameter 
 - `param3`: string, contains a parameter, could be:
    - `ONE`: one element.
    - `TWO`: two elements.

       `param3` could be an empty string

<强>结果:

  • param1:string,包含参数
  • param2:string,包含参数
  • param3:string,包含一个参数,可以是:
    • ONE:一个元素。
    • TWO:两个元素。

param3可能是一个空字符串

答案 1 :(得分:0)

问题是你正在混合&#34;松散&#34;和&#34;紧#34;列出项目......和Stackoverflow有一些奇怪的CSS规则。

紧密列表

A&#34;紧密列表项&#34;是一个列表项,它不包含在HTML输出中的段落(<p>)中。通过不在项目之间包括空行来创建紧密列表。

例如此列表:

* item one
* item two

...呈现为此HTML:

<ul>
  <li>item one</li>
  <li>item two</li>
</ul>

请注意,该列表中不会显示<p>个标记。

松散列表

A&#34;松散的清单项&#34;是一个列表,其中每个项目都包含在HTML输出中的段落(<p>)中。通过在每个列表项之间包含空行来创建松散列表。

例如此列表:

* item one

* item two

...呈现为此HTML:

<ul>
  <li><p>item one<p></li>
  <li><p>item two<p></li>
</ul>

请注意,每个列表项<li>的内容都包含在

标记中。这通常会导致在浏览器中显示额外的空格。例如,在Stackoverflow上,定义了以下CSS规则:

p {margin-bottom: 1em;}

该规则会产生较宽的底部边距,将段落与其后的内容分开。但是,该规则不适用于紧密列表项(因为没有<p>标记)并且它们距离更近。

你有一个&#34;混合&#34;列表

A&#34;混合列表&#34;是包含两种类型的项目的列表。有些项目包含在<p>标记中,有些则不包含在内。重要的是要注意,任何包含嵌套项的列表项都是&#34;松散列表项&#34;。但是,您的其他项目是&#34;紧密列表项目&#34;因此,您有一个看似不一致的混合列表。你需要制作所有项目&#34;紧密&#34;或&#34;松散&#34;。当然,因为你别无选择,只能制作第三项&#34;松散&#34; (因为它有嵌套的项目),你必须使所有项目&#34;松散&#34;。甚至有助于使嵌套的子列表松散。

像这样:

Parameters:

* `param1`: string, contains a parameter 

* `param2`: string, contains a parameter

* `param3`: string, contains a parameter, could be:

    - `ONE`: one element.

    - `TWO`: two elements.

    `param3` could be an empty string

但这似乎不适用于Stackoverflow ......

Stackoverflow有这个(奇怪的,IMO)CSS规则:

ul p.last-of-type {margin-bottom: 0;}

这会导致列表的最后一段无法获得宽边距。当然,嵌套列表后面的段落非常接近上面的嵌套列表,而不是保持与列表中所有其他项目相同的间距。由于这个规则,你无法做任何事情来修复&#34;问题除了请求stackoverflow开发人员更改CSS(至少,规则应该只适用于问题/答案的根级别的列表,但不适用于嵌套列表)。

幸运的是,并非所有网站都使用这种不寻常的规则,并且在其他网站上使用松散列表应该更加一致。