美文网首页技术传播那些事儿程序员
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级

Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级

作者: Lilian_Lee | 来源:发表于2017-10-25 18:49 被阅读122次

Foreword

大道至简。有写作习惯的小伙伴大概都知道 Markdown 这种易读易写、简单到极致的语言。简单到什么程度呢?讲真,会打字就会用。

Markdown 是什么?

Markdown 是一种轻量级标记语言,这个语言的目的是希望大家使用“易于阅读、易于撰写的纯文字格式,并选择性的转换成有效的 XHTML(或是 HTML)”。

Markdown 既可以用来写产品的中英文技术文档、使用说明,也可以用来写个人博客。许多网站都使用 Markdown 或是其变种,例如 GitHub、reddit、简书。

说起 Markdown,必然要说到两个人:John GruberAaron Swartz。John Gruber 在 2004 年创造了 Markdown 语言,在语法上有很大一部分是跟 Aaron Swartz 共同合作的。

John Gruber 是一名来自美国宾夕凡尼亚州的作家、博客编者和用户界面设计师。他在 Drexel University 获取计算机科学理学士后,先后在 Bare Bones Software 和 Joyent 工作。2002年起,他撰写了科技博客 Daring Fireball,还主持了播客 The Talk Show。2013年,他和 Brent Simmons、Dave Wiskus 创办了 Q Branch,并开发了 Vesper 笔记应用程序。

Aaron Swartz 出生于 1986 年,可谓互联网界的奇才,可惜 2013 年便自杀身亡,英年早逝。2014 年上映的记录片《互联网之子》记录了他短暂但辉煌的一生。纪录片英文名为:The Internet's Own Boy: The Story of Aaron Swartz

该纪录片豆瓣评分 9.1,强烈推荐。

Markdown 语法有多简单?

Markdown 的语法超级简单,两分钟了解一下就可上手。这里举几个例子告诉你有多简单:

1. 标题

通过输入特定数量的井号 "#" 即可实现不同级别的标题:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题

显示效果如下:

一级标题

二级标题

三级标题

四级标题


2. 列表

Markdown 支持有序列表和无序列表。

无序列表使用星号、加号或是减号均可实现。例如:

* PingCAP
* TiDB
* TiKV

效果等同于:

+ PingCAP
+ TiDB
+ TiDB

还等同于:

- PingCAP
- TiDB
- TiKV

有序列表使用数字接一个英文句点即可实现。例如:

1. PingCAP
2. TiDB
3. Database

显示效果如下:


3. 链接

行内链接实现方式:[链接文字](链接地址)。例如:

[PingCAP · GitHub](https://github.com/pingcap)

显示效果如下:

PingCAP · GitHub

另外,还支持参考式链接,这里暂不详述。


4. 强调

Markdown 使用星号 "*" 和底线 "_" 来实现强调效果。例如:

# 前两个显示为斜体效果

*TiDB*

_TiDB_

# 后两个显示为加粗效果

**TiDB**

__TiDB__

显示效果如下:

TiDB

TiDB

TiDB

TiDB


5. 其它

Markdown 语法还支持引用、图片、代码块等,不同的 Markdown 编辑器又有一些具体的扩展,足以满足沉浸式写作的排版要求。如果你有写作需求,建议试一试,可以远离复杂排版的干扰,让你专心写作。

有哪些 Markdown 编辑器?

Markdown 编辑器有很多,这里介绍几种 Mac 平台、Windows 平台适用的编辑器和在线编辑器。大家可以试用一下,看看自己钟爱哪款。

Mac 平台

1. MacDown


2. Typora 同样适用 Windows 平台

3. Ulysses

4. Mou

Windows 平台

1. MarkdownPad

2. Typora

在线编辑器

1. Dillinger.io

Link: https://dillinger.io

2. Markable.in

Link: https://markable.in

3. 简书

Link: http://www.jianshu.com

4. 有道云笔记

Link: https://note.youdao.com

有道云笔记里面加入了一些实用扩展,比如:待办事项标记、数学公式、图表等。

Afterword

俗话说,工欲善其事必先利其器,有一个好的工具很重要。但对于写作来说,养成良好的写作习惯更重要。毕竟,如果你有强烈而持久的写作和分享热情,再简陋的物质条件也阻止不了你。

给你一支笔,或者一台笔记本,说不定你可以写遍全世界呢……

最后,以一句话结尾:

There's a secret that real writers know that wannabe writers don't, and the secret is this: It's not the writing part that's hard. What's hard is sitting down to write. - Steven Pressfield, The War of Art

你可能想读
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
优质译文不应止于正确,还要 Well-Organized
写在入职技术型创业公司 PingCAP 一个月之后

-END-

相关文章

网友评论

    本文标题:Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级

    本文链接:https://www.haomeiwen.com/subject/zavxpxtx.html