1. 首先安装vscode工具,下载地址如下: https://code.visualstudio.com/

  2. 在vs code的扩展中安装: Markdown Preview Enhanced 这款插件,安装完成重新加载即可生效

  3. 新建一个.md文件

    Visual Studio Code 原生就支持高亮Markdown的语法,想要一边编辑一遍预览,有两种方法:

    3.1. Ctrl + Shift + P 调出主命令框,输入 Markdown,应该会匹配到几项 Markdown相关命令

    2.2. 先按Ctrl + K,然后放掉,紧接着再按 v,也能调出实时预览框。【要在英文输入状态下】

    3.3 直接点击快捷图标





    还可以在预览效果的界面中右键鼠标选择在不同平台预览,如可以在浏览器中预览



    其中默认打开的浏览器是IE浏览器,可以直接Copy浏览器地址使用Chrome浏览器打开



    可以发现在浏览器中预览markdown文档已经被编译成HTML文档了。

------------------------------------------------------------附录Markdown语法------------------------------------------------------------------------------

vs code 使用 Markdown 编写文档

1. 直接使用 HTML 标签,可以设置文字居中,字体颜色等样色(HTML 语法)

代码:
<div align="center" style="color:red">VS Code 使用 Markdown 编写文档</div>

演示:

2. 标题

注:# 后面保持空格(和使用 h1/h2 标签功能类似)
代码:
# h1
## h2

演示:

3. TOC(根据标题生成目录)

代码:



演示:

4. 引用

代码1(单行式):
> hello world!

演示:

代码2(多行式):
> hello world! 输入完之后按两次空格键再按一次Enter键即可
> hello world! 输入完之后按两次空格键再按一次Enter键即可
> hello world! 输入完之后按两次空格键再按一次Enter键即可

演示:

代码3(多层嵌套):
> aaaaaaaaa
>> bbbbbbbbb
>>> cccccccccc

演示:

