Markdown知识

Posted yangjavaer

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Markdown知识相关的知识,希望对你有一定的参考价值。

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
本文档取材自菜鸟教程,方面个人学习与后续查询

标题

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

# 一级标题  
## 二级标题  
### 三级标题  
#### 四级标题  
##### 五级标题  
###### 六级标题  

段落格式

段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车

这是一个段落  
段落换行

效果如下:

这是一个段落
段落换行

段落后面使用一个空行来表示重新开始一个段落

这是一个段落

新段落

效果如下:

这是一个段落

新段落

字体

*斜体文本*  
**粗体文本**  
***粗斜体文本***  

效果如下:

斜体文本
粗体文本
粗斜体文本

分割线

三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西

***  
---  
___  

效果如下:




删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可

~~我是删除线~~

效果如下:

我是删除线

下划线

下划线可以通过 html<u> 标签来实现

<u>下划线文本</u>

效果如下:

下划线文本

脚注

脚注是对文本的补充说明。

Markdown 脚注的格式如下

java[^1]只是精进
[^1]: 一门面向对象的计算机编程语言

效果如下:

java[1]只是精进

列表

无需列表

无序列表使用星号()、加号(+)或是减号(-*)作为列表标记

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项

效果如下:

  • 第一项
  • 第二项
  • 第三项
  • 第一项
  • 第二项
  • 第三项
  • 第一项

  • 第二项

  • 第三项

有序列表

有序列表使用数字并加上 . 号来表示

1. 第一项
2. 第二项
3. 第三项

效果如下

  1. 第一项
  2. 第二项
  3. 第三项

列表嵌套

列表嵌套只需在子列表中的选项添加四个空格即可

1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

效果如下:

  1. 第一项:
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项:
    • 第二项嵌套的第一个元素

    • 第二项嵌套的第二个元素

区块

区块引用

区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号

> 区块引用
> Markdown知识学习

效果如下:

区块引用
Markdown知识学习

区块嵌套

一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

效果如下:

最外层

第一层嵌套

第二层嵌套

区块中使用列表

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

效果如下:

区块中使用列表

  1. 第一项
  2. 第二项
  • 第一项
  • 第二项
  • 第三项

列表中使用区块

* 第一项
    > JAVA教程
    > 学的不仅是技术更是梦想
* 第二项

效果如下:

  • 第一项

    JAVA教程
    学的不仅是技术更是梦想

  • 第二项

代码

函数或代码片段

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`

`printf()` 函数

效果如下:

printf() 函数

代码区块

``` 包裹一段代码,并指定一种语言(也可以不指定)

?```javascript
$(document).ready(function () {
    alert(‘RUNOOB‘);
});
?```

效果如下:

$(document).ready(function () {
    alert(‘RUNOOB‘);
});

链接

基本语法

这是一个链接[百度](www.baidu.com)
或者
<www.baiduc.om>

效果如下:

这是一个链接百度
或者
<https://www.baidu.com>

高级链接

可以通过变量来设置一个链接,变量赋值在文档末尾进行

这是谷歌的链接[Google][google]
这是百度的链接[百度][baidu]
[google]: http://www.google.cn
[baidu]: https://www.baidu.com

效果如下:

这是谷歌的链接Google
这是百度的链接百度

图片

基本语法

  • 开头一个感叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title‘ 属性的文字。
