学习markdown语法时,在官网和其他博客上看到很多的用法和注意点。这里记录下markdown官方支持的用法和常用的扩展语法。有写法介绍,不同的语句实现,及效果等等。除了官方的兼容性较好一点外,不同的公司或网站对markdown做了很多的扩展,但是相互兼容性并不好。目前还没有形成统一规范。不过GitHub好像在做规范markdown的事情。
[TOC]
标题
setext标题
支持两级分级标题,一级标记至少三个等号,二级至少三个减号
一级标题
===
二级标题
---
atx标题
标题最多支持6个等级,字体尺寸依次减小:
#一级标题
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题
#一级标题#
##二级标题##
###三级标题###
####四级标题####
#####五级标题#####
######六级标题######
引用
标准写法
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.
简约写法
> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
嵌套写法
> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.
或
> ## This is a header.
>
> 1. This is the first list item.
> 2. This is the second list item.
>
> Here's some example code:
>
> return shell_exec("echo $input | $markdown_script");
列表
列表支持两种方式,序号列表和无序号列表。
无序号列表
无序号列表有三种写法
* Red
* Green
* Blue
+ Red
+ Green
+ Blue
- Red
- Green
- Blue
有序号列表
有序号列表的写法
1. Bird
2. McHale
3. Parish
1. Bird
1. McHale
1. Parish
3. Bird
1. McHale
8. Parish
代码块
以下示例实际使用时,不包括每行最左侧的数字,此处为了为了让源码正常显示
1 ```python
2 def hello()
3 print "hello"
4 ```
效果:
def hello()
print "hello"
标尺线(水平线、分界线)
* * *
***
*****
- - -
---------------------------------------
超链接
写法一
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
写法二
This is [an example][id] reference-style link.
[id]: http://example.com/ "Optional Title Here"
链接同web服务下资源的写法
See my [About](/about/) page for details.
更多写法
// 以下三种写法一样效果,但单引号方式在markdown v1.0.1版本中有bug
[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)
// 链接可以用尖括号括起来
[id]: <http://example.com/> "Optional Title Here"
// 长链接时可以把title写到下一行,下一行顶头tab或4个空格
[id]: http://example.com/longish/path/to/resource/here
"Optional Title Here"
斜体字和加粗
描述 | 代码 | 效果 |
---|---|---|
斜体 | *效果* | 效果 |
斜体 | _效果_ | 效果 |
加粗 | **效果** | 效果 |
加粗+斜体 | ***效果*** | 效果 |
加粗+斜体 | **_效果_** | 效果 |
删除线 | ~~效果~~ |
代码段
文本中含有代码时
Use the `printf()` function.
效果:
Use the printf()
function.
文本中含有反单引号时
A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``
效果:
A single backtick in a code span: `
A backtick-delimited string in a code span: `foo`
图片
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")
或
![Alt text][id]
[id]: url/to/image "Optional title attribute"
效果:
插入视频
原生markdown不支持此功能
<iframe height=498 width=510 src='http://player.youku.com/embed/XMjgzNzM0NTYxNg==' frameborder=0 'allowfullscreen'></iframe>
选项列表
- [x] option 1
- [ ] option 2
- [ ] option 3
效果:
- [x] option 1
- [ ] option 2
- [ ] option 3
表格
标准写法
| a | b | c |
|:-------:|:------------- | ----------:|
| 居中 | 左对齐 | 右对齐 |
|=========|===============|============|
简单写法
a|b|c
:-:|:- |-:
居中|左对齐|右对齐
=========|+++++++++|-------
效果:
a | b | c |
---|---|---|
居中 | 左对齐 | 右对齐 |
========= | +++++++++ | ------- |
脚注
脚注[^008],脚注在本页面最底部
[^008]: 这里是脚注测试
效果:
脚注[1],脚注在本页面最底部
解释型定义
冒号后跟tab或四个空格
hello
: hello
效果:
hello
: hello
数学公式
$$ y=x^2+a $$
$$ z={-a \pm \sqrt{x^2-4by} \over c} $$
效果:
css支持
<p style="color: #b5b5b5; font-size: 24px; font-family: '楷体';">内联样式</p>
效果:
<p style="color: #757575; font-size: 24px; font-family: '楷体';">内联样式</p>
邮箱
<xxx@gmail.com>
效果:
反斜线转义
markdown支持以下符号进行转义
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark
-
这里是脚注测试 ↩