目录

前言

因为著名的2/8原则,这里只列出最常见的一些用法,特殊的用法、不常用的用法、炫酷的效果、语法糖等可以通过搜索引擎得到想要的答案,毕竟动手的知识掌握得更加深刻。

markdown简介

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面,Markdown文件的后缀名便是“.md”

用法列表

  • 标题
  • 字符效果和横线
  • 引用
  • 锚点与链接
  • 代码高亮
  • 图片
  • 有序列表&无序列表
  • 表格
  • 特殊符号处理

标题

标题的语法很简单:#号加上空格后面接标题名称

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

实际效果:

字符效果和横线

只用记住最简单的*号个数就行了,使用下划线_能达到同样的效果

 *斜体*  或者  _斜体_
**加粗** 或者 __加粗__
***斜体加粗*** 或者 ___斜体加粗___
~~删除~~

实际效果:

一条横线:  ----------

实际效果:


换行:

<br/>

实际效果:会换行空出一行

引用

  >引用内容会自动缩进

  >引用的嵌套
>>嵌套引用

实际效果:

锚点与链接

链接:

链接:
[普通链接](https://www.mdeditor.com/)
[普通链接带标题](https://www.mdeditor.com/ "普通链接带标题")
直接链接:<https://www.mdeditor.com>

实际效果:

锚点:

用html的语法
在指定位置定义了一个:<a name="divtop"></a>
我们跳转过去:[跳转指定位置](#divtop)
这种用法不一定有用

代码高亮

单行代码:`npm install marked`

实际效果:

单行代码:npm install marked

多行代码:用```三个反引号前后包裹代码,

如果要语法高亮就在```后面加小写语言名,eg:html,css,javascript,python,cs(csharp)等等

```

    fun (x: Int, y: Int): Int {
return x + y;
}

```

实际效果:

    fun (x: Int, y: Int): Int {
return x + y;
}

图片

图片的语法和链接类似,只是在前面加上了!感叹号

  ![图片标题](d:\images\a.png)
![图片标题](d:\images\a.png "为所欲为")

实际效果:

有序列表&无序列表

无序列表:* - + 效果一致

* 列表项1
* 列表项2 - 列表项1
- 列表项2 + 列表项1
+ 列表项2

实际效果:

  • 列表项1
  • 列表项2

嵌套的无序列表:

+ 列表一
+ 列表二
+ 列表二-1
+ 列表二-2
+ 列表二-3
+ 列表三
* 列表一
* 列表二
* 列表三

实际效果:

  • 列表一
  • 列表二
    • 列表二-1
    • 列表二-2
    • 列表二-3
  • 列表三
    • 列表一
    • 列表二
    • 列表三

有序列表:会从你输入的最小数字开始自动增加排序

1. 列表项1
2. 列表项2

实际效果:

  1. 列表项1
  2. 列表项2

表格

表格语法比较复杂,建议直接复制粘贴拿来用就行

|xxx|xxx|
|---|---|
|xxx|xxx|

实际效果:

xxx xxx
xxx xxx

特殊符号与颜色处理

Markdown使用反斜杠\插入语法中用到的特殊符号,不转义将导致内容显示不全,甚至排版混乱,要有以下几种特殊符号需要处理:

\   反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号

使用方法:如果要显示反斜线,输入两个\\即可

字体加颜色:

红色:<font color='#ff0000'>红色</font>
其他颜色类似

实际效果:

红色

ps:其他的效果,例如check List,html特殊字符,科学公式,流程图,时序图等不作为基础语法,需要的时候再去查就OK了~

markdown进阶技巧

如果你只是想试试markdown语法的实际效果,用在线编辑markdown的网站就可以实时查看效果:markdown在线编辑

如果想用markdown作为写作的便捷语法(尤其是作家、程序员等),强烈推荐使用宇宙第一IDE Vitual Studio Code作为写markdwon文档的工具,毕竟IDE能够提高生产力,配合下载vscode的插件markdown-all-in-one

能够所见即所得(如果vscode插件不能实时搜索到,请参考这篇文章离线安装插件:vscode离线安装插件方法)

vscode写markdown有一些代码提示,快捷键等,不展开详细讲,感兴趣可以自己去搜索;

markdown插件有一个生成和更新目录的功能:

按F1,然后输入 ctoc,能生成目录;

按F1,输入 utoc 就会更新目录,更新过一次后,你以后Ctrl+S就会自动更新目录

参考文章

Marrkdown基础用法的更多相关文章

  1. PropertyGrid控件由浅入深(二):基础用法

    目录 PropertyGrid控件由浅入深(一):文章大纲 PropertyGrid控件由浅入深(二):基础用法 控件的外观构成 控件的外观构成如下图所示: PropertyGrid控件包含以下几个要 ...

  2. logstash安装与基础用法

    若是搭建elk,建议先安装好elasticsearch 来自官网,版本为2.3 wget -c https://download.elastic.co/logstash/logstash/packag ...

  3. elasticsearch安装与基础用法

    来自官网,版本为2.3 注意elasticsearch依赖jdk,2.3依赖jdk7 下载rpm包并安装 wget -c https://download.elastic.co/elasticsear ...

  4. BigDecimal最基础用法

    BigDecimal最基础用法 用字符串生成的BigDecimal是不会丢精度的. 简单除法. public class DemoBigDecimal { public static void mai ...

  5. Vue组件基础用法

    前面的话 组件(Component)是Vue.js最强大的功能之一.组件可以扩展HTML元素,封装可重用的代码.根据项目需求,抽象出一些组件,每个组件里包含了展现.功能和样式.每个页面,根据自己所需, ...

  6. Smarty基础用法

    一.Smarty基础用法: 1.基础用法如下 include './smarty/Smarty.class.php';//引入smarty类 $smarty = new Smarty();//实例化s ...

  7. 前端自动化测试神器-Katalon的基础用法

    前言 最近由于在工作中需要通过Web端的功能进行一次大批量的操作,数据量大概在5000左右,如果手动处理, 完成一条数据的操作用时在20秒左右的话,大概需要4-5个人/天的工作量(假设一天8小时的工作 ...

  8. Bootstrap fileinput:文件上传插件的基础用法

    官网地址:http://plugins.krajee.com/ 官网提供的样例:http://plugins.krajee.com/file-input/demo 基础用法一 导入核心CSS及JS文件 ...

  9. asyncio 基础用法

    asyncio 基础用法 python也是在python 3.4中引入了协程的概念.也通过这次整理更加深刻理解这个模块的使用 asyncio 是干什么的? asyncio是Python 3.4版本引入 ...

随机推荐

  1. 恐怖的Hibernate和JavaFX Table CallBack!

    目录 [隐藏] 1 Hibernate 2 JavaFX Table Hibernate 最近在做 JavaFX 应用,不管再怎么避免数据持久化,但面对几十万的数据量的时候也只能乖乖的去配置持久层框架 ...

  2. go 学习笔记之走进Goland编辑器

    工欲善其事必先利其器,命令行工具虽然能够在一定程度上满足基本操作的需求,但实际工作中总不能一直使用命令行工具进行编码操作吧? 学习 Go 语言同样如此,为此需要寻找一个强大的 IDE 集成环境帮助我们 ...

  3. 【React踩坑记二】react项目实现JS路由跳转

    这里使用的是4.31版本的react-router-dom "react-router-dom": "^4.3.1", 直接使用以下代码即可实现路由跳转 thi ...

  4. Keil5调试过程中遇到的一些警告和错误

    最近用keil5调试代码出了一些警告与错误,整理如下: 1.warning: #1295-D: Deprecated declaration run_c - give arg types void r ...

  5. Duilib的圆环形 进度条 实现(网易云信版本)

    /** @file CircleProgress.h* @brief 圆环型进度条控件,圆环中间可以有文本(如85%)* @copyright (c) 2019-2022, NetEase Inc. ...

  6. 域名、主机名、网站名以及 URL 基础概念

    这个东西,在百度经验上已经有人讲得非常清楚了, 作为 web 方向的小白, 我写下我的理解,以便日后查看. 以 https:// www.3vjia.com 为例, 见下图: DNS (Domain ...

  7. NVIDIA: Failed to initialize NVML: driver/library version mismatch

    [NVIDIA驱动:Failed to initialize NVML: driver/library version mismatch] 原因:Ubuntu16.04 装新驱动时,会报以上错误,定位 ...

  8. 为什么不建议在hbase中使用过多的列簇

    我们知道,hbase表可以设置一个至多个列簇(column families),但是为什么说越少的列簇越好呢? 官网原文: HBase currently does not do well with ...

  9. PIXIJS的一些使用

    我发现pixijs在国内简直就是一片静土啊,只有那么一点点的微弱的不能再微弱的声音. 我在这里整理了下我使用过程中解决和可能理解的一些问题吧,都是一个个点,而不是完整的示例. 先放官网示例: http ...

  10. 单元测试之NUnit一

    NUnit 分三篇文章介绍,入门者可阅读文章,有基础者直接参考官方文档.初次写博客,望大家指点. 导航: 单元测试之NUnit一 单元测试之NUnit二 单元测试之NUnit三 NUnit是什么? N ...