【序】最近想要为正在研发的框架写一篇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://img.haomeiwen.com/i1414656/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://img.haomeiwen.com/i1414656/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
斜体
加粗
斜体 与加粗并删除 的例子
删除线
- 一级
- 二级
- 三级
- 四级
- 三级
- 二级
- 一级
- 二级
- 三级
- 四级
- 三级
- 二级
[图片上传失败...(image-a36d05-1600702349964)]
引用如果
引用加斜体 粗体 斜体加粗体
三级引用
一行代码console.log(hellow world)
<div>这是一大块代码</div>
活动 | 支出 |
---|---|
吃饭 | 1000 |
唱歌 | 2000 |
文本引用
这段是引用文本
标签的用法
<center>样式居中</center>
复选框↓ 插件markdown All in One 提供快捷键ALT+c
能够快速切换
- 需求分析
- 系统设计
- 详细设计
- 编码
- 测试
- 交付
高级用法
==========================
表情
图片.png- 上标:30th
- 下标:H2O
- 脚注:Content [1]
*[HTML]: 超文本标记语言
*[W3C]: World Wide Web Consortium
The HTML specification
is maintained by the W3C.
==标记==
新增删除只有github支持
+ 新增
- 删除
-
Hi 这里是一个注脚,会自动拉到最后面排版 ↩
网友评论