[笔记] Markdown

113 阅读2分钟

1.安装ReText

按快捷键 Alt+F2 ,输入

gnome-terminal 

进入Bash界面执行:

$ sudo apt-get install retext 

2. 安装Typora

官网:typora.io/

进入官网下载相应安装包即可,从1.xx版本开始收费,最后一个免费版本号为0.11.18

3. Markdown与HTML关系

Markdown属于HTML的子集,Markdown语法兼容HTML标签,可以在Markdown中混写;

某些HTML区块元素如<div>/<table>/<pre>/<p>等,需要在前后加上空行与其它内容隔开;

在HTML中的Markdown样式无效,语法有效;

4. Markdown语法-特殊符号

Markdown会对’<’与’&’自动处理;特殊符号HTML实体如下:

  ’<’: &lt;
  ’&’: &amp;
  ’©’: &copy;
  ’ ’: &ensp;
  ’ ’: &emsp;

另外,在code范围内的’<’与’&’一定会被替换为HTML实体;

5. Markdown语法-段落和换行

段落,由一个或多个连续的文本行组成,在前后要有一个以上空行;换行,段落内插入换行符;

6. Markdown语法-标题

Markdown支持两种标题语法,类Setext和类Atx形式:

  Setext:使用等号或减号表示

  Atx:使用#号个数表示

7. Markdown语法-引用

在行或者段落前面添加’>’符号,效果如下:

这是一个引用

8. Markdown语法-列表

Markdown支持有序列表和无序列表;

  无序列表:使用’*’/‘+’/‘-‘开头

  有序列表:使用数字加一个英文点开头

9. Markdown语法-分隔线

在一个行中包含3个以上的’*’/‘-‘/‘_’,并且不包含其他内容,效果如下:


10. Markdown语法-代码框

单行代码框使用’`‘将代码包裹起来,效果如下:

#include <stdio.h> int main(){ return 0; }

多行代码框使用’```‘将代码包裹起来,效果如下:

#include <stdio.h>

int main(){
    return 0; 
} 

11. Markdown语法-链接

将显示内容放入’[]’里,在后面跟上’()’,里面填入地址,如:

[Baidu](baidu.com)

效果如下:

Baidu

12. Markdown语法-图片

与链接类似,在链接前加入’!’即可:

![image1](p3-juejin.byteimg.com/tos-cn-i-k3…)

效果如下:

image1

13. Markdown语法-表格

表格中每一行度元素直接使用’|’隔开,如果该行为属性行则需要在下一行添加’|:—|:—:|—:|’结构,如:

| Table | Are | Cool |
| :—: | :– | —: |
| 1 | 2 | 3 |
| 4 | 5 | 6 |

效果如下:

TableAreCool
123
456

14. Markdown语法-锚点

目录中经常需要使用锚点跳转,锚点与链接语法一致,不同在与后面的’()’里输入页面元素的id,故需要与带id属性的HTML元素结合使用,如:

[这是一个锚点](#id_number)
<span id=’id_number’>**这里是内容(跳到这里)**</span>

效果如下:

这是一个锚点

这里是内容(跳到这里)

15. Markdown语法-画图

Typora支持mermaid语法,官方文档地址:mermaid-js.github.io/mermaid/#/

时序图(sequenceDiagram):

sequenceDiagram
    Alice->John: Hello John, how are you?
    Note over Alice,John: A typical interaction

类图(classDiagram):

classDiagram
  direction RL
  class Student {
    -idCard : IdCard
  }
  class IdCard{
    -id : int
    -name : string
  }
  class Bike{
    -id : int
    -name : string
  }
  Student "1" --o "1" IdCard : carries
  Student "1" --o "1" Bike : rides

状态图(stateDiagram):

stateDiagram
    [*] --> Still
    Still --> [*]

    Still --> Moving
    Moving --> Still
    Moving --> Crash
    Crash --> [*]

饼图(pie):

pie
    title Key elements in Product X
    "Calcium" : 42.96
    "Potassium" : 50.05
    "Magnesium" : 10.01
    "Iron" :  5

更多图形参考官方文档。