优秀的编程知识分享平台

网站首页 > 技术文章 正文

Markdown实战(markdown使用教程)

nanyue 2024-08-06 18:16:07 技术文章 8 ℃

1 基本语法

  • 目录 [TOC]
  • 图片 ![](文件路径)
  • 超连接 [连接标题](文件路径)
  • 视频文件 <iframe height=498 width=510 src="视频地址">
  • 插入空格

空格

语法

一个空格

&nbsp; 或 &#160; 或 &#xA0;

二个空格

&ensp; 或 &#8194; 或 &#x2002;

四个空格

&emsp; 或 &#8195; 或 &#x2003;

细空格

&thinsp; 或 &#8201; 或 &#x2009;

  • 标题
# 一级标题   对应H1
## 二级标题   对应H2
### 三级标题 对应H3
#### 四级标题 对应H4
...
  • 字体

内容

语法

加粗

** 内容 **;

斜体

* 内容 *;

斜体加粗

* 内容 *

删除线

~~ 内容 ~~;

  • 引用(可以一直加)
>        引用内容
>>       引用内容
>>>      引用内容
>>>>>>>...  
  • 分隔线(三个以及三个以上都可以)
---
----
***
*******
  • 序列

序列类型

语法

无序序列

-,+,*

有序序列

1. 2.

  • 代码

代码类型

语法

单行代码

格式:二个`

代码块

格式:二个~~~

2 高级用法

  • 流程图 语法~~~flow
st=>start: 开始
op1=>operation: My Operation1
op2=>operation: My Operation2
cond=>condition: Yes or No?
e=>end
st->op1->cond->op2->e
cond(yes)->op2
cond(no)->op1

效果:

  • UML时序图 语法~~~sequence
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?

效果:

  • 甘特图 语法~~~mermaid
%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2021-01-06,2014-01-08
        原型                      :active,  des2, 2021-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2021-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h

效果:

  • 横向graph LR或者纵向graph TD
graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
graph LR
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2

效果:


好用的组件

  • mdline

时间轴工具,语法格式

插件安装 ~npm install -g mdline~

## {{时间}}: 标题 

内容

## {{时间}}: 标题 

内容

效果展示 ~mdline ./**.md -o timeline.html~

  • reveal-md

制作PPT工具,语法格式,以---分页

插件安装 ~npm install -g reveal-md~

# 标题

* 目录一

* 目录二

* 目录三

---

效果展示 ~reveal-md **.md --theme solarized~

4 编译器IDE推荐

Typora IDE可以输出成PDF、HTML、Word等

最近发表
标签列表