markdown语法

【序】最近想要为正在研发的框架写一篇readme.md文档,后面放到github上由github的markdown语法去解析,但是平时都是在简书上使用一些比较常用的语法,与github上的markdown的语法又有不同之处,vscode上写出来的markdown又有哪些语法能够运行在github上呢?我们总结了一个测试markdown的代码,来分析哪些语法可以用,语法分为基础部分与高级功能,基础部分基本上各家markdown语法引擎都兼容,而高级部分就不一定了,甚至有的简书都不支持,就让我们一下来看一下这部分测试代码吧。

经过测试,绝大部分功能简书都能够兼容,除了注解与锚点部分不能跳转,其它的都正常显示

在vscode中写markdown时推荐两个较好用插件

比较好的插件介绍:

  • Markdown Preview Enhanced //以下语法都需要使用插件,否则有的功能,比如注解就会显示错误
  • markdown+Math //用于写latex公式

注意:为了不让简书解析代码块中的```,故在之前添加了/符号,使用时注意去掉

#markdown语法大全
> 因为不同的渲染引擎有不同的语法支持,所以在一个新的引擎写markdown的时候,就需要知道支持哪些语法,创作时尽量兼容不同的语法,因此分为效果本分和测试码部分,测试码分为初级和高级,也包括vscode插件介绍,基础部分的用法是参考github的渲染引擎。
##效果部分
基础用法
===
# 一级title
## 二级title
### 三级title
#### 四级title
##### 五级title

一级title 
===
二级title
---

*斜体*

**加粗**

*斜体 **与加粗~~并删除~~** 的例子*

~~删除线~~



***

* 一级
  * 二级
    * 三级
      * 四级

1. 一级
   1. 二级
      1. 三级
         1. 四级

[图片上传失败...(image-8d9e1-1600702437163)]

[地址](http://www.baidu.com)

> 引用如果  
>> 引用加*斜体* **粗体** _斜体加**粗体**_
>>> 三级引用


一行代码`console.log(hellow world)`

/```html
<div>这是一大块代码</div>
/```

| 活动 | 支出 |
| ---- | ---- |
| 吃饭 | 1000 |
| 唱歌 | 2000 |

文本引用

    这段是引用文本
        
        


#标签的用法
<center>样式居中</center>

[锚点(每个title都可以当锚点)](#一级title)

**复选框↓** 插件markdown All in One 提供快捷键`ALT+c`能够快速切换
* [x] 需求分析
* [x] 系统设计
* [x] 详细设计
* [ ] 编码
* [ ] 测试
* [ ] 交付
高级用法
==========================
---
###表情
[图片上传失败...(image-a776ee-1600702349964)]
![emoji map](https://upload-images.jianshu.io/upload_images/1414656-b1f92b959dfa863e.png?imageMogr2/auto-orient/strip|imageView2/2/w/301/format/webp)

[更多的emoji](https://www.webfx.com/tools/emoji-cheat-sheet/)
[github支持表情](http://www.emoji-cheat-sheet.com)


- 上标:30^th^
- 下标:H~2~O
- 脚注:Content [^1]
[^1]:Hi 这里是一个注脚,会自动拉到最后面排版

*[HTML]: 超文本标记语言  
*[W3C]:  World Wide Web Consortium
The HTML specification
is maintained by the W3C.
---

### 比较好的插件介绍:
* Markdown Preview Enhanced //以上语法都需要使用插件
* markdown+Math //用于写latex公式

==标记== 

/```
新增删除只有github支持
+ 新增
- 删除
/```


##测试码部分

/```

基础用法
===
# 一级title
## 二级title
### 三级title
#### 四级title
##### 五级title

一级title 
===
二级title
---

*斜体*

**加粗**

*斜体 **与加粗~~并删除~~** 的例子*

~~删除线~~



***

* 一级
  * 二级
    * 三级
      * 四级

1. 一级
   1. 二级
      1. 三级
         1. 四级

![图片](https://www.baidu.com/link?url=Yeq-US6xYsva9_bHeAbzKU7d3GHGtnBTYUPbBGhFbha35AlaRFLdNooT3dbgVdW_iZR3QcPHpzJ165ULDlEokQZo53lFKp1pdsaWijpAr1u&wd=&eqid=ee2b533400007968000000035f671c0b)

[地址](http://www.baidu.com)

> 引用如果  
>> 引用加*斜体* **粗体** _斜体加**粗体**_
>>> 三级引用


一行代码`console.log(hellow world)`

\```html
<div>这是一大块代码</div>
/```

| 活动 | 支出 |
| ---- | ---- |
| 吃饭 | 1000 |
| 唱歌 | 2000 |

文本引用

    这段是引用文本
        
        


#标签的用法
<center>样式居中</center>

[锚点(每个title都可以当锚点)](#一级title)

**复选框↓** 插件markdown All in One 提供快捷键`ALT+c`能够快速切换
* [x] 需求分析
* [x] 系统设计
* [x] 详细设计
* [ ] 编码
* [ ] 测试
* [ ] 交付
高级用法
==========================
---
表情
---
![Emoji](src/assets/markdown/Pasted%20Graphic.png)
![emoji map](https://upload-images.jianshu.io/upload_images/1414656-b1f92b959dfa863e.png?imageMogr2/auto-orient/strip|imageView2/2/w/301/format/webp)

[更多的emoji](https://www.webfx.com/tools/emoji-cheat-sheet/)
[github支持表情](http://www.emoji-cheat-sheet.com)


- 上标:30^th^
- 下标:H~2~O
- 脚注:Content [^1]
[^1]:Hi 这里是一个注脚,会自动拉到最后面排版

*[HTML]: 超文本标记语言  
*[W3C]:  World Wide Web Consortium
The HTML specification
is maintained by the W3C.
---

### 比较好的插件介绍:
* Markdown Preview Enhanced //以上语法都需要使用插件
* markdown+Math //用于写latex公式

==标记== 

\```
新增删除只有github支持
+ 新增
- 删除
/```

下面是简书的显示部分

markdown语法大全

因为不同的渲染引擎有不同的语法支持,所以在一个新的引擎写markdown的时候,就需要知道支持哪些语法,创作时尽量兼容不同的语法,因此分为效果本分和测试码部分,测试码分为初级和高级,也包括vscode插件介绍,基础部分的用法是参考github的渲染引擎。

效果部分

基础用法

一级title

二级title

三级title

四级title

五级title

一级title

二级title

斜体

加粗

斜体 与加粗并删除 的例子

删除线


  • 一级
    • 二级
      • 三级
        • 四级
  1. 一级
    1. 二级
      1. 三级
        1. 四级

[图片上传失败...(image-a36d05-1600702349964)]

地址

引用如果

引用加斜体 粗体 斜体加粗体

三级引用

一行代码console.log(hellow world)

<div>这是一大块代码</div>
活动 支出
吃饭 1000
唱歌 2000

文本引用

这段是引用文本

标签的用法

<center>样式居中</center>

锚点(每个title都可以当锚点)

复选框↓ 插件markdown All in One 提供快捷键ALT+c能够快速切换

  • 需求分析
  • 系统设计
  • 详细设计
  • 编码
  • 测试
  • 交付
    高级用法
    ==========================

表情

图片.png

更多的emoji
github支持表情

  • 上标:30th
  • 下标:H2O
  • 脚注:Content [1]

*[HTML]: 超文本标记语言
*[W3C]: World Wide Web Consortium
The HTML specification
is maintained by the W3C.


==标记==

新增删除只有github支持
+ 新增
- 删除

  1. Hi 这里是一个注脚,会自动拉到最后面排版

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