5. 行内标记(用 ` 标记代码块将变成一行)

代码:标记之外`hello world`标记之外

演示:

6. 代码块

1. 用```代码```进行包裹
代码:
```
<div>
<div></div>
<div></div>
<div></div>
</div>
```

演示:

2. 自定义语法(根据不同的语言配置不同的代码着色)
代码:
```javascript
var num = 0;
for (var i = 0; i < 5; i++) {
num+=i;
}
console.log(num);
```

演示:

7. 插入链接(待定。。。)

代码:
[百度 1](http://www.baidu.com/ '百度一下')

演示:

8. 插入图片

代码:
![](./01.jpg '描述')

8. 插入图片带有链接

代码:
[![](.//img/01.png '百度')](http://www.baidu.com)

9. 插入视频

注:Markdown 语法是不支持直接插入视频的
普遍的做法是 插入 HTML 的 iframe 框架,通过网站自带的分享功能获取,如果没有可以尝试第二种方法
第二是伪造播放界面,实质是插入视频图片,然后通过点击跳转到相关页面 代码:
<iframe height=498 width=510 src='http://player.youku.com/embed/XMjgzNzM0NTYxNg==' frameborder=0 'allowfullscreen'></iframe>

演示:

10. 序列

代码1(有序):
1. one
2. two
3. three

演示:

代码2(无序):
* one
* two
* three

演示:

代码3(序表嵌套):
1. one
1. one-1
2. two-2
2. two
* two-1
* two-2

演示:

代码4(序表嵌套代码块)
注:换行+两个Tab * one var a = 10; // 与上行保持空行并 递进缩进

演示:

11. 任务列表(类似于多选框)

代码:
- [ ] 选项一
- [x] 选项二

演示:

12. 表情(待定。。。。)

13. 表格

注: : 代表对齐方式
代码1:
| a | b | c |
|:--:|:-- | --:| #这句代码只能写在第二行
| 居中 | 左对齐 | 右对齐 |
代码2(简约写法):
a | b | c
:---:|:------------ |--:
居中 | 左对齐 | 右对齐
代码3(特殊表格):使用HTML代码

演示:

14. 支持内嵌CSS样式

代码:<p style="color: #AD5D0F;font-size: 30px; font-family: '宋体';">内联样式</p>

演示:

15. 语义标记

代码:
*斜体*、_斜体_
**加粗**
***加粗+斜体***、**_加粗+斜体_**
~~删除线~~
==背景色==
$\underline{下划线}$
Superscript - superscript
^superscript^
Subscript - subscript
~subscript~

演示:

16. 语义标签

    代码:
<i>斜体</i>
<b>加粗</b>
<em>强调</em>
<u>下划线</u>
<del>删除</del>
Z<sup>a</sup>
Z<sub>a</sub>
<kbd>Ctrl</kbd>

演示:

17. 公式

    代码:
$$ x \href{why-equal.html}{=} y^2 + 1 $$
$ x = {-b \pm \sqrt{b^2-4ac} \over 2a}. $

演示:

18. 分隔符

    代码: ---  或者  ***

演示:

19. 脚注

    代码:
Markdown[^1]
[^1]: Markdown是一种纯文本标记语言 // 在文章最后面显示脚注

演示:

20. 锚点

    代码:
[公式标题锚点](#1) #### [任务列表(类似于多选框)] {#1} // 方括号后保持空格

演示:

代码部分:





连接部分:



点击点击跳到指定的标题:

21. 定义型列表

    注:解释型定义
代码:
Markdown
: 轻量级文本标记语言,可以转换成html,pdf等格式 // 开头一个`:` + `Tab` 或 四个空格

演示:

24.自动邮箱链接

    代码:
<xxx@outlook.com>

演示:

25. 流程图

代码:
```
graph LR
A-->B
``` ```
sequenceDiagram
A->>B: How are you?
B->>A: Great!
``` ```
gantt
dateFormat YYYY-MM-DD
section S1
T1: 2014-01-01, 9d
section S2
T2: 2014-01-11, 9d
section S3
T3: 2014-01-02, 9d
```

演示:

26. 时序图

代码:
```sequence
A->>B: 你好
Note left of A: 我在左边
Note right of B: 我在右边
B-->A: 很高兴认识你
``` ```sequence
起床->吃饭: 稀饭油条
吃饭->上班: 不要迟到了
上班->午餐: 吃撑了
上班->下班:
Note right of 下班: 下班了
下班->回家:
Note right of 回家: 到家了
回家-->>起床:
Note left of 起床: 新的一天
```

演示:



语法原文: https://www.jianshu.com/p/b03a8d7b1719

使用vs code编写Markdown文档以及markdown语法详解的更多相关文章

  1. 一个完整的WSDL文档及各标签详解

    <?xml version="1.0" encoding="UTF8" ?> <wsdl:definitions targetNamespac ...

  2. elasticsearch系列三:索引详解(分词器、文档管理、路由详解(集群))

    一.分词器 1. 认识分词器  1.1 Analyzer   分析器 在ES中一个Analyzer 由下面三种组件组合而成: character filter :字符过滤器,对文本进行字符过滤处理,如 ...

  3. MongoDB开发深入之一:文档数据关系模型详解(一对多,多对多)

    文档关联模型通常有3种方式: 嵌入式(一对一.一对多) 后期手动统一ID处理(一对多.多对多) References引用(一对一.一对多) 文档树模型通常有3种方式: 父引用(Parent Refer ...

  4. 文档学习 - UILabel - 属性详解

    #import "ViewController.h" @implementation ViewController - (void)viewDidLoad { [super vie ...

  5. VS Code 搭建合适的 markdown 文档编写环境

    写在开头,之前我是使用Gitee与Github作为图床和Picgo搭配Typora使用的 ,但因为最近觉得这样还是稍微比较繁琐,然后因为VS Code是我的主要文本编辑器.Cpp,Python等均是在 ...

  6. 使用 VS Code + Markdown 编写 PDF 文档

    背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如 ...

  7. vscode使用Markdown文档编写

    首先安装vscode工具,具体的使用可以参考之前的博文:<Visual Studio Code教程:基础使用和自定义设置> VScode已经默认集成markdown文档编辑插件.可以新建一 ...

  8. 基于 Markdown 编写接口文档

    最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而 ...

  9. 使用 VS Code 撰写 Markdown 文档

    众所周知, VS Code 是微软和社区一起开发的一款很优秀的高级代码编辑器.它不仅可以写出一手好代码,还能写出一篇好文章.利用 Markdown 就可以写出一篇排版美观的技术文章了. 而 Markd ...

随机推荐

  1. SAP系统邮件功能配置

    相信SAP顾问或多或少都会接到用户要求SAP系统能够定时发送邮件的功能,定时将用户需要的信息已邮件的方式发送给固定的人员. 下面就来讲一下SAP发送邮件应该如何配置: 1.RZ10做配置: is/SM ...

  2. Cesium专栏-空间分析之剖面分析(附源码下载)

    Cesium Cesium 是一款面向三维地球和地图的,世界级的JavaScript开源产品.它提供了基于JavaScript语言的开发包,方便用户快速搭建一款零插件的虚拟地球Web应用,并在性能,精 ...

  3. iOS---------审核被拒(隔壁群发的)

    Hello, We are writing to let you know the results of your appeal for your app The App Review Board e ...

  4. 【JDBC】CRUD操作

    JDBC的CRUD操作 向数据库中保存记录 修改数据库中的记录 删除数据库中的记录 查询数据库中的记录 保存代码的实现 package demo1; import java.sql.Connectio ...

  5. 用函数模拟简单的购物车(Python)

    """ 购物车功能: a.引导用户输入金额 b.给用户展示所有的商品 c.引导用户输入需要进行的操作[添加 删除 结算购物车 退出] d.引导用户选择商品 e.引导用户输 ...

  6. 读书笔记_python网络编程3(5)

    5. 网络数据与网络错误 应该如何准备需要传输的数据? 应该如何对数据进行编码与格式化? Py程序需要提供哪些类型的错误? 5.1. 字节与字符串 PC与网卡都支持将字节作为通用传输单元.字节将8比特 ...

  7. Xposed优缺点和入门

    Xposed框架的原理是替换安卓系统/System/bin目录下的文件,从而实现对系统某些功能的替换,进而给予基于 Xposed 框架开发的App更多权限. 优点:1.功能强大2.执行效率快缺点:1. ...

  8. python之爬取练习

    练习要求爬取http://yuedu.anyv.net/网址的最大页码数和文章标题和链接 网址页面截图: 代码截图: 完整代码: 根据网页显示页码的方式,爬取的所有页码中倒数第二个页码是最大页码. i ...

  9. Python程序中的进程操作-进程同步(multiprocess.Lock)

    目录 一.多进程抢占输出资源 二.使用锁维护执行顺序 三.多进程同时抢购余票 四.使用锁来保证数据安全 通过刚刚的学习,我们千方百计实现了程序的异步,让多个任务可以同时在几个进程中并发处理,他们之间的 ...

  10. web自动化针对PO模式进行二次封装之basepage

    在PO模式当中,我们做到了页面对象与测试用例的分离,但在页面对象编写时,我们仍然还有优化的空间.页面对象有一些共同的基本操作,可以封装起来,并可以在基本操作当中加上日志和异常截图的处理.比如说我们在查 ...