![百度图标](https://www.baidu.com/img/flexible/logo/pc/result.png)

![百度图标](https://www.baidu.com/img/flexible/logo/pc/result.png "这是百度的图标")

效果如下:

技术图片

技术图片

img标签

Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 技术图片 标签

指定宽高:
<img src="https://www.baidu.com/img/flexible/logo/pc/result.png" alt="百度图标" title="这是百度的图标" width="200px" height="200px" />
缩放:
<img src="https://www.baidu.com/img/flexible/logo/pc/result.png" alt="百度图标" title="这是百度的图标" style="zoom:50%;" />

效果如下:

指定宽高:
技术图片
缩放:
技术图片

表格

基本语法

制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

效果如下:

表头 表头
单元格 单元格
单元格 单元格

对齐方式

  • -: 设置内容和标题栏居右对齐。

  • :- 设置内容和标题栏居左对齐。

  • :-: 设置内容和标题栏居中对齐。

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

效果如下:

左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

高级技巧

支持html元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

效果如下:

使用 Ctrl+Alt+Del 重启电脑

转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符

**文本加粗** 
** 正常显示星号 **

效果如下:

文本加粗
** 正常显示星号 **

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

公式

当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:

$$
mathbf{V}_1 	imes mathbf{V}_2 =  egin{vmatrix} 
mathbf{i} & mathbf{j} & mathbf{k} \frac{partial X}{partial u} &  frac{partial Y}{partial u} & 0 \frac{partial X}{partial v} &  frac{partial Y}{partial v} & 0 \end{vmatrix}
${$tep1}{style{visibility:hidden}{(x+1)(x+1)}}
$$

效果如下:

[mathbf{V}_1 imes mathbf{V}_2 = egin{vmatrix} mathbf{i} & mathbf{j} & mathbf{k} \frac{partial X}{partial u} & frac{partial Y}{partial u} & 0 \frac{partial X}{partial v} & frac{partial Y}{partial v} & 0 \end{vmatrix} ${$tep1}{style{visibility:hidden}{(x+1)(x+1)}} ]

流程图

1. 横向流程图:
?```mermaid
graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]
?```
2. 竖向流程图:
?```mermaid
graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]
?```
3. 标准流程图:
?```flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
?```
4. 标准流程图(横向):
?```flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
?```
5. UML时序图:
?```sequence
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?
?```
6. UML时序图(复杂):
?```sequence
Title: 标题:复杂使用
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
?```
7. UML标准时序图:
?```mermaid
%% 时序图例子,-> 直线,-->虚线,->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗?
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!
?```
8. 甘特图:
?```mermaid
%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h
?```

效果如下:

  1. 横向流程图:
graph LR A[方形] -->B(圆角) B --> C{条件a} C -->|a=1| D[结果1] C -->|a=2| E[结果2] F[横向流程图]
  1. 竖向流程图:
graph TD A[方形] --> B(圆角) B --> C{条件a} C --> |a=1| D[结果1] C --> |a=2| E[结果2] F[竖向流程图]
  1. 标准流程图:
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
  1. 标准流程图(横向):
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
  1. UML时序图:
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?
  1. UML时序图(复杂):
Title: 标题:复杂使用
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
  1. UML标准时序图:
%% 时序图例子,-> 直线,-->虚线,->>实线箭头 sequenceDiagram participant 张三 participant 李四 张三->王五: 王五你好吗? loop 健康检查 王五->王五: 与疾病战斗 end Note right of 王五: 合理 食物 <br/>看医生... 李四-->>张三: 很好! 王五->李四: 你怎么样? 李四-->王五: 很好!
  1. 甘特图:
%% 语法示例 gantt dateFormat YYYY-MM-DD title 软件开发甘特图 section 设计 需求 :done, des1, 2014-01-06,2014-01-08 原型 :active, des2, 2014-01-09, 3d UI设计 : des3, after des2, 5d 未来任务 : des4, after des3, 5d section 开发 学习准备理解需求 :crit, done, 2014-01-06,24h 设计框架 :crit, done, after des2, 2d 开发 :crit, active, 3d 未来任务 :crit, 5d 耍 :2d section 测试 功能测试 :active, a1, after des3, 3d 压力测试 :after a1 , 20h 测试报告 : 48h

  1. 一门面向对象的计算机编程语言 ??














以上是关于Markdown知识的主要内容,如果未能解决你的问题,请参考以下文章

markdown PHPExcel Notes和代码片段

markdown Git代码片段

markdown 岩组代码片段

markdown [magento] - 代码片段

markdown 在WordPress中使用jQuery代码片段

markdown 打字稿...编码说明,提示,作弊,指南,代码片段和教程文章