Markdown基本语法

Posted yanqingyang

tags:

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

1. 分级标题

在行首使用‘#’标记标题,‘#’的个数表示该标题的级别。

2. 斜体和粗体

使用成对的 * 和 ** 分别表示斜体粗体

3. 无序列表

使用 *,+,- 表示无序列表。

e.g:

  • 无序列表项一
    • 无序列表项二
  • 无序列表项一
    • 无序列表项二
  • 无序列表项一
    • 无序列表项二

4. 有序列表

使用数字和点表示有序列表,注意1.和文字之间要保留一个字符的空格。

e.g:

  1. 有序列表项一
    1. 有序列表项一
    2. 有序列表项二
  2. 有序列表项二
  3. 有序列表项三

5. 表格

Item Value Qty
Computer $1600 5
Phone $12 12
Pipe $1 234

6. 数学公式

以$ 公式 $来开始书写数学公式。

e.g:(y = x^2)

Math block:

[oint_c x^3, dx + 4y^2, dy ]

[2 = left(frac{left(3-x ight) imes 2}{3-x} ight) ]

[sum_{m=1}^inftysum_{n=1}^inftyfrac{m^2,n}{3^mleft(m,3^n+n,3^m ight)} ]

[phi_n(kappa) = frac{1}{4pi^2kappa^2} int_0^inftyfrac{sin(kappa R)}{kappa R}frac{partial}{partial R}left[R^2frac{partial D_n(R)}{partial R} ight],dR ]

7. 行内代码块

使用 `代码` 表示行内代码块。

e.g:

让我们聊聊 html

8. 代码块

使用 四个缩进空格或一个制表符表示代码块。

e.g:

这是一个代码块,此行左侧有四个不可见的空格。

9. 高亮代码块

使用“```”+“语言名称”进行标记。

9.1 非代码

$ sudo apt-get install vim-gnome

9.2 Python

@requires_authorization
def somefunc(param1=‘‘, param2=0):
    ‘‘‘A docstring‘‘‘
    if param1 > param2: # interesting
        print ‘Greater‘
    return (param2 - param1 + 1) or None

class SomeClass:
    pass

>>> message = ‘‘‘interpreter
... prompt‘‘‘

9.3 C++

#include <iostream.h>
using namespace std;

int main(){
    cout << "Hello World!" << endl;
    return 0;
}

10. 分割线

只需另起一行,连续输入三个或以上的***---___即可分割两段文字内容。

11. 添加链接

使用 [描述](链接地址) 为文字增加外链接。

e.g:

我的博客 燕清扬

12. 插入图像

使用 ![描述](图片链接地址) 插入图像。此处的图片链接地址可为在线图片链接或本地电脑图片地址。

e.g:
技术图片

13. 文字引用

使用 > 表示文字引用。

e.g:

野火烧不尽,春风吹又生。

14. 删除线

使用 ~~ 表示删除线。

示例:

这是一段错误的文本。

15. 注脚

使用 [^keyword] 表示注脚。

这是一个注脚[1]的样例。

这是第二个注脚[2]的样例。

16. 甘特图

基本是一条线条图,横轴表示时间,纵轴表示活动(项目),线条表示在整个期间上计划和实际的活动完成情况。它直观地表明任务计划在什么时候进行,及实际进展与计划要求的对比。

gantt
    dateFormat YYYY-MM-DD
    title 项目开发流程
    section 项目确定
        需求分析       :2016-06-22, 3d
        可行性报告     :5d
        概念验证       :5d
    section 项目实施
        概要设计       :2016-07-05, 5d
        详细设计       :2016-07-08, 10d
        编码           :2016-07-15, 10d
        测试           :2016-07-22, 5d
    section 发布验收
        发布: 2d
        验收: 3d

17. 流程图

一段流程图语法以 ``` 开头,以 ``` 结尾。

在``` 后另起一行,书写graph XX,用以确定将要绘制的流程图及其类型(XX表示流程图类型)。

流程图分为竖向和横向两大类,竖向包括自上而下和自下而上两种顺序,横向包括从右到左和从左到右两种顺序。

其对应语法分别为:graph TB/ graph BT/ graph RL/ graph LR:

  • TB - top bottom(自上而下)
  • BT - bottom top(自下而上)
  • RL - right left(从右到左)
  • LR - left right(从左到右)

17.1 自上而下流程图

graph TB
    A--> B

17.2 自下而上流程图

graph BT
    A--> B

17.3 自左而右流程图

graph LR
    A--> B

17.4 自右而左流程图

graph RL
    A--> B

17.5 具体案例

graph TD
    A[Christmas] --> B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[Car]

17.6 框线形状

 graph LR
   A[直角四边形]
 graph LR
   A((圆形))
 graph LR
   A{菱形}

17.7 箭头

 graph LR
   A[A]---B[B]
 graph LR
   A[A]-->B[B]
 graph LR
   A[A]-->|插入文本|B[B]

18. 序列图

sequenceDiagram
    loop every day
        Alice->>John: Hello John, how are you?
        John->>Alice:Great!
    end

19. 定义型列表

名词 1
定义 1(左侧有一个可见的冒号和四个不可见的空格)
代码块 2
这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)

20. 待办事宜 To-do List

使用带有 [x] 或 [ ](未完成或已完成)项的列表语法撰写一个待办事宜列表,并且支持子列表嵌套以及混用Markdown语法,示例:

  • [x] 已完成事项1
    • [x] 子列表-已完成事项1
    • [x] 子列表-已完成事项2
  • [ ] 待办事项1
    • [ ] 子列表-待办事项1
    • [ ] 子列表-待办事项2

21.换行和分段

  • 换行:行末加两个或以上个空格
  • 分段:两个回车

22.转义

使用反斜杠来插入一些在语法中有其它意义的符号:

反斜线

` 反引号

* 星号

_ 底线

{} 花括号

[] 方括号

() 括弧

# 井字号

+ 加号

- 减号

. 英文句点

! 惊叹号




  1. 这是一个 注脚文本??

  2. 这是另一个 注脚文本??


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

MorkDown 常用语法总结

markdown 一堆Git的基本片段

forever的markdown基本语法的学习随笔

Markdown的基本语法记录

Markdown基本语法

Markdown基本语法