使用英语阅读

通过


Microsoft Q&Markdown 参考

Microsoft Q&A 支持丰富的 Web 编辑器体验,因此永远不必担心在 Markdown 中编辑内容。 如果担心,请参阅下面关于为 Q&A 编写 Markdown 的参考。

Markdown 是一种轻型标记语言,采用纯文本格式语法。 learn.microsoft.com (Learn) 支持通过 Markdig 分析引擎分析的符合 CommonMark 的 Markdown。 Learn 和 Q&A 还支持在网站上提供更丰富内容的自定义 Markdown 扩展。 Q&A 使用 Learn 文档中支持的扩展子集。 本文提供了按字母顺序排列的参考资料。

可以在 Learn Markdown 参考一文中看到更多信息。

代码片段

块引用

> This example is a blockquote. It's usually rendered indented and with a different background color.

上述示例的呈现如下所示:

这是一个块引用。 它通常以缩进方式呈现,并且使用不同的背景色。

代码块

可以将代码语言添加到代码块,以便进行更丰富的呈现。

```csharp
    public static void Log(string message)
            {
                _logger.LogInformation(message);
            }
    ```

上述示例的呈现如下所示:

    public static void Log(string message)
            {
                _logger.LogInformation(message);
            }

表情符号

Q&A 会将表情符号短代码转换为其各自的 Unicode 字符:

This is a test with a :).

上述示例的呈现如下所示:

这是一个具有 😃 的测试。

格式化

要将文本设置为粗体格式,请用两个星号括住文本

This text is **bold**.

要将文本设置为斜体格式,请用一个星号括住文本

This text is *italic*.

要将文本同时设置为粗体和斜体格式,请用三个星号括住文本

This text is both ***bold and italic***.

若要将文本的格式设置为带删除线,请用两个波浪号将其括起来:

This text is ~~strikeout~~.

标头

Q&A 支持六个级别的 Markdown 标题:

# This is a first level heading (H1)

## This is a second level heading (H2)

...

###### This is a sixth level heading (H6)
  • 最后一个 # 和标题文本之间必须有空格。
  • 每个问题、回答或注释必须有且只有一个 H1 标题。

HTML

如果输入 HTML 内容,则内容不会呈现出现。 而是显示为纯文本。

映像

Learn 自定义 :::image::: 扩展支持标准图像、复杂图像和图标。

:::image source="<folderOrURLPath>" alt-text="<alt text>":::

其中,<alt text> 是图像的简要说明,<folderOrURLPath> 是图像的相对路径或其 URL。 必须为视觉障碍人士的屏幕阅读器使用替代文本。 如果出现图像无法呈现的站点 bug,替换文字也非常有用。 请勿复制文件名以用作可选文字。 例如,不应编写以下内容:

:::image source="./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG" alt-text="ADextension_2FA_Configure_Step4":::

应编写以下内容:

:::image source="./media/bogusfilename/ADextension_2FA_Configure_Step4.PNG" alt-text="Active Directory extension for two-factor authentication, step 4: Configure":::

链接很容易添加到 Q&A 中。 链接将用户指向 Q&A 或其他受信任源中另一页的内容。

[Link text](<FullURL>).
[Microsoft Q&A products page](/answers/products).`

链接文本中包含的字词应友好。 换言之,它们应为一般中文关键字或所链接到的页面的标题。

不要对“链接文本”使用“选择此处”。 这不利于搜索引擎优化,也不能充分地描述目标网页。

重要

只要目标支持(绝大多数都应支持),所有链接均必须是安全的(httpshttp)。

示例:

For more information, see the [Microsoft Q&A products page](/answers/products).

上面的示例呈现为:

有关详细信息,请参阅 Microsoft Q&A 产品页面

链接的格式将自动设置为以以下内容开头的任何字符串:https://https://ftp://mailto:tel:www.(解析为 https://www)。

列表(编号、项目符号)

编号列表

要创建编号列表,可全部使用 1。 发布后,这些编号会按升序顺序呈现为顺序列表。 为了提高源可读性,可以手动增加列表。

请勿在列表中使用字母,也勿使用嵌套列表。 发布时,它们无法正确呈现。 使用编号的嵌套列表在发布时将呈现为小写字母。 例如:

1. This is
1. a parent numbered list
   1. and this is
   1. a nested numbered list
1. (fin)

这将呈现为:

  1. This is
  2. 父编号列表
    1. and this is
    2. a nested numbered list
  3. (fin)

项目符号列表

若要创建项目符号列表,请使用 -*,其后每行开头跟一个空格:

- This is
- a parent bulleted list
  - and this is
  - a nested bulleted list
- All done!

这将呈现为:

  • This is
  • 父项目符号列表
    • and this is
    • a nested bulleted list
  • 全部完成!

无论使用哪种语法(-*),都应在内容中一致地使用它。

使用 Markdown 创建表的最简单方法是借助垂直线和行。 若要创建带标头的标准表格,请在第一行后使用虚线:

|This is   |a simple   |table header|
|----------|-----------|------------|
|table     |data       |here        |
|it doesn't|actually   |have to line up nicely!|

这将呈现为:

This is a simple table header
数据 此处
it doesn't actually have to line up nicely!