markdown学习笔记

一、标题

标题的表示一共有两种方法:

  1. 使用多个#号加空格开头一行的标题,#号数量代表标题的等级。
    以此类推最多六级。

    一级标题

    二级标题

    三级标题

  2. 使用下一行加入===组成的下划线的一级标题,以及下一行加入---组成的下划线的二级标题。其中,下划线长度没有限制。

    一级标题

    一级标题

    二级标题

二、格式

(一)换行

有两种方法用于换行:

  1. 在末尾添加两个空格并回车。

    第一行
    第二行

  2. 两个回车。

    第一行

    第二行

(二)字体

有粗体、斜体、粗斜体三种字体样式,其中每种样式有两种键入方法。

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

(三)分隔线

在单独一行中使用三个以上的星号、减号、下划线用于建立分隔线,符号间可以有空格,但行内不能出现其他字符。
需要特别注意使用-作为分隔线时可能与二级标题格式冲突。

正文


正文



格式冲突处

正文


正文

(四)删除线

在文字两端各添加两波浪线即为删除线。

ABCDEFGHIJK
ABCDEFGHIJK

(五)下划线

下划线使用标签作为起始,使用标签作为结束。

标签中间不得出现空格

(六)脚注

脚注分为要标注的文本和脚注本身,将文本用中括号扩起并在中括号开头输入^可创建被标注的文本,脚注本身则为以上内容后添加冒号,后接说明文本。

需要注意的是[1]不支持该格式脚注

三、列表

(一)无序列表

无序列表可用星号、加号、减号加空格作为行开头。其中,不同符号开头的列表会被分隔开。

  • 第一项
  • 第二项
  • 第三项
  • 第四项
  • 第五项
  • 第六项

(二)有序列表

有序列表使用数字与.作为行开头。其中,数字编号会自动修正。

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

(三)列表嵌套

在子列表行开头添加四个空格(或tab)可实现嵌套。

  1. 第一大项
    • 第一小项
    • 第二小项
      • 第一小项
  2. 第二大项
    • 第一小项

四、区块

在行首添加>加空格即可生成引用区块。在区块中可嵌套区块。

引用区块

嵌套

在列表中加入区块需要在>前加入四个空格或tab。

  1. 列表

    列表内区块
    列表外区块

五、代码

利用一对``可标注单行代码。

printf(),该标注方法可以放于正文内。

以四个空格或tab开头一行可生成代码区块。

#include
void main(){
    return 0;
}

或用一对```可以生成代码区块,并可在第一行指定语言。

x = -3:0.1:3;
y = x^2;
plot(x,y)

六、链接

生成链接的格式为

[链接名称](链接地址)

本教程来源于菜鸟教程

链接地址可以放于文档尾以节省正文文字空间。赋值格式为

[链接名称][变量名称]
[变量名称]:链接地址

这个链接用 1 作为网址变量 Google
这个链接用 runoob 作为网址变量 Runoob
然后在文档的结尾为变量赋值(网址)

七、图片

生成图片格式为

![alt 属性文本](图片地址)  
![alt 属性文本](图片地址 "可选标题")

图片地址可以为此.md文件的相对地址或网络地址,也可像链接一样在文档末尾赋值。



这个链接用 1 作为网址变量 RUNOOB.
然后在文档的结尾为变量赋值(网址)

若需要指定图片的高度与宽度,需要使用标签。

文字说明

八、表格

使用|分隔单元格,使用-分隔表头与元素行。

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

在-行加入不同符号可以设置对其方式。

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

九、高级技巧

(一)支持HTML

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:
等。

使用 Ctrl+Alt+Del 重启电脑
请不要在阅读本文时尝试重启电脑 (ー_ー)

(二)转义

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

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

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

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

(三)公式

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

\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}

(四)流程图

可以绘制流程图、时序图(顺序图)、甘特图等,但可能需要插件进行预览。
详情见菜鸟教程高级技巧笔记。
1、横向流程图源码格式:

graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]

2、竖向流程图源码格式:

graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]

3、标准流程图源码格式:

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、标准流程图源码格式(横向):

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时序图源码样例:

对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?

6、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: 没人陪我玩

7、UML标准时序图样例:

%% 时序图例子,-> 直线,-->虚线,->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗?
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 
看医生... 李四-->>张三: 很好! 王五->李四: 你怎么样? 李四-->王五: 很好!

8、甘特图样例:

%% 语法示例
        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. 比如vscode平台不支持 ↩

你可能感兴趣的:(markdown学习笔记)