markdown help

易波涛

2023-12-01

翻译自 https://stackoverflow.com/editing-help

代码和预格式文本

缩进四个空格以创建转义的<pre> <code>块：

printf("%d\n", 42);  /* what was the

question again? */

(pre 元素可定义预格式化的文本。被包围在 pre 元素中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体。<pre> 标签的一个常见应用就是用来表示计算机的源代码。<code> 标签用于表示计算机源代码或者其他机器可以阅读的文本内容。)
还可以选择文本，然后按CTRL + K以代码切换缩进。

文本将被包装在标签中，并以等宽字体显示。前四个空格将被删除，但所有其他空格将被保留。

标记和HTML在代码块中被忽略：

   <blink>
       You would hate this if it weren't

     wrapped in a code block.
   </blink>

代码片

使用反引号创建一个内联代码块
The `$` character is just a shortcut for `window.jQuery`.
（大多数键盘的左上角都是反向键）

像代码块一样，代码片将以等宽字体显示。 Markdown和HTML在其中不起作用。请注意，与代码块不同，代码跨度要求您手动去除里面所有的HTML语句！

如果您的代码本身包含反引号，则可能需要使用多个反引号作为分隔符：
The name ``Tuple`2`` is a valid .NET type name.

表

表仅在文档页面中可用。

用|s分隔列创建表。每列中的第二行必须至少有三个-s。

Header | Header
------ | ------
Cell   | Cell

Header	Header
Cell	Cell

斜体，粗体和链接在表单元格中是合法的。开头和结尾的| 是可选的。

内联版本

内联版本仅在文档页面中可用。

版本在介绍性主题上列出了一个标签，请参阅Dapper.NET入门指南。

将特定版本的内容标记为使用表单的HTML注释 和  围绕它们。

<!-- if version [eq 1.0] -->
Content only relevant to version 1.0.
<!-- end version if -->

可用条件有 gt, gte, lt, lte, eq, neq.
对于具有多组版本的文档（即.NET，具有核心和微框架），必须在组合名称的HTML注释之前添加条件。

<!-- if version <Named Framework> [gte 2.0] -->
Content relevant to Named Framework versions 2.0 and greater.
<!-- end version if -->

如果所有版本都属于同一个组，则可以在单个注释中提供多个条件。

<!-- if version [lt 3.0] [gt 5.0] -->
Content relevant to versions less than 3.0 and greater than 5.0.
<!-- end version if -->

Linebreaks

用两个空格结束一行，相当于<br\>

斜体和粗体

*This is italicized*, and so is _this_.
**This is bold**, and so is __this__.
Use ***italics and bold together*** if you ___have to___.

This is italicized, and so is this.
This is bold, and so is this.
Use italics and bold together if you have to.
您还可以选择文本，然后按CTRL + I或CTRL + B分别切换斜体或粗体。

连接

基础连接

有三种写链接的方式。每个都比上一个更容易阅读：

Here's an inline link to [Google](http://www.google.com/).
Here's a reference-style link to [Google][1].
Here's a very readable link to [Yahoo!][yahoo].

  [1]: http://www.google.com/
  [yahoo]: http://www.yahoo.com/

您还可以选择文本，然后按CTRL + L使其成为链接，或按CTRL + L，而不选择任何文本，以便在当前位置插入链接。

链接定义可以出现在文档的任何位置 - 在使用它们的位置之前或之后。链接定义名称[1]和[yahoo]可以是任何唯一的字符串，不区分大小写; [yahoo]与[YAHOO]相同。

高级连接

链接可以有一个标题属性，它将显示在悬停上。标题属性也可以添加; 如果链接本身不足以告诉用户他们要去哪里，这是很有用的。

Here's a <span class="hi">[poorly-named link](http://www.google.com/ "Google")</span>.
Never write "[click here][^2]".
Visit [us][web].
  [^2]: http://www.w3.org/QA/Tips/noClickHere
        (Advice against the phrase "click here")
  [web]: https://stackoverflow.com/ "Stack Overflow"

您还可以使用标准的HTML超链接语法。

<a href="http://example.com" title="example">example</a>

裸网址

我们修改了我们的Markdown解析器来支持“裸”网址（在大多数但并非所有情况下 - 请注意您网址中的异常字符）; 他们将自动转换为链接：

I often visit http://example.com.

通过将URL包围在尖括号中来强制URL：

I often visit <http://example.com>?

网址可以是相对的或完整的。

标题头

下划线文字，使两个<h1> <h2>顶层标题：

Header 1
========
Header 2
--------

您还可以选择文本，然后按CTRL + H来浏览不同的标题样式。

=或 - 符号的数量无关紧要; 一个会奏效但是使用足够的内容可以使文本更简洁。

使用哈希标记：

# Header 1 #
## Header 2 ##
### Header 3 ###

结尾的#号是可选的

行规则

通过在行上放置三个或多个连字符，星号或下划线，插入一个行<hr/>：

Rule #1
---
Rule #2
*******
Rule #3
___

符号之间有空格也合法

Rule #4   
- - - -

你也可以按 CTRL+R 来插入一行.

简单列表

一个项目符号<ul>列表：

- Use a minus sign for a bullet
+ Or plus sign
* Or an asterisk

一个编号<ol>列表：

1. Numbered lists are easy
2. Markdown keeps track of the numbers for you
7. So this will be item 3.

您还可以选择文本，然后按CTRL + U或CTRL + O分别切换项目符号或编号列表。

双排列表：

- This list gets wrapped in <p> tags

- So there will be extra space between items

高级列表：嵌套

将其他Markdown块放在列表中; 只需为每个嵌套级别缩进四个空格：

1. Lists in a list item:
    - Indented four spaces.
        * indented eight spaces.
    - Four spaces again.
2.  Multiple paragraphs in a list items:
    It's best to indent the paragraphs four spaces
    You can get away with three, but it can get
    confusing when you nest other things.
    Stick to four.

    We indented the first line an extra space to align
    it with these paragraphs. In real use, we might do
    that to the entire list so that all items line up.

    This paragraph is still part of the list item, but it looks messy to humans. So it's a good idea to wrap your nested paragraphs manually, as we did with the first two.

3. Blockquotes in a list item:

    > Skip a line and
    > indent the >'s four spaces.

4. Preformatted text in a list item:

        Skip a line and indent eight spaces.
        That's four spaces for the list
        and four to trigger the code block.

简单引用块

在任何行的开头添加一个>来创建一个引用块。

> The syntax is based on the way email programs
> usually do quotations. You don't need to hard-wrap
> the paragraphs in your blockquotes, but it looks much nicer if you do.  Depends how lazy you feel.

或者按CTRL+Q

高级引用块

要将其他Markdown块放在引用中，只需添加一个>后跟一个空格：

> The > on the blank lines is optional.
> Include it or don't; Markdown doesn't care.
> 
> But your plain text looks better to
> humans if you include the extra `>`
> between paragraphs.

引用里引用

> A standard blockquote is indented
> > A nested blockquote is indented more
> > > > You can nest to any depth.

引用列表

> - A list in a blockquote
> - With a &gt; and space in front of it
>    * A sublist

在引用中预格式化的文本：

>     Indent five spaces total.  The first
>     one is part of the blockquote designator.

图片

和链接很像，但是在他们面前有一个惊叹号：

![Valid XHTML](http://w3.org/Icons/valid-xhtml10).

也可以按CTRL+G

方括号中的单词是替代文本，如果浏览器无法显示图像，则会显示该文本。确保为屏幕阅读软件包含有意义的替代文本。

像链接一样，图像使用参考语法和标题：

This page is ![valid XHTML][checkmark].

[checkmark]: http://w3.org/Icons/valid-xhtml10
             "What are you smiling at?"

注意：Markdown当前不支持图像的最短参考语法：

Here's a broken ![checkmark].

但是您可以使用稍微更详细的隐式参考名称：

This ![checkmark][] works.

引用名称也用作替代文本。

您还可以使用标准的HTML图像语法，这允许您缩放图像的宽度和高度。

<img src="http://example.com/sample.png" width="100" height="100">

地址可以是相对的或完整的。

内联HTML

不常用就不写了
HTML

Need More Detail?

查看official Markdown syntax reference page.