Markdown码农教程

Markdown码农教程

不知道github，你out了。> 不会markdown，你也out了。markdown有什么用？你一定没有在github上看到过README.md文件。写文档的时候我们都会用Word来写，可是Word适合码农吗?说好的代码高亮呢？繁琐的格式设置、频繁的鼠标操作，真是不爽。有没有只用键盘就能快速完成排版，适合码农的吗？有，就是markdown（md）文件。这货的实质就是让我们用最简单的办法把一个文本文件编辑好，然后通过markdown的显示引擎“转成”HTML查看。但是这个玩意远比HTML简单，不信我们就用1-2个屏幕来教会你快速使用markdown。我不会告诉你，我只用了1个小时不到就开始从新手到用这个格式来写这个文档了。

用什么可以编辑markdown文件

本质的说，markdown文件就是个文本文件，您用notepad来写也行。Mac系统的土豪们可以用Mou来写，Windows下的小伙伴就Follow me啦。我推荐使用Sublime Text 2来写。我就是这样做的。

2016-05-18更新： 强烈推荐Atom来编写markdown。

首先下载安装Sublime Text2

Sublime Text2(以后简称ST2)是个神器，码农必备。Sublime Text may be downloaded and evaluated for free, however a license must be purchased for continued use. 这个意思就是说你要持续使用的话要钱（70美元），但是能长期评估使用。这里我觉得还是应该支付这70美元，毕竟这个Sublime Text 2绝对是码农神器。

安装Package Control

启动Sublime Text 2后，按

Ctrl + (1左边的那个键)

调出命令行。然后在命令行中输入

import urllib2,os; pf='Package Control.sublime-package'; ipp=sublime.installed_packages_path(); os.makedirs(ipp) if not os.path.exists(ipp) else None; urllib2.install_opener(urllib2.build_opener(urllib2.ProxyHandler())); open(os.path.join(ipp,pf),'wb').write(urllib2.urlopen('http://sublime.wbond.net/'+pf.replace(' ','%20')).read()); print 'Please restart Sublime Text to finish installation'

重启Sublime Text 2

安装markdown preview插件

打开Sublime Text的Preferences菜单，点击Package Control。在弹出窗口上，会出现一个

Install Package

。点击这个

Install Package

，输入

markdown preview

。点击找到的

markdown preview

，安装。安装完成后重启Sublime Text 2。

编写markdown文件

见下一章

预览md文件

先说一个不靠谱的方法：

按照要求编写好md文件后，按

ctrl+shift+p

快捷键来调出

Command Palette

。调出窗口后输入

preview in browser

就可以在浏览器中看到效果了。注意，请选

githut

。不要关闭浏览器，继续修改，每次修改后保存并刷新浏览器就行。

但是这样做的话，Sublime Text 2 会经常失去响应10秒左右，要知道我的可是8G内存加SSD硬盘的i5的PC。

靠谱的方法：

首先，打开

Preferences

->

` ->

Package Settings

->

Markdown Preview

->

Settings-user`，输入

json

{

"enable_autoreload": false,

"enabled_parsers": ["github"]

}

保存。

然后在Sublime Text 2的菜单上选

Tools

->

Build System

->

Markdown

。编写号md文件后，按

Ctrl + B

会在.md文件的同目录下生成一个html文件。然后每次修改了md文件后，只要按

Ctrl + B

，然后再刷新html文件就行。

原因分析：

不靠谱的方法每次保存都会去检查，生成或更新一个临时html预览文件，当然慢啦。靠谱的方法每次保存的时候只是保存，需要在

Ctrl + B

进行Build的时候才会去生成一个html预览文件。

Markdown快速入门用法（5分钟学会，1小时掌握）

1.基本符号

*

，

-

，

+

是等价的，被称为markdown符号。必须用英文的符号，中文的不起作用

\

表示转义，码农都懂。

2. 标题及强调

使用

#

来代替

<h1>

,

##

来代替

<h2>

，依次类推

使用1个*在一段字体前后，表示斜体

使用2个*在一段字体前后，表示粗体

3. 段落

单一段落

<p>

用一个空白行

连续两个空格会变成一个

<br />

连续3个markdown符号，然后是空行，表示

<hr />

(横线)

4.项目编号

用

*

或

-

可以表示一个无序列表

用

1.

，

2.

等可以表示一个有序列表

5.引用文档

>开头表示引用，可以嵌套使用

6.代码高亮

有了github的帮忙，代码高亮是必须的。用“`开头和结尾把代码包起来就行，可以的话在开头的“`后面跟上语言名称，如java, php等等。

7.图片

一行表示: 

图片不能直接贴？放哪里呢？有免费的库吗？有，近在眼前！没错，就放在github里。我就是这么做的。注意，把图片的地址从github.com改成raw.githubusercontent.com

8.链接

[在中括号后面跟上](链接地址)，或者直接写上

http://www.xxx.com

会自动给

http://www.xxx.com

添加上链接。

更新

2016-05-18 建议大家使用Atom来编写markdown吧。Atom比Sublime更加适合markdown文件的编写。

参考资料

使用Sublime来写MarkDown

markdown 简明语法