为适应本站Markdown渲染引擎,特整理此使用文档,以便日后查阅。
全引擎通用语法
所有行头标识符都须要空格后接文本!
标题
要创建标题的话只需使用井号#开头,井号的数量对应标题的级别。使用井号的标题语法在CommonMark规范中称之为“ATX 标题”。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题一级标题
======
二级标题
------段落
使用空行分隔文本即可。
段落开头不要使用空格或者制表符(\t 即 Tab 键)来缩进,否则可能会被当做代码块渲染。
中文传统排版上段落开头有着“空两格”的习惯,可以使用全角空格 或者 HTML 实体 。科技领域的文章排版建议不要空两格,段落居左对齐较好。
折行
如果需要文本折行<br>,可在文本结尾加上两个或更多的空格然后回车。
加粗和强调
要加粗文本,可以使用两个星号**或者两个下划线__包裹待加粗的文本。
把文本**加粗**一下
把文本 __加粗__ 一下要强调文本,可以使用一个星号*或者一个下划线_包裹待强调的文本。
把文本*强调*一下
把文本 _强调_ 一下要加粗并强调文本,可以使用三个星号***或者三个下划线___包裹待强调的文本。
同时 ***加粗并强调*** 的示例
同时 ___加粗并强调___ 的示例
同时 __*加粗并强调*__ 的示例
同时 **_加粗并强调_** 的示例
星号***可以不用***加空格包含下划线 加粗或强调 的文本必须在前后添加空格
块引用
要创建块引用<blockquote>的话仅需在段落前加上大于号>。
> 1
> 2
> 3块引用内分段
如果需要分段的话需要可以在分段空行前加上一个>。
> 1
> 2
>
> 3
> 4嵌套块引用
块引用可以嵌套使用,在段落前添加两个大于号>>表示两层嵌套。
> 块引用段落
>
>> 嵌套的块引用段落包含其他元素的块引用
块引用能够包含其他大部分语法元素。CommonMark规范将块引用定义为容器块,容器块可以包含任意块级元素和行级元素,也就是说块引用可以包含其他任意元素。
> ## 标题是叶子块元素
>
> * 列表项一是容器块元素
> * 列表项二也是容器块元素
>
> **加粗**和*强调*是行级元素。有序列表
有序列表可以通过阿拉伯数字后跟.或者)来创建,数字不必递增连续。
1. 有序列表1
2. 有序列表1
4. 有序列表2
4. 有序列表2
3. 有序列表3无序列表
无序列表可以通过短横线-、星号*或者加号+来创建。
- 无序列表1
- 二级无序列表1
* 无序列表2
* 二级无序列表2
+ 无序列表3
+ 二级无序列表3包含其他元素的列表
列表项可以包含其他任意元素,比如段落、块引用、代码块、图片等。使用要点是待包含元素的起始字符要和列表项起始内容“对齐”。
* 列表项一
* 列表项二第一段
这是第二段
* 列表项三第一段
> 第二段是块引用
* 列表项四第一段
\```php
echo 你好,世界!
\```
* 列表项五第一段
代码
代码可以通过反引号`包裹。
如果需要显示反引号,可以用转义符 \ 来对反引号进行转义。
代码块
代码块可以使用四个空格缩进或者制表符\t缩进。
推荐使用围栏代码块语法来排版代码块,即使用`来包裹代码块,并且指定语法高亮语言。
支持语言:css、clike、javascript、basic、c、csharp、cpp、docker、git、go、java、json、markdown、nginx、php、powershell、python、sql、visual-basic等。
分隔线
通过大于等于三个星号***、短横线---或者下划线___来创建分隔线。
***
---
___URL和邮件地址
如果要直接显示URL或者邮件地址,可以通过<和>来包裹URL或者邮件地址。
<http://www.itsnotch404.top>
<404@itsnotch404.top>超链接
通过[链接文本](URL)来创建超链接。
[404](http://www.itsnotch404.top)链接标题是可选的,在圆括号中的 URL 后用双引号包裹。鼠标移到超链接上会浮出显示标题内容。
点此访问网站 [404](http://www.itsnotch404.top "404的网站鸭")。超链接可以和加粗强调、代码等元素结构一同使用。
点此访问网站 **[404](http://www.itsnotch404.top)**。
点此访问网站 [`404`](http://www.itsnotch404.top)。链接引用用于在需要插入超链接的地方,它由两组方括号构成,第一组方括号用于指定链接文本,第二组方括号用于指定链接标识,链接标识指向链接定义;也可以只由一组方括号构成,这种情况下链接标识将用于链接文本。
[链接文本][链接标识]
[链接标识]: http://www.itsnotch404.top
[链接标识]
[链接标识]: http://www.itsnotch404.top链接定义由三部分构成:
- 方括号
[]包裹定义链接标识,后跟冒号: - URL,可以直接写也可以用尖括号
<>包裹 - 链接标题,这部分是可选的,可以用双引号
""、单引号''或者圆括号()包裹
[链接标识]: http://www.itsnotch404.top
[链接标识]: <http://www.itsnotch404.top>
[链接标识]: http://www.itsnotch404.top "404的网站鸭"
[链接标识]: http://www.itsnotch404.top '404的网站鸭'
[链接标识]: http://www.itsnotch404.top (404的网站鸭)图片
使用感叹号!后跟超链接就可以渲染图片。
嵌入HTML
Markdown天然支持嵌入HTML代码。但HTML中嵌入Markdown将不起作用。
**Markdown** 和 <em>HTML</em> 混合排版。
本站部署引擎扩展语法
表格
使用短横线---来分隔表头和表身,使用竖线|来分隔列,每行开头和结尾的竖线是可选的,且列表不一定要对齐。
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |如果需要左对齐、居中对齐或者右对齐表格内容,可以通过在---中添加冒号:实现。冒号仅出现在左边表示左对齐,出现在两边表示居中对齐,仅出现在右边表示右对齐。
| Syntax | Description | Test Text |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |脚注
脚注用于在文末添加细节说明或者参考,这样文章的正文部分看上去会更加简洁清晰。创建脚注后,正文中引用脚注的地方会出现一个上标数字链接,读者点击后跳转到文末脚注定义的对应位置。
脚注引用通过[^标识符]创建,标识符部分可以是数字或者文本,但不能包含空格或者制表符。标识符仅用于关联引用和定义,在渲染时会自动根据脚注定义顺序进行数字递增渲染。不过这也不是绝对的,某些 Markdown 引擎也会将标识符部分用于渲染。
脚注定义使用[^标识符]:来创建,冒号后面就是需要添加的细节说明或者参考。脚注定义不一定非要放在整个Markdown文本的末尾,夹在段落、列表或者块引用之间也是可以工作的。
这里是一个脚注引用[^1],这里是另一个脚注引用[^bignote]。
[^1]: 第一个脚注定义。
[^bignote]: 脚注定义可使用多段内容。
缩进对齐的段落包含在这个脚注定义内。
\```
可以使用代码块。
\```
还有其他行级排版语法,比如**加粗**和[链接](http://www.itsnotch404.top)。删除线
创建删除线可以通过两个波浪线~~包裹待删除的文本。
~~地球是平的。~~ 现在我们知道地球是圆的了。公式渲染
已部署插件,可以渲染MathJax和KaTeX代码格式的公式,首选代码公式为:KaTeX。
KaTeX可视化编辑器可访问:
代码实时渲染:LaTeX公式编辑器
公式生成代码(demo):Wiris-MathType demo
附:部分HTML实体代码
参考:Unicode字符百科
| 字符 | 名称 | 实体代码 |
|---|---|---|
| 全角空格 | \  | |
| 空格 | \ | |
| ` | 反引号 | \` |
| ∖ | 反斜杠 | \∖ |
| | | 竖线 | \| |
| < | 小于号 | \< |
| > | 大于号 | \> |
| & | 和号 | \& |
| " | 引号 | \" |
| ' | 撇号 | \'(IE不支持) |
| ¥ | 人民币 | \¥ |
| ¿ | 倒置问号 | \¿ |
| ° | 角度 | \° |
| ∞ | 无限 | \∞ |
| ± | 正负号 | \± |
| % | 百分号 | \% |
| ‰ | 千分号 | \‰ |
| § | 小节 | \§ |
| © | 版权 | \© |
| ® | 注册商标 | \® |
| ™ | 商标 | \™ |
| × | 乘号 | \× |
| ÷ | 除号 | \÷ |
| ¦ | 虚竖线 | \¦ |
| Π | 圆周率 | \ϖ |


Comments | NOTHING