MarkDown使用小注(.md或.markdown)
1.标题创建
-
使用=和-标记一级标题和二级标题
例如:一级标题
========
二级标题
--------------
注:该方法需在源码编辑模式中使用
-
使用#标记标题
-
#的数量表示标题级数(1~6)
-
具体使用:#加空格加标题然后回车即可
-
2.段落
MarkDown段落没有特殊的格式,直接编写文字即可。
-
段落换行
-
在段落末尾使用两个空格符,直接回车即可
-
在段落后使用一个空行来表示重新开始新的段落
-
3.字体
MarkDown可以使用以下几种字体
- 两边各一个*——斜体文本
- 两边各一个_——斜体文本
- 两边各两个*——粗体文本
- 两边各两个_——粗体文本
- 两边各三个*——粗斜体文本
- 两边各三个_——粗斜体文本
4.分隔线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线
5.删除线
在文字两端加上两个~~即可出现删除线效果
6.下划线
下划线可以通过HTML的<u>标签
来实现
7.脚注
使用格式:【^要注明的文本】
8.列表
MarkDown支持有序列表与无序列表
- 无序列表使用
*、+、-
作为列表标记,这些标记后面要添加一个空格,然后再输入内容 - 有序标记使用数字并加上.号来表示
- 列表嵌套:在子列表前加上四个空格,然后
*、+、-
等空格即可
9.区块
- 在段落开头使用>然后空格,可以将多个段落合成一个区块
- 区块嵌套:使用不同数目的
>
达到不同区块嵌套的效果
10.代码
- 如果是段落上某个函数或片段,可以使用反引号包起来(`)
- 例如
printf()
函数
-
代码区块:使用4个空格符或一个制表符
-
#include<stdio.h>
{ printf(“hello,world!”)
}
-
也可以使用(```)包裹一段代码,并指定某种语言
print("hello,world!")
-
11.链接
***初级链接***使用方法:【链接名称】(链接地址)或者<链接地址>
- 例如这是一个链接菜鸟教程
- 直接使用链接地址https://www.runoob.com
高级链接
-
通过变量来设置一个链接,变量赋值在文档末尾进行
这个链接用1作为网址变量【Google】【1】
这个链接用2作为网址变量【Runnob】【2】
然后在文档结尾为变量赋值
【1】:http://www.google.com/
【2】:http://www.runoob.com/
12.图片
一般语法格式如下:
- !【alt 属性文本】(图片地址)
- !【alt 属性文本】(图片地址 “可选标题’)’
- 开头一个感叹号 !
- 接着一个方括号,里面放上图片的替代文字
- 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
变量法格式如下:
这个链接用1作为网址变量【RUNOOB】【1】
然后在文档末尾为变量赋值
【1】:http://static.runoob.com/images/runoob-logo.png
图片大小问题:
MarkDown还没有办法指定图片大小与宽度为,需要的话可以使用普通的<img>
标签。
13.表格
MarkDown制作表格使用|
来分隔不同的单元格,使用-
来分隔表头和其它行
表头 | 表头 |
---|---|
单元格 | 单元格 |
对齐方式:
-
**
-:
**右对齐 -
**
:-
**左对齐 -
**
:-:
**居中对齐
14.高级技巧
-
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:
<kbd> <b> <i> <em> <sup> <sub> <br>
等 ,如:使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
输出结果为:
- 转义
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:
**文本加粗**
\*\* 正常显示星号 \*\*
输出结果为:
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
- 公式
当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:
$$
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{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)}}
$$
输出结果为:
15.typora 画流程图、时序图(顺序图)、甘特图
复制以下代码使用 typora 的源码模式粘贴到编辑器中查看效果:
以下几个实例效果图如下:
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、标准流程图源码格式:
```mermaid
flowchat
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、标准流程图源码格式(横向):
```mermaid
flowchat
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时序图源码样例:
```mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗?
```
6、UML时序图源码复杂样例:
```mermaid
sequenceDiagram
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
```
效果图如下: