开篇提示: MarkDown使用文章大同小异,可以参考简书官方的文章 献给写作者的 MarkDown 新手指南 或 MarkDown官网
文章目录:
- Why MarkDown
- MarkDown 基础用法
- MarkDown 编辑器推荐
- 如何将 MarkDown 导出为 PDF
<br />
Why MarkDown
MarkDown是现在比较流行的文档写作工具,用它来写的文档通常以.md
结尾,适合全程键盘操作的文档书写。学习成本低,半小时就可以学会并且运用。
现在笔记类应用也基本支持MarkDown,许多网站文章发布也支持MarkDown语法。可见它的用途广泛。程序员需要用它来写说明文档readme.md
本文主要是介绍一些MarkDown的基础语法,并且推荐一些链接来学习,再罗列几款常见的编辑器。我列的不一定是最好的,仅供参考。
<br />
MarkDown基础语法
MarkDown是支持HTML
语法的,所以如果你会了解一些HTML
标签运用,也可以使用在MarkDown的写作中。
标题
从标题开始吧。不同个数的井号代表着不同级别的标题,1级是最高的,字体也最大。井号个数最多是6个,即六级标题已经是最小的标题了。注:#
后最好加一个空格,有些地方不加空格无法显示
# 一级标题
## 二级标题
...
段落与换行
段落的前后必须是空行,相邻两行文本,如果中间没有空行 会显示在一行中(换行符被转换为空格)。可以在前一行的末尾加入至少三个空格,然后换行写其它的文字。
要注意在MarkDown中再多的空格与换行都会变成一个,所以可以尝试使用:
换行:<br>
空格: (none-break-space)
分隔线: 可以在一行中使用三个或更多的 *、- 或 _ 来添加分隔线(<hr>)
文字效果
这里的文字效果指,斜体,加粗,删除线 效果。上下标
斜体:使用一个星号 * 包裹, *斜体*
加粗:二个星号包裹 **加粗**
删除线:使用两个波浪线包裹 ~~ 删除线 ~~
上标:<sup> </sup>
下标:<sub> </sub>
代码块&代码引用
代码引用效果
这是单行引用的。而之前的成段灰色背景则是块引用的。
单行代码引用,使用两个点 `我是代码` ,即tab上面的键
成段代码引用: 使用三个点开头,并用三个点 ``` 结束,包裹部分为代码块
注意三个点要独占一行
引用
使用一个大于号>
,后面加一个空格即可引用,引用完毕后加一个空行即可跳出引用
这是引用效果
图片&超链接
图片和超链都是先用方括号包裹描述部分,然后紧跟圆括号内包裹地址,两者区别就是前面有无感叹号。要注意这些符号都是在英文状态下输入
[图片上传失败...(image-1b07d5-1551955291923)]
[超链接描述](超链接地址)
列表
- 有序列表项目1
- 项目1
圆点列表:使用减号加一个空格 -
有序列表:使用数字加一个点. 然后一个空格 1. 2. 3.
星号列表:使用一个星号加个空格 *
表格
可以在表格两侧加上竖线 也可以不加
name | age
---- | ---
Jan | 22
Zen | 10
name | age |
---|---|
Jan | 22 |
Zen | 10 |
表格对齐方式: 在表头下方的分隔线标记中加入 冒号:
,即可标记下方单元格内容的对齐方式:
-
:---
代表左对齐 -
:--:
代表居中对齐 -
---:
代表右对齐
name | age
----: | :---:
Jan | 22
Zen | 10
name | age |
---|---|
Jan | 22 |
Zen | 10 |
关于表格,更多用法可以参考:
Learning-Markdown (Markdown 入门参考)
MarkDown 在线使用练习地址
<br />
MarkDown的编辑器
常用的一些代码编辑器(如VScode/autom)也是支持MarkDown的,下面就是罗列三款在win下比较流行的专属MarkDown编辑器。
-
MarkDownEditor:功能十分十分强大,并且支持云服务,pdf导出,实时预览以及目录跳转,还有良好的文档管理,就是在win下启动速度有些慢。
性质:付费软件,普通版 58rmb,Pro 128rmb。(也可以永久免费试用)
更多功能展示,点击 功能演示视频
官网下载: 下载地址
-
Typora :这款编辑最大的特色就是简洁,可以实时预览,即输入文字后立即展示。完全免费
下载地址: 官网地址
-
MarkDownpad :功能比Typora强大些,可以导出HTML,也支持预览,类似于简书的预览模式。支持多种MarkDown模式,缺点是需要激活码,经常有些小问题。
下载地址: 官网地址
以上编辑器的推荐顺序与罗列的顺序一致。
<br />
导出Markdown为PDF
- 使用编辑器的内置方法,导出
.md
为PDF - 先导入到HTML,然后使用打印选项,选择导出为PDF
- 使用VScode里的相关插件:
MarkDown PDF
- 某些笔记软件有导出MarkDown为PDF的选项,比如为知笔记(收费)(不推荐)
最后,希望以上提到的软件,可以给我提供五毛的赞助费,谢谢。