作为一位程序员,除去 Coding 编程的硬技能之外,写作的软件能也是需要培养的,而写作处处离不开 Markdown,比如 GitHub 的 Readme 文档。
虽然 Markdown 的语法并不难,但是还是有很多技巧和规范的,我总结梳理了一下,分享给大家。
大神可以直接绕道了,这是给新手学习用的。
Markdown 是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。
为什么使用 Markdown?
为什么推崇 Markdown 写作? 而非 Word 类文档呢?
- Markdown 是一段纯文本,使用任何文本编辑器都可以打开,而要打开 Word 文档,必须要先安装 Office 软件。
- Markdown 可以很轻松的对文档进行排版,而使用 Word,排版要花费大量的精力。
- Markdown 可以很轻松的转为 Html、Word、PDF 文件以及电子书。
- 现有的大多数媒体平台都已支持 Markdown。
- ……
Markdown 的创建的初衷实现「易读易写」,为的是可以让我们更专注于创作,从而提高写作效率。
有写作经验的朋友都应该很清楚,一篇文章如果要发送到多个媒体上,对于文章的排版是一件非常耗时的事情,而使用 Markdown 的文章排版只需一次即可。
如何使用 Markdown ?
Markdown 的优点说了这么多,它是否学起来很复杂呢?
其实 Markdown 是一个及其简单的语法,对于写作而言,我们在 5 - 10 分钟就可以轻松入门。
区块引用
引用标记符为>
,通常用作标注文章的主旨,名人名言的引用等
这是一个引用
标题
形式则是在行首插入 1 到 6 个 #
,对应的是 1 到 6 级标题
# 这是 H1
## 这是 H2
###### 这是 H6
列表
Markdown 支持有序列表和无序列表。
无序列表的标记是减号 -
- 无序列表1
- 无序列表2
等同于
- 无序列表1
- 无序列表2
有序列表则使用数字接着一个英文句点:
- 有序列表1
- 有序列表2
- 有序列表3
强调
两个 *
或 _
包起来即可, 特殊强调的文字段落都会被加粗。
这是一段强调的段落
*
和 _
两边不要有空格,否则它们就只会被当成普通的符号。
链接
只要使用方括号<>
包起来, Markdown 就会自动把它转成链接。
文字上的超链接是如何实现的呢?使用[链接名称](链接地址)
标记符号
[这是个百度的链接](http://baidu.com)
等同于
图片
图片标记符号![图片名称](图片路径)
![简书](http://upload.jianshu.io/users/upload_avatars/259/0eeb76652869.png?imageMogr2/auto-orient/strip|imageView2/1/w/96/h/96)
等同于
Markdown 插入的图片必须都是在线访问的, Markdown 中不能直接指定图片的高度和宽度。
特殊字符
如果我们在 Markdown 中要插入 >
、*
等等的特殊字符怎么办呢?在这些特殊字符前加上反斜杠/
即可。
写作规范
掌握这么多语法就可以写作了吗?其实还是不够的,我们还需要掌握一些 Markdown 的写作规范。
中英文之间需要增加空格
正确:
CCTV 是央视频道。
错误:
CCTV是央视频道。
中英文、数字之间需要增加空格
正确:
今年双十一我花费了 1000 元。
错误:
今年双十一我花费了1000元。
数字单位之间应该增加空格
正确:
这个硬盘是 10 TB。
错误:
这个硬盘是 10TB。
不要重复使用标点符号
正确:
今年双十一我居然花费了 1000 元!
错误:
今年双十一我居然花费了 1000 元!!??
专有名词使用正确的大小写
正确:
请使用 WeChat 登录。
错误:
请使用 wechat 登录。
全角和半角符号
如果你不了解全角和半角符号,请查看全角百度百科。
中文段落中使用中文全角标点。
正确:
嗨!你好!
错误:
嗨!你好!
英文整句使用半角标点
正确:
- Belive You.
错误:
- Belive You。
有研究表表明:打字时不喜欢在中英文之间加空格的人,感情路都会走的很辛苦哦!所以大家一定要养成写作规范的好习惯哦!
让我们一起愉快地使用 Markdown 开始创作吧!
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。