如何使用 markdown 语法写博客

平时我写日记、文档和博客都会用到 markdown 语法,我用的是 马克飞象 先在本地写好,而且可以和 印象笔记 同步,如果知识积累的多了,也会总结下,分享到社区,直接 <kbd>⌘ - C</kbd> 然后 <kbd>⌘ - V</kbd> 就可以了,特别方便。 🙂

简书貌似不支持公式和流程图等,详情,可查阅我的博客 lishaoy.net


什么是Markdown语法

Markdown 是一种轻量级标记语言,目标是实现「易读易写」。

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。 —— 维基百科


标题

Markdown 中,你只需要在文本前面加上 # 即可,同理、你还可以增加二级标题、三级标题、四级标题、五级标题和六级标题,总共六级,只需要增加 # 即可,标题字号相应降低。例如:

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

效果如下 :

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

引用

Markdown 标记区块引用是使用类似 email 中用的引用方式,只需要在整个段落的第一行最前面加上 > 。
例如:

>这是一个引用示例

效果如下:

这是一个引用示例

区块引用可以嵌套,只要根据层次加上不同数量的 > :

> 这是第一级引用。
>
> > 这是第二级引用。
>
> 现在回到第一级引用。

效果如下:

这是第一级引用。

这是第二级引用。

现在回到第一级引用。


列表

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

  1. 无序列表使用星号、加号或是减号作为列表标记:
*   Red
*   Green
*   Blue

等同于

+   Red
+   Green
+   Blue

也等同于

-   Red
-   Green
-   Blue

效果如下:

  • Red
  • Green
  • Blue

  1. 有序列表则使用数字接着一个英文句点:
1.  Bird
2.  McHale
3.  Parish

效果如下:

  1. Bird
  2. McHale
  3. Parish

如果你的列表标记写成:

1.  Bird
1.  McHale
1.  Parish

效果是:

  1. Bird
  2. McHale
  3. Parish

甚至是:

3. Bird
1. McHale
8. Parish

效果是:

  1. Bird
  2. McHale
  3. Parish

可以看到,数字还是正常的,所以,你可以让 Markdown 文件的列表数字和输出的结果相同,或是你懒一点,你可以完全不用在意数字的正确性。

如果要在列表项目内放进引用,那 > 就需要缩进:

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.

效果如下:

  • A list item with a blockquote:

    This is a blockquote
    inside a list item.


代码区块

只要把你的代码块包裹在 ``` 之间,你就不需要通过无休止的缩进来标记代码块了。 在围栏式代码块中,你可以指定一个可选的语言标识符,然后我们就可以为它启用语法着色了。 举个例子,这样可以为一段 Ruby 代码着色:

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

效果如下:

    require 'redcarpet'
    markdown = Redcarpet.new("Hello World!")
    puts markdown.to_html

强调

Markdown 中,可以使用 * 和 _ 来表示斜体和加粗。

斜体:

*Coding,让开发更简单*
_Coding,让开发更简单_

效果如下:

Coding,让开发更简单
Coding,让开发更简单

加粗:

**Coding,让开发更简单**
__Coding,让开发更简单__

效果如下:

Coding,让开发更简单
Coding,让开发更简单


代码

如果要标记一小段行内代码,你可以用反引号把它包起来 ```,例如:

Use the `printf()` function.

效果如下:

Use the printf() function.


自动链接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用尖括号包起来,Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:

<http://example.com/>

效果如下:

http://example.com/

链接

Markdown 支持两种形式的链接语法: 行内式参考式 两种形式。我个人比较喜欢用 参考式

不管是哪一种,链接文字都是用 [方括号] 来标记。

  1. 行内式 的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:
This is [an example](http://example.com/ "Title") inline link.

效果如下:

This is an example inline link.


图片

Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式参考式

  1. 行内式的图片语法看起来像是:
! [Alt text](/path/to/img.jpg)

! [Alt text](/path/to/img.jpg "Optional title")

详细叙述如下:

  • 一个惊叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 title 文字。

  1. 参考式的图片语法则长得像这样:
![Alt text][id]

id 是图片参考的名称,图片参考的定义方式则和连结参考一样:

[id]: url/to/image  "Optional title attribute"

Markdown 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的 <img> 标签。


LaTeX 公式

可以创建行内公式,例如 :

$\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

效果如下:

$\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

或者块级公式:

$$  x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

效果如下:

$$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$


表格

| Item      |    Value | Qty  |
| :-------- | --------:| :--: |
| Computer  | 1600 USD |  5   |
| Phone     |   12 USD |  12  |
| Pipe      |    1 USD | 234  |

效果如下:

Item Value Qty
Computer 1600 USD 5
Phone 12 USD 12
Pipe 1 USD 234

流程图

```flow </br>
st=>start: Start </br>
e=>end </br>
op=>operation: My Operation </br>
cond=>condition: Yes or No? </br>
st->op->cond </br>
cond(yes)->e </br>
cond(no)->op </br>
```

效果如下:

st=>start: Start
e=>end
op=>operation: My Operation
cond=>condition: Yes or No?

st->op->cond
cond(yes)->e
cond(no)->op

以及时序图:

```sequence </br>
Alice->Bob: Hello Bob, how are you? </br>
Note right of Bob: Bob thinks </br>
Bob-->Alice: I am good thanks! </br>
```

效果如下:

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

复选框

使用 - [ ]- [x] 语法可以创建复选框,实现 todo-list 等功能。例如:

- [x] 已完成事项
- [ ] 待办事项1
- [ ] 待办事项2

效果如下:

  • [x] 已完成事项
  • [ ] 待办事项1
  • [ ] 待办事项2

分割线

Markdown 中,可以制作分割线,例如:

    ---

效果如下:


反斜杠

Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 <em> 标签),你可以在星号的前面加上反斜杠:

\*literal asterisks\*

效果如下:

*literal asterisks*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容

  • 说明:本文原载于图灵社区网站,本次转载时为方便阅读,并修改个别用语。 Markdown: Syntax 概述 哲学...
    tonyzheng1阅读 770评论 0 49
  • 1. Markdown是什么 简单来讲,Markdown就是一种标记语言,简单方便。 最大的优点是,在如今各种强大...
    忧忧自恼阅读 760评论 0 0
  • Markdown 语法手册 (完整整理版) 原创 2016年09月15日 22:35:35 标签: markdow...
    安卓_背包客阅读 3,119评论 0 3
  • Markdown 语法说明 概述宗旨兼容 HTML特殊字符自动转换 区块元素段落和换行标题区块引用列表代码区块分隔...
    Clunt阅读 835评论 0 4
  • 上课总结:从机器语言(010101010)->汇编语言(add 1,2)有意义的英文单词--->结构化->面向对象...
    程序员有话说阅读 977评论 1 1