文档章节

使用MarkDown撰写文档

王福林
 王福林
发布于 2016/10/31 10:05
字数 1649
阅读 8
收藏 0

Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用。看到这里请不要被「标记」、「语言」所迷惑,Markdown 的语法十分简单。常用的标记符号也不超过十个,这种相对于更为复杂的HTML 标记语言来说,Markdown 可谓是十分轻量的,学习成本也不需要太多,且一旦熟悉这种语法规则,会有一劳永逸的效果。

认识 Markdown

在刚才的导语里提到,Markdown 是一种用来写作的轻量级「标记语言」,它用简洁的语法代替排版,而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、字体设置。它使我们专心于码字,用「标记」语法,来代替常见的排版格式。例如此文从内容到格式,甚至插图,键盘就可以通通搞定了。目前来看,支持 Markdown 语法的编辑器有很多,包括很多网站(例如简书)也支持了 Markdown 的文字录入。Markdown 从写作到完成,导出格式随心所欲,你可以导出 HTML 格式的文件用来网站发布,也可以十分方便的导出 PDF 格式,这种格式写出的简历更能得到 HR 的好感。甚至可以利用 CloudApp 这种云服务工具直接上传至网页用来分享你的文章,全球最大的轻博客平台 Tumblr,也支持使用 Mou 这类 Markdown 工具进行编辑并直接上传。

Markdown 官方文档

这里可以看到官方的 Markdown 语法规则文档,当然,后文我也会用自己的方式,阐述这些语法在实际使用中的用法。

使用 Markdown 的优点

  • 专注你的文字内容而不是排版样式。
  • 轻松的导出 HTML、PDF 和本身的 .md 文件。
  • 纯文本内容,兼容所有的文本编辑器与字处理软件。
  • 可读,直观。适合所有人的写作语言。

我该用什么工具?

Mou icon

Mac 平台

  • 在 Mac OS X 上,我强烈建议你用 Mou 这款免费且十分好用的 Markdown 编辑器,它支持实时预览,既左边是你编辑 Markdown 语言,右边会实时的生成预览效果,笔者文章就是 Mou 这款应用写出来的。

其次还有很多同类选择。如果你是个编辑作者,我强烈建议你购买 Ulysses Ⅲ,这款应用入围了苹果去年 Mac App Store 的 The Best of 2013,相比 Mou 它支持更多的写作格式、多文档的支持。Mou、iA Writer 这些应用都是基于单文档的管理方式,而 Ulysses Ⅲ 支持 Folder、Filter 的管理,一个 Folder 里面可以创建多个 Sheet,Sheet 之间还可以进行 Combine 处理。

Windows、iOS、Web 平台

  • 笔者并未使用过 Windows 下的 Markdown 工具,但经朋友介绍,有两款还算不错,一款叫 MarkdownPad ,另一款叫 MarkPad

  • iOS 端已有相当多的 app 支持 Markdown 语法编辑,例如 Drafts、Day One、iA Writer 等。

  • Web 端上,我强烈推荐 简书 这款产品,上面有无数热爱文字的人在不停的创造、分享。在 Web 端使用 Markdown 没有比简书更舒服的地方了,它同样支持左右两栏的实时预览,字体优雅、简洁。

  • 同样是 Web 端,Draftin 这款在线 MD 编辑器也近乎完美。

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 相关的一些推荐

可配套使用的工具

相关文章阅读

本文转载自:http://sspai.com/25137

共有 人打赏支持
王福林
粉丝 10
博文 94
码字总数 37444
作品 0
徐汇
程序员
私信 提问
MarkDown模板

用掘金-Markdown 编辑器写文章 欢迎使用 掘金-Markdown 编辑器撰写技术文章,只专注于内容和技术,不再费心排版的问题。这是一份简要的 Markdown 引导指南,希望可以帮助您顺利的开始使用 ...

我又不是架构师
2017/11/16
0
0
掘金-Markdown 编辑器使用手册

用掘金-Markdown 编辑器写文章 欢迎使用 掘金-Markdown 编辑器撰写技术文章,只专注于内容和技术,不再费心排版的问题。这是一份简要的 Markdown 引导指南,希望可以帮助您顺利的开始使用 ...

凤尾
2016/09/07
0
0
技术写作工具 | GitHub + Markdown 的新轻型技术写作模式速览

Foreword 2018 年 6 月初,有位读者在后台留言向我咨询了一个关于技术写作工具的问题。那位读者从事技术写作近两年,在新入职一家公司后,一切从零开始,包括工具的调研和选用。 最后 TA 选定...

Lilian_Lee
2018/07/27
0
0
markdown 入门

# markdown quickstart --- [TOC] --- ## 1.introduction markdown的最初设计是让人专注写作,又让输出内容易于阅读。它适用于典型应用场景,如写博客,说明文档等一切要求书写内容大且快速形...

adelphos
2017/07/13
0
0
Markdown的Ruby实现--BlueCloth

BlueCloth是一个Markdown的Ruby实现,一个提供给网页文字撰写者将文本转成HTML的工具。Markdown令你可以写出容易阅读、容易撰写的文本格式,然后将它转换成结构化的XHTML(或者HTML)。 和其...

匿名
2009/04/01
889
0

没有更多内容

加载失败,请刷新页面

加载更多

kettle demo9 在Java代碼中读取文件内容插入到数据库

kettle调用java代码一步步扩展,本次在Java代码里读取本地文件,然后把数据插入到数据库 本地文件内容,book.txt 完整流程图 1、生成记录,设置1条 2、java代码,主要两部分,第一,方法上面...

wells杨
35分钟前
3
0
使用split_size优化的ODPS SQL的场景

首先有两个大背景需要说明如下: 说明1:split_size,设定一个map的最大数据输入量,单位M,默认256M。用户可以通过控制这个变量,从而达到对map端输入的控制。设置语句:set odps.sql.mapp...

阿里云官方博客
37分钟前
3
0
让线程按顺序执行8种方法

实现 我们下面需要完成这样一个应用场景: 1.早上;2.测试人员、产品经理、开发人员陆续的来公司上班;3.产品经理规划新需求;4.开发人员开发新需求功能;5.测试人员测试新功能。 规划需求,...

编程SHA
41分钟前
2
0
云服务无法绑定公网IP问题解决方案

问题描述:在云服务器上跑的代码启动服务监听公网IP的时候可能报如下异常 bind: cannot assign requested addressbind: cannot assign requested address ..... 查看配置文件写的确实是ssh连...

MrPei
43分钟前
4
0
java中的this::

::是java8 中新引入的运算符 Class::function的时候function是属于Class的,应该是静态方法。 this::function的funtion是属于这个对象的。 注意: 调用方法可以名称不一样,但是需要参数一样...

Java搬砖工程师
47分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部