标记语言Markdown使用说明

markdown_logo.jpg

Markdown是什么

Markdown是一种网络书写语言,兼容HTML但比HTML简单,
没有很多标签或者格式指令,可以直接以纯文本形式书写或者发布。
Markdown精挑细选了一些语法,其宗旨是易读易写。

可以体验一下在线的Markdown编辑器,如mahua在线Markdown

基础语法

基础语法指官方版本Markdown支持的语法,GFM(Github Flavored Markdown)是github对Markdown语法的一些扩展。

1. 标题

开头的最后一个#与标题之间必须有空格。
header.png

文字格式

符号与文字之间不能有空格。
引用’>’后的空格不能少, 引用行之后要空一行,否则之后的行都算是引用了。

1
2
3
4
5
6
7
8
9
10
11
12
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_
> This is quote
>> This is quote's quote
~~This is strikethrough,only for GFM.~~

效果:
This text will be italic
This will also be italic

This text will be bold
This will also be bold

You can combine them

This is quote

This is quote’s quote

This is strikethrough,only for GFM.

列表 List

1. 无序列表 Unordered List

* + -之后的空格不能少。
对嵌套列表,符号之后和之前的空格都不能少。

1
2
3
4
5
* One
+ Two
- Two Point One
* Two Point Two
- Three

效果:

  • One
  • Two
    • Two Point One
    • Two Point Two
  • Three

    有序列表 Ordered List

    .后的空格不能少。
    1
    2
    3
    4
    5
    1. One
    2. Two
    1. Two Point One
    2. Two Point Two
    9. Three
  1. One
  2. Two
    • Two Point One
    • Two Point Two
  3. Three

文字链接

" "里的内容可省略。

1
2
http://wuchenxu.github.io -automatic!
[blog](http://wuchenxu.github.io "chenxu's blog")

http://wuchenxu.github.io -automatic!
blog

图片链接

设置大小对齐,需要使用HTML, " "可以省略。

1
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png "Yaktocat")

Image of Yaktocat

图片嵌入超链接

1
[![](http://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Mark.png)](http://www.github.com "link to github")

索引链接

^1 ^2可以是任意字符。

1
2
3
4
5
[blog][^1]
![GitHub Octocat][^2]
[^1]: http://wuchenxu.github.io
[^2]: http://github.global.ssl.fastly.net/images/modules/logos_page/Octocat.png

blog
GitHub Octocat

脚标

^ref可以是任意字符。

1
2
Ref[^ref]
[^ref]: your-link

Ref^ref

代码 Code

`code`

code

```
if (isOK)
{
return true;
}
```

1
2
3
4
if (isOK)
{
return true;
}

页内链接Anchor

markdown目录

1
2
3
4
1.标题
# format output
2.引用标题
[上一节](#format-output)

html标签

1
2
3
4
1. 先定义一个锚(id)
<span id="jump">Hello World</span>
2. 然后使用markdown的语法
[XXXX](#jump)

分割线

三个或者更过的-或者*,必须单独成行,可以有空格

1
2
3
- - -
hello
* * *


hello


GFM语法

GFM(Github Flavored Markdown)是github对Markdown语法的一些扩展,官方版本的Markdown不支持以下语法。

表格 Table

官方版本的Markdown语法是不支持表格的,由于兼容HTML,可以使用<table>标签来表示table。但是,有一些Markdown的语法扩展支持简单的表格(Simple Table)。
Markdown Here,Github支持简单表格,推荐使用table generator来生成表格。
GFM的语法很简单,不支持行或者列的合并,不支持一个单元格的多行文字。
第一行是标题,第二行是固定的-,冒号:是来表示对齐方式。
表格前或后必须有空行.

1
2
3
4
5
| Tables | Are | Cool |
|----------|:-------------:|------:|
| col 1 is | left-aligned | $1600 |
| col 2 is | centered | $12 |
| col 3 is | right-aligned | $1 |

效果:

Tables Are Cool
col 1 is left-aligned $1600
col 2 is centered $12
col 3 is right-aligned $1

语法高亮 Syntax Highlighting

```javascript
function fancyAlert(arg) {
if(arg) {
$.facebox({div:’#foo’})
}
}
```

1
2
3
4
5
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}

任务列表 Task List

1
2
3
4
- [x] This is a complete item
- [x] task 1
- [x] task 2
- [ ] This is an incomplete item
  • [x] This is a complete item
    • [x] task 1
    • [x] task 2
  • [ ] This is an incomplete item

表情 Emoji

体验一下2015牛津年度英语单词 笑cry

1
:joy:

:joy:

进阶

科技写作用Markdown+R 可以生成各种公式图片图表。

Reference:

  1. 翻译markdown 语法说明
  2. table generator
  3. official markdown
  4. mahua在线Markdown
  5. Github Flavored Markdown
  6. Emoji Cheat Sheet
  7. anchors