Zhibin's blog

always smile :-)

Markdown Usage

| Comments

什么是 markdown ?

随着 Github 的流行,markdown 渐渐获得了人们的青睐,当作一种更便于读写的格式流行起来. github 默认支持 markdown格式的文件,例如这个 README.markdown 文件,在github 上展示的时候会被直接解析成漂亮的格式。

随后,github page 的出现可以使你可以在 github 上搭建一个免费博客,使用 markdown 语法。

再然后,出现了jekyllrbOctopress 这种基于 github page 和 markdown 的 Blog 框架,使人们摆脱 wordpress 的臃肿,不必担心找不到托管服务器,使用简单的 markdown 语法即可快速撰写和发布博客。(当前这个 blog 正是使用 Octopress + github page 搭建的博客)

简单的说,markdown 是一种轻量级的标记语言,它的目标是易读易写,使用 markdown 书写的格式可被 markdown 解析器转换成格式良好的 html/xhtml 文件。

markdown 包含两层含义,一层是 markdown 语法;另外一层是解析 markdown 语法文件的软件。

一些介绍 markdown 语法的资源:

谁使用 markdown ?

列举几个著名的:

mark down 语法 Example

标题

使用任意数量的 === 表示一级标题,---- 表示二级标题。

如:

一级标题
===========

二级标题
--------

也可以采用在行首插入 # 的格式,行首插入 1-6 个 # ,对应1级到6级标题

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

块引用

在每行的行首加入 > 可建立一个块引用

如:

>Stay hungry, stay foolish !

显示效果:

Stay hungry, stay foolish !

在块引用内部也支持 markdown 标记,多级引用: 比如:

>###Title
>some code
>
>    sudo make me a sandwitch
>>二级引用

显示效果:

Title

some code

sudo make me a sandwidth

二级引用

强调

markdown 使用 *_ 来表示强调,被一个或多个 * _ 包围的字句会被显示为强调。

如:

*one*
_one_
**two**
__two__
***three***
___three___

显示效果:

one one two two three three

列表

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

在行首使用 *, + 或者 - 加一个空格作为无序列表标记。

如:

* ul 1
* ul 2
* ul 3

显示效果:

  • ul 1
  • ul 2
  • ul 3

有序列表使用数字和一个英文句点 . 加一个空格。

如:

 1. ol 1
 2. ol 2
 3. ol 3

显示效果:

  1. ol 1
  2. ol 2
  3. ol 3

链接

markdown 支持两种链接:行内参考两种形式。

行内链接的写法:将链接文字用 [] 括起来,链接地址用 () 括起来。

如:

[My Blog](http://stevevallay.github.io)

显示效果:

My Blog

参考链接与行内链接不同,参考链接将链接地址放在另外的地方(一般集中放在页面下方),用数字来引用:

如:

[My Blog][100]
[100]:http://stevevallay.github.io

显示效果:

My Blog

引用代码

在句子中,可以使用反引号(`)标记一小段代码。

如:

get bash help from `man bash`

显示效果:

get help from man bash

插入一段多行程序代码,使用多个反引号开头和结尾。

如:

```
sudo make me a sandwich
eat it
```

显示效果:(这里的显示效果可能有些不同,因为这里使用了 Octopress 的 Backtick Code Block 插件

1
2
sudo make me a sandwich
eat it

图片

markdown 使用和链接类似的语法来插入图片,同样也有两种样式:行内参考

行内引用:

1
   ![Image Description](/image/path/aa.img)

显示效果:

Example Image

参考引用:

1
2
![示例图片][101]
[101]:/images/blog/create_a_repo.png

显示效果:

示例图片

注脚

注脚和链接类似,只是编号使用一个 ^符号开头,比如:

1
2
3
  footnote example[^1]
  
  [^1]:this is a footnote

显示效果

this is a fotnote1

转义

markdown 语法中特殊意义的字符输入的时候要用反斜杠\来转义。

如:

1
2
3
4
5
6
7
8
9
10
11
12
\  反斜杠
`  反引号
*  星号
_  底线
{} 花括号
[] 方括号
() 括弧
#  井字号
+  加号
-  减号
.  英文句点
!  惊叹号

Markdown 编辑器

Windows 下我使用 MarkdownPad 作为 markdown 编辑器。


  1. this is a footnote

Comments