2. Markdown示例¶
本文件的源码是一个markdown文件,也就是说在本工程中直接添加markdown即可嵌入到sphinx文档中。
关于使sphinx支持markdown的详细配置说明，请参考文档markdown-sphinx。
markdown的公式语法在sphinx可能不支持。
2.1. 以下是markdown的语法使用示例¶
文档来源：https://www.mdeditor.com/
2.2. 欢迎使用 Markdown在线编辑器 MdEditor¶
Markdown是一种轻量级的「标记语言」
markdown
Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的HTML页面，Markdown文件的后缀名便是“.md”
2.3. MdEditor是一个在线编辑Markdown文档的编辑器¶
MdEditor扩展了Markdown的功能（如表格、脚注、内嵌HTML等等），以使让Markdown转换成更多的格式，和更丰富的展示效果，这些功能原初的Markdown尚不具备。
Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具，如~~Pandoc~~，Pandao；要么基于网站，如GitHub和Wikipedia，在语法上基本兼容，但在一些语法和渲染效果上有改动。
MdEditor源于Pandao的JavaScript开源项目，开源地址Editor.md，并在MIT开源协议的许可范围内进行了优化，以适应广大用户群体的需求。向优秀的markdown开源编辑器原作者Pandao致敬。
Pandao editor.md
2.4. MdEditor的功能列表演示¶
2.5. 标题H2¶
2.5.2. 字符效果和横线等¶
~~删除线~~ 删除线（开启识别HTML标签时）
斜体字 斜体字
粗体 粗体
粗斜体 粗斜体
上标：X2，下标：O2
缩写(同HTML的abbr标签)
即更长的单词或短语的缩写形式，前提是开启识别HTML标签时，已默认开启
The HTML specification is maintained by the W3C.
2.5.3. 引用 Blockquotes¶
引用文本 Blockquotes
引用的行内混合 Blockquotes
引用：如果想要插入空白换行
即<br />标签，在插入处先键入两个以上的空格然后回车即可，普通链接。
2.5.4. 锚点与链接 Links¶
普通链接 普通链接带标题 直接链接：https://www.mdeditor.com [锚点链接][anchor-id] [anchor-id]: https://www.mdeditor.com/ mailto:test.test@gmail.com GFM a-tail link @pandao 邮箱地址自动链接 test.test@gmail.com www@vip.qq.com
@pandao
2.5.5. 多语言代码高亮 Codes¶
2.5.5.1. 行内代码 Inline code¶
执行命令：npm install marked
2.5.5.2. 缩进风格¶
即缩进四个空格，也做为实现类似 <pre> 预格式化文本 ( Preformatted Text ) 的功能。
<?php
echo "Hello world!";
?>
预格式化文本：
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
2.5.5.3. JS代码¶
function test() {
console.log("Hello world!");
}
2.5.5.4. HTML 代码 HTML codes¶
<!DOCTYPE html>
<html>
<head>
<mate charest="utf-8" />
<meta name="keywords" content="Editor.md, Markdown, Editor" />
<title>Hello world!</title>
<style type="text/css">
body{font-size:14px;color:#444;font-family: "Microsoft Yahei", Tahoma, "Hiragino Sans GB", Arial;background:#fff;}
ul{list-style: none;}
img{border:none;vertical-align: middle;}
</style>
</head>
<body>
<h1 class="text-xxl">Hello world!</h1>
<p class="text-green">Plain text</p>
</body>
</html>
2.5.7. 列表 Lists¶
2.5.7.1. 无序列表（减号）Unordered Lists (-)¶
列表一
列表二
列表三
2.5.7.2. 无序列表（星号）Unordered Lists (*)¶
列表一
列表二
列表三
2.5.7.3. 无序列表（加号和嵌套）Unordered Lists (+)¶
列表一
列表二
列表二-1
列表二-2
列表二-3
列表三
列表一
列表二
列表三
2.5.7.4. 有序列表 Ordered Lists (-)¶
第一行
第二行
第三行
2.5.7.5. GFM task list¶
[x] GFM task list 1
[x] GFM task list 2
[ ] GFM task list 3
[ ] GFM task list 3-1
[ ] GFM task list 3-2
[ ] GFM task list 3-3
[ ] GFM task list 4
[ ] GFM task list 4-1
[ ] GFM task list 4-2
2.5.8. 绘制表格 Tables¶
| 项目 | 价格 | 数量 | | ——– | —–: | :—-: | | 计算机 | $1600 | 5 | | 手机 | $12 | 12 | | 管线 | $1 | 234 |
First Header | Second Header ————- | ————- Content Cell | Content Cell Content Cell | Content Cell
| First Header | Second Header | | ————- | ————- | | Content Cell | Content Cell | | Content Cell | Content Cell |
| Function name | Description |
| ————- | —————————— |
| help() | Display the help window. |
| destroy() | Destroy your computer! |
| Left-Aligned | Center Aligned | Right Aligned | | :———— |:—————:| —–:| | col 3 is | some wordy text | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 |
| Item | Value | | ——— | —–:| | Computer | $1600 | | Phone | $12 | | Pipe | $1 |
2.5.8.1. 特殊符号 HTML Entities Codes¶
© & ¨ ™ ¡ £ & < > ¥ € ® ± ¶ § ¦ ¯ « ·
X² Y³ ¾ ¼ × ÷ »
18ºC “ ‘
[========]
2.5.9. Emoji表情 :smiley:¶
Blockquotes :star:
2.5.9.1. GFM task lists & Emoji & fontAwesome icon emoji & editormd logo emoji :editormd-logo-5x:¶
[x] :smiley: @mentions, :smiley: #refs, links, formatting, and
tagssupported :editormd-logo:;[x] list syntax required (any unordered or ordered list supported) :editormd-logo-3x:;
[x] [ ] :smiley: this is a complete item :smiley:;
[ ] []this is an incomplete item test link :fa-star: @pandao;
[ ] [ ]this is an incomplete item :fa-star: :fa-gear:;
2.5.10. 科学公式 TeX(KaTeX)¶
$$E=mc^2$$
行内的公式$$E=mc^2$$行内的公式，行内的$$E=mc^2$$公式。
$$x > y$$
$$(\sqrt{3x-1}+(1+x)^2)$$
$$\sin(\alpha)^{\theta}=\sum_{i=0}^{n}(x^i + \cos(f))$$
多行公式：
\displaystyle
\left( \sum\_{k=1}^n a\_k b\_k \right)^2
\leq
\left( \sum\_{k=1}^n a\_k^2 \right)
\left( \sum\_{k=1}^n b\_k^2 \right)
\displaystyle
\frac{1}{
\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{
\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {
1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}}
{1+\cdots} }
}
}
f(x) = \int_{-\infty}^\infty
\hat f(\xi)\,e^{2 \pi i \xi x}
\,d\xi
2.5.12. 绘制流程图 Flowchart¶
st=>start: 用户登陆
op=>operation: 登陆操作
cond=>condition: 登陆成功 Yes or No?
e=>end: 进入后台
st->op->cond
cond(yes)->e
cond(no)->op
[========]
2.5.13. 绘制序列图 Sequence Diagram¶
Andrew->China: Says Hello
Note right of China: China thinks\nabout it
China-->Andrew: How are you?
Andrew->>China: I am good thanks!