CodeProject 论坛讨论使用 Markdown 作为格式化文本的一种选择。 “Markdown”并非标准：它是一种松散但普遍认可的理解，即当某些非字母数字字符作为装饰添加到单词和文本块时，ASCII 文本应该如何显示。

CodeProject 使用的 Markdown 与 GitHub、Atlassian 和 StackExchange 中使用的 Markdown 非常相似，但有一些小的变化。

注意： Markdown 接受 HTML 标签。如果你在内容中包含有效的 HTML 标签，它们将被渲染为 HTML。如果你包含无效的 HTML 标签（例如“<tag>”），则它将被自动 HTML 编码，并且不会被处理为 HTML。

语法

标题

使用 #、##、### 等生成 H1、H2、H3 标题

# Heading level 1
## Heading level 2

生成结果如下

一级标题

二级标题

或者，你可以使用 === 或 --- 下划线标题以获得一级和二级标题

Heading 1
=========

Heading 2
---------

段落

段落只需键入文本，并用空行分隔文本即可创建。换行符将被保留。

这是一个段落
这是一个新行

这是一个单独的段落

代码

行内代码使用匹配的 `` 或 ´´ 对围绕代码指定

This is a ``variable`` name.

生成结果如下

这是一个 变量 名称。

代码块使用代码块顶部和底部的匹配 ``` 或 ´´´ 对，分别位于单独的行上指定

```
var int i = 0;
```

生成结果如下

var int i = 0;

可以通过在 ``` 之后直接添加它来指定代码块的语言

```cs
var int i = 0;
```

```javascript
var int i = 0;
```

如果你想在代码块中包含 ```（例如，为了演示 Markdown 示例），则可以使用 \ 转义标记。

```text
    Your codeblocks should be of the form

    \```C#
    // some code
    \```
```

将生成

Your codeblocks should be of the form

    ```C#
    // some code
    ```

如果要在代码跨度中包含文字反引号，可以使用多个反引号作为分隔符。

Just type ``foo `bar` baz`` at the prompt.

将生成

只需在提示符下键入 foo `bar` baz。

行内字符格式化

通过将文本包装在 **、*（或_）和 -- 中，分别支持粗体、斜体和删除线

This is **bold**, *italics* and --strikethrough--

生成结果如下

这是粗体、斜体和~~删除线~~.

列表

使用 * 或 - 创建无序列表

- Apples
- Pears
- Oranges

生成结果如下

苹果
梨
橙子

用数字前缀列表项。

1. First
2. Second
3. Third

生成结果如下

First
第二种
第三部分

嵌套列表可以通过将子项缩进两个或更多空格来生成。

1. First
2. Second
  - Sub-Second

生成结果如下

First
第二种
- 子秒

引用块

用“>”前缀引用中的每一行

> This is a quote
> from someone famous. 
>
> This is a new paragraph inside the quote

生成结果如下

这是来自著名人士的引用。

这是引用中的新段落

超链接

可以通过 http:// 前缀链接来自动链接，或者将链接文本包装在 [] 中，并将链接 URL 包装在 () 中以生成超链接

Visit [CodeProject](www.codeproject.com). Its URL is https://codeproject.org.cn.

生成结果如下

访问 CodeProject。它的 URL 是 https://codeproject.org.cn。

如果你想为你的链接指定标题（工具提示），请在 URL 之后用引号添加标题

Visit [CodeProject](www.codeproject.com "CodeProject"). Its URL is https://codeproject.org.cn.

与传统 Markdown 的差异

保留换行符

Markdown 最初是为允许将博客内容从纯 ASCII 转换为 HTML 的最简单、最无痛的方法而创建的。多行被合并为单个段落，段落换行需要一个空行。这遵循了你在记事本中编写的文本的预期。

在 CodeProject 上，人们期望看到的内容（就换行符而言）就是你所得到的。因此，我们决定保留换行符。

行内格式化需要在格式化标记周围使用单词分隔符

与 GitHub 一样，我们禁止处理单词中的多个下划线。 my_var_name 通常会被渲染为 myvarname，这使得讨论代码非常困难。

自动超链接

这不是标准标记。

删除线

这不是标准标记。同样，BLINK 标签也不标准。这让我们感到难过。

带围栏的代码块和语法高亮

使用 ``` 来分隔代码块是 GitHub 的扩展，我们选择遵循它，以方便已经熟悉 Markdown 的用户。我们添加了“´”作为选项，供使用欧洲键盘的用户使用。

表格

与 GitHub 不同，我们不支持 Markdown 表格。