“ Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。”
使用Word撰写文档:
DOCX是二进制格式,不方便版本控制;
格式繁杂,经常需要中断写作来控制格式;
代码与文档分离,给写文档造成更大的阻力;
使用TXT:
纯文本,没有任何格式。
使用HTML:
需要花费较多的时间在标签上
标签占了文档的较大百分比,不易阅读。
“我们坚信写作写的是内容,所思所想,而不是花样格式。”
Markdown 旨在简洁、高效,也由于 Markdown 的易读易写,人们用不同的编程语言实现了多个版本的解析器和生成器,这就导致了目前不同的 Markdown 工具集成了不同的功能(基础功能大致相同),例如流程图与时序图,复杂表格与复杂公式的呈现,虽然功能的丰富并没有什么本质的缺点,但终归有些背离初衷,何况在编写的过程中很费神,不如使用专业的工具撰写来的更有效率,所以如果你需实现复杂功能,专业的图形界面工具会更加方便。当然,如果你对折腾这些不同客户端对 Markdown 的定制所带来高阶功能感到愉悦的话,那也是无可厚非的。
所以,最终的解决方案就是Markdown ,作为一种轻量级的标记语言,能在非常短的时间内掌握。而且不仅可以用于写文档,还可以写博客、写简书、做一些随手笔记。Markdown文件以.md结尾,可以导出为html和PDF(需要使用的工具支持)。它是一种语法(个人认为是简化版的html),但是和html不同的是,各种解析器对其会有不同的表现。比如我的IDEA Markdown插件会把分割线显示成一条细灰线,Cmd Markdown则是显示一条虚线。所以建议保持使用一种Markdown工具和尽量使用标准语法。
Markdown是HTML的简化版,也是HTML的超集,合法的HTML即合法的Markdown,但Markdown进行了大量简化,专注于创作本身。
Markdown 标题有两种格式。
1、使用 = 和 - 标记一级和二级标题
= 和 - 标记语法格式如下:
一级标题
=================
二级标题
-----------------
效果如下:
2、使用 # 号标记
使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。
当然也可以在段落后面使用一个空行来表示重新开始一个段落。
Markdown 可以使用以下几种字体:
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
代码:
==工程实战派==
工程实战派
可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。
也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
***
* * *
*****
- - -
----------
如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线即可,实例如下:
GOOGLE.COM
~~BAIDU.COM~~
GOOGLE.COM
BAIDU.COM
下划线可以通过 HTML 的 标签来实现:
带下划线文本
带下划线文本
脚注是对文本的补充说明。
[^要注明的文本]
以下实例演示了脚注的用法:
创建脚注格式类似这样 [^工程实战派]。
[^工程实战派]: 工程实战派– 铭记传说,重建信仰,再战未来。
创建脚注格式类似这样 1。
Markdown 支持有序列表和无序列表。
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
有序列表使用数字并加上 . 号来表示,如:
1. 第一项
2. 第二项
3. 第三项
Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:
> 区块引用
> 工程实战派
> 铭记传说,重建信仰,再战未来。
区块引用
工程实战派
铭记传说,重建信仰,再战未来。
另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:
最外层
第一层嵌套
第二层嵌套
区块中使用列表实例如下:
区块中使用列表
- 第一项
- 第二项
- 第一项
- 第二项
- 第三项
如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进。
区块中使用列表实例如下:
工程实战派
铭记传说,重建信仰,再战未来。
如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:
printf()
代码区块
代码区块使用 4 个空格或者一个制表符(Tab 键)。
也可以用 ```包裹一段代码,并指定一种语言(也可以不指定):
$(document).ready(function () {
alert('Good!');
});
链接使用方法如下:
[链接名称](链接地址)
链接名称
或者
<链接地址>
例如:
这是一个链接 [百度](https://www.baidu.com)
这是一个链接 百度
直接使用链接地址:
高级链接
我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:
这个链接用 1 作为网址变量[Google][1]
这个链接用 baidu 作为网址变量[Baidu][baidu]
然后在文档的结尾为变量赋值(网址)
[1]: http://www.google.com/
[runoob]: http://www.runoob.com/
开头一个感叹号 !
接着一个方括号,里面放上图片的替代文字
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的’title’ 属性的文字。
Markdown 无法指定图片的高度与宽度,可以使用普通的 标签。
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
语法格式如下:
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
表格对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。
实例如下:
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
左对齐 | 右对齐 | 居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
Markdown 高级技巧
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:
等 ,如:
使用Ctrl+Alt+Del
重启电脑
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:
文本加粗
** 正常显示星号 **
**文本加粗**
\*\* 正常显示星号 \*\*
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
TeX公式
当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。
大家可以自主深入研究TeX语法。
UML绘图
简单示例:
title:工程实战派
participant 微信公众号
participant CSDN博客
participant 知乎专栏
note over 微信公众号:用户接收推送、下载资料
知乎专栏->>CSDN博客:引流
CSDN博客->>微信公众号:引流
微信公众号-->>CSDN博客:整理
CSDN博客->>CSDN博客:归纳总结
知乎专栏-->>CSDN博客:反馈
用法:将UML代码做块状引用,语言选择sequence,引擎自动渲染。
[附]Markdown编辑器通用快捷键参考:
加粗 Ctrl + B
斜体 Ctrl + I
引用 Ctrl + Q
插入链接 Ctrl + L
插入代码 Ctrl + K
插入图片 Ctrl + G
提升标题 Ctrl + H
有序列表 Ctrl + O
无序列表 Ctrl + U
横线 Ctrl + R
撤销 Ctrl + Z
重做 Ctrl + Y
Markdown编辑器推荐:
(1)Mark Text
(2)Typora
(3)VS Code
(4)VNote
参考资料
1 Markdown教程
https://www.runoob.com/markdown/md-tutorial.html
2 Markdown简明教程
https://blog.csdn.net/KNIGH_YUN/article/details/79718481
3 Markdown——入门指南
https://www.jianshu.com/p/1e402922ee32
4 使用Markdown画UML图
https://www.jianshu.com/p/5221380c65db
本文遵照Creative-Commons 4.0协议发表。
欢迎大家关注我的全新CSDN账号,将呈现细分化知识整理与精准导航,正在持续施工中。
导航页:
https://blog.csdn.net/weixin_42826353/article/details/107884463
工程实战派– 铭记传说,重建信仰,再战未来。 ↩︎