markdown.md

markdown语法总结

注：本总结针对github中markdown的语法。

图片

插入图片的语法为

![title](url "description")

可以先在git仓库中新建文件夹，然后将图片放到该文件夹中。如

![test](https://raw2.github.com/hqjma/docs/master/img/identicon.png "desc")

显示结果是

![test](https://raw2.github.com/hqjma/docs/master/img/identicon.png "desc")

表格

插入表格的语法为

head1	head2	head3

t1  |  t2   |   t3
t4  |  t5   |   t6

注意表格上下均有空行

    歌曲名  |  歌手
 ----------|--------
  人来人往 | 陈奕迅
   矜持    | 王菲
   最爱    | 张国荣
   有心人  | 张国荣

在github中的显示为

歌曲名	歌手
人来人往	陈奕迅
矜持	王菲
最爱	张国荣
有心人	张国荣

代码

在github中有3种方式表示代码

• 4个空格或者1个tab表示代码块

    int main() {
        print("hello world");           
    }
  

  注意在一级列表中，代码块前面需要8个空格，在二级列表中，代码块前面需要12个空格，依此类推。

• ` `表示代码片断

    `print("hello world")`
  

  在github显示为 print("hello world")

• ```表示加强型的代码块

    ```ruby
    print "hello world"
    ```
  

  在github的显示是

pint "hello world"

缩进

在markdown中，如果有层次关系，对于 列表， n级层次在n-1级的基础上前面至少多 n-1 个空格，则有层次关系。

• list
• list
  • list

在github中表示如下：

- list
 - list
   - list

而如果列表下有文本，希望文本和列表对齐，则文本每次以 4 个空格的方式缩进。

空格

这部分其实是HTML的内容，但有时候可能需要展示文件的组织结构。

•  ，不断行的空白，一个字符宽度
•  ，半个空白，一个字符宽度
•  ，一个空白，两个字符宽度
•  ，窄空白，小于一个字符宽度

如下：

.
|---- Capfile
|---- config
|   |---- deploy
|   |   |---- production.rb
|   |    `---- staging.rb
|   `---- deploy.rb
`---- lib
   `---- capistrano
      `---- tasks

注：空白处为 

文本

如表格：

语法	效果
*斜体*、_斜体_	斜体，前者可表示一个字中的部分内容加斜体
**粗体**、__粗体__	粗体，前者可表示一个字中的部分内容加粗体
***斜粗体***、___斜粗体___	斜粗体
~~中划线~~	中划线
***~~斜粗体删除线~~***、~~***斜粗体删除线***~~	斜粗体删除线

Reference

• GitHub Flavored Markdown
• GitHub 风格的 Markdown 语法
• Markdown语法说明