Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。Markdown 编写的文档后缀为 .md, .markdown。
markdown语法
- 使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推
*斜体文本*,**粗体文本**, ***粗斜体文本***
- 一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西
- 文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~即可
- 下划线可以通过 HTML 的
<u></u>
标签来实现 - 换行: 使用html
<br>
标签 - 脚注是对文本的补充说明
说明文本[^要注明的文本]
在文末加上[^要注明的文本]: markdown说明
- 无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要加一个空格,然后再填写内容; 有序列表使用数字并加上 . 号来表示
- 使用反斜杠转义特殊字符,如*号,可以使用
\*
来解决 - 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号。区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推。如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进
- 函数或片段的代码可以用反引号`把它包起来,可以用 ``` 包裹一段代码,并指定一种语言
- 链接:
[链接名称](链接地址) or <链接地址>
- 图片:
![alt 属性文本](图片地址) or ![alt 属性文本](图片地址 "可选标题")
,如果想指定图片宽度高度,需要使用html的<img>
标签,如<img src="http://www.xxx.com/xxx.jpg" width="50%">
- 表格:使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。-: 设置内容和标题栏居右对齐,:- 设置内容和标题栏居左对齐, :-: 设置内容和标题栏居中对齐
1 2 3 4
| 表头 | 表头 | | ---- | ---- | | 单元格 | 单元格 | | 单元格 | 单元格 |
- 任务列表:
- [ ] foo, - [x] bar
- 公式: 要显示α,在”\alpha” 前后分别加上$,
$\alpha$
,上标$a^b$
,下标$a_b$
,分数$\frac{3+8a}{5b+6}$
, 求和$\sum{3x^n}$
。其他写法参考Mathematics in R Markdown
markdown编辑软件
-
marktext – 从官网下载,或者使用
brew install --cask mark-text
安装, 具体见marktext中文说明 - visual code插件之Markdown All in One: 包括快捷键、公式等功能
- visual code插件之Markdown Preview Enhanced: 除了实时预览外,还包括了其他许多有用的功能,包括mermaid, PlantUML, pandoc, PDF导出等功能
- typora – 从1.0.0开始收费
markdown文件导出为html、doc、epub、pdf格式
- 安装pandoc,
brew install pandoc
- 将markdown转成html:
pandoc -f markdown -t html ./test.md
- 将markdown转成doc:
pandoc -f markdown -t html ./test.md | pandoc -f html -t docx -o test.docx
- 将markdown转成PDF,需要安装latex。只要安装basicTex就可以了,大概100M+,安装完后运行:
pandoc -f markdown_github test.md -o test.pdf --latex-engine=xelatex -V mainfont="SimSun"
这个表明使用的是GitHub风格markdown语法 - 将markdown转成epub:
pandoc -f markdown ./test.md -o test.epub
交流
我发文章的几个地方,欢迎大家在朋友圈等地方分享,多多交流。
参考
- markdown wikipedia
- GitHub Flavored Markdown Spec – github风味markdown规范增加了表格、删除线、自动链接和任务列表功能
- pandoc demos
- Markdown数学公式