Github Flavored Markdown 的增强部分

目的

总结对标准的Markdown语法增强部分

GFM

  1. 单词中的含有下划线时,GFM 会忽略,不转换成斜体

    示例:
    wow_great_stuff
    若将字符串中的某个单词变成斜体,则可以使用*
    wow*great*stuff

    效果:
    wow_great_stuff
    wowgreatstuff

  2. 自动识别URL连接
    示例:
    http://example.com
    效果:
    http://example.com

  3. 删除线
    示例:
    ~~Mistaken text.~~
    效果:
    Mistaken text.

  4. 代码段每行使用4个空格,标准MD会自动识别为代码段,GFM也支持这样的语法
    同时GFM还设计了一种优化语法,就是在代码段头尾行使用 `
    还支持语言标识

    示例:

          ```javascript
          function test() {
          console.log("notice the blank line before this function?");
          }
          ```
    

    效果:

      function test() {
        console.log("notice the blank line before this function?");
      }
    
  5. Task列表

    GFM 支持把列表变成带勾选的任务列表

    • 基本列表

    示例:

    - [ ] a task list item
    - [ ] list syntax required
    - [ ] normal **formatting**, @mentions, #1234 refs
    - [ ] incomplete
    - [x] commplete
    

    效果:

    示例1.png

    • 嵌套列表

    示例2:

     - [ ] a bigger project
       - [ ] first subtask #1234
       - [ ] follow up subtask #4321
       - [ ] final subtask cc @mention
     - [ ] a separate task
    

    效果:


    示例2.png
  6. 添加表情

    GFM支持天假emoji表情,输入不同的符号码表示不同的表情

    示例:

    :blush:
    :joy:
    :grinning:
    

    效果:

表情.png
  1. 支持表格

基本:

示例:
First Header | Second Header -------------|-------------- Content Cell | Content Cell Content Cell | Content Cell
效果:

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell
可以在两边都加竖线:

示例:
| First Header | Second Header | | ------------- | ------------- | | Content Cell | Content Cell | | Content Cell | Content Cell |
效果:

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell
可以不对齐:

示例:

```
| Name | Description          | 
| ------------- | ----------- |  
| Help      | ~~Display the~~ help window.|   
| Close     | _Closes_ a window     |   
```

效果:
Name Description
Help Display the help window.
Close Closes a window
可以定义表格中文字对齐方式:

示例:
| Left-Aligned | Center Aligned | Right Aligned | | :------------ |:---------------:| -----:| | col 3 is | some wordy text | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 |

效果:  
Left-Aligned Center Aligned Right Aligned
col 3 is some wordy text $1600
col 2 is centered $12
zebra stripes are neat $1
支持在表格中嵌入图片

示例:
| 图片|描述| | ------------ |---------------| | http://img4.duitang.com/uploads/item/201508/19/20150819131018_vYPyR.thumb.224_0.png | Overload 森林贤王——仓助 |

效果:  
图片 描述
仓助
仓助
Overload 森林贤王——仓助

参考1: https://help.github.com/articles/writing-on-github/
参考2 : https://help.github.com/articles/github-flavored-markdown/

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

推荐阅读更多精彩内容