前言
因为现在的前端基本上都用上了前端构建工具,那就难免要写一些readme等等的说明性文件,但是这样的文件一般都是.md的文件,编写的语法自然跟其他格式的文件有所区别,置于为什么要用这种格式的文件,不要问我,我也不知道,大家都这么用,跟着用就对了,本文也是我学习写markdown文件的一个笔记吧,仅供参考!
正文
Markdown 语法的简要规则
标题
标题是每篇文章都需要也是最常用的格式,在 Markdown 中,如果一段文字被定义为标题,只要在这段文字前加 #
号即可。
# 一级标题
## 二级标题
### 三级标题
以此类推,总共六级标题,建议在井号后加一个空格,这是最标准的 Markdown 语法。
列表
熟悉 HTML 的同学肯定知道有序列表与无序列表的区别,在 Markdown 下,列表的显示只需要在文字前加上 -
或 *
即可变为无序列表,有序列表则直接在文字前加 1.``2.``3.
符号要和文字之间加上一个字符的空格。
引用
如果你需要引用一小段别处的句子,那么就要用引用的格式。
> 例如这样
只需要在文本前加入 >
这种尖括号(大于号)即可
图片与链接
插入链接与插入图片的语法很像,区别在一个 !
号
插入图片的地址需要图床,这里推荐 CloudApp 的服务,生成URL地址即可。
粗体与斜体
Markdown 的粗体和斜体也非常简单,用两个 *
包含一段文本就是粗体的语法,用一个 *
包含一段文本就是斜体的语法。
例如:这里是粗体 这里是斜体
表格
表格是我觉得 Markdown 比较累人的地方,例子如下:
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
这种语法生成的表格如下:
| Tables | Are | Cool | |---------------|---------------|-------| | col 3 is | right-aligned | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 |
代码框
如果你是个程序猿,需要在文章里优雅的引用代码框,在 Markdown 下实现也非常简单,只需要用两个 ` 把中间的代码包裹起来,如 code
。图例:
使用 tab
键即可缩进。
分割线
分割线的语法只需要另起一行,连续输入三个星号 ***
即可。
小结
到这里,Markdown 的基本语法在日常的使用中基本就没什么大问题了,只要多加练习,配合好用的工具,写起东西来肯定会行云流水。更多的语法规则,其实 Mou 的 Help 文档例子很好,当你第一次使用 Mou 时,就会显示该文档,其次,你也可在撰写过程中,使用 CMD+R
快捷键来快速打开文档,以随时查阅和学习语法。
与 Markdown 相关的一些推荐
可配套使用的工具
相关文章阅读
- 为什么作家应该用 Markdown 保存自己的文稿
- Markdown 写作浅谈
- Markdown 工具补完
- Drafts + Scriptogr.am + Dropbox 打造移动端 Markdown 风格博客
- 图灵社区 - 怎样使用 Markdown
- 为什么我们要学习 Markdown 的三个理由
- Markdown 语法写作入门指南 by ibuick