Markdown上手指南

简介: markdown 是一门很实用的标记语言,若是有HTML 基础学起来会非常快。演示效果均是从typora 展示的,为什么用它,因为它是一个成熟的 md 编辑器!• markdown 所见即所得, 部分还增加了人性化的交互(比如代码高亮)• 支持公式• 支持大部分的拓展语法• 支持主流的流程图渲染


前言


markdown 是一门很实用的标记语言,若是有HTML 基础学起来会非常快。


演示效果均是从typora 展示的,为什么用它,因为它是一个成熟的 md 编辑器!


  • markdown 所见即所得, 部分还增加了人性化的交互(比如代码高亮)
  • 支持公式
  • 支持大部分的拓展语法
  • 支持主流的流程图渲染


温馨提示:


已经会的不用往下面看了,文章的目的是给我们研发组的小伙伴快速上手的。

因为前端这块的文档基本切换到MD来维护,花了点时间录制了一波GIF演示

基础语法


基础语法是支持度最高的,市面上主流的 markdown 解析器基本都支持。


拓展语法需要借助不同的插件或者库实现,通用性没那么强。


注意点 : 所有标记仅支持英文模式(半角)!!

标题


# H1
## H2
### H3
#### H4
##### H5
###### H6



文字强调


粗体


**我是粗体**



粗体


_我是斜体_
*我也是斜体*



着重强调(粗体+斜体)


***我着重的强调,再哔哔我嫩死你***


列表


有序列表


有序列表的格式是:   数字小数点+空格+文本


1. afdslf
2. fsadfae
3. Ewarewr



无序列表


格式: 横线(星号) + 空格 + 文本


- asdklfjsaf 
- fasdfsadf 
* 发水电费卢卡斯
* 发顺丰惹我



列表混合及嵌套


不管是有序列表还是无序列表,都支持多级嵌套,也支持有序无序列表混用。


若是增加一些外部扩展,还支持todo混入


- 测试啊
  - 真的测试啊
  - 你不信啊
    1. 我是三级有序列表
    2. 呵呵哒
  - 唉



外部链接


格式:方括号小括号(链接)


[点击我就跳到百度了](https://www.baidu.com) 



图片引用展示


格式:感叹号+外部链接的格式。 链接支持相对引用!


![closeup photo of computer code screengrab](https://images.unsplash.com/photo-1524666643752-b381eb00effb?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80)



水平分割线


格式: 空行 ---


呼叫逗比
---
逗比回应你了


引用


一般你引用了别处的内容,这个就可以用上了

格式: 大于号(>) + 空格 + 内容


>床前明月光
>
>疑是地上霜
>
> - 这是**李白**的诗歌 



行内代码


行内代码的效果通用都是灰色,不能针对语法高亮


格式:反引号+内容+反引号


`module.exports= ()=>{}`



拓展语法


表格


表格的语法也很简单,就是写的多一些,因为列越多写的越多。


默认的列左对齐,也支持设置居中和右对齐, 横杆大于等于3, 列的竖必须闭合才能代表一列!


  • 默认对齐(左对齐) :  :----
  • 居中对齐 : :---:
  • 右对齐: ---:


| 默认左对齐     |       居中对齐       |     右对齐 |
| :--- | :------------------: | -------: |
| 啊水电费萨德 | 阿斯顿六块腹肌阿斯顿 | 发水电费 |
| 1321 | 432 | 654645 |
| 啊水电费萨德 | 阿斯顿六块腹肌阿斯顿 | 发水电费 |
| 1321 | 432 | 654645 |



代码高亮


代码高亮看采用的是什么高亮库了,比如前端这块有用highlightjs 或 prism的。

所以高亮支持语言也得看高亮库是否支持!!


我是纯文本 plain text,因为我没有指定语言


```javascript
// 我是 js 高亮
import vue from 'vue';


# 我是 bash 高亮
ls -l | grep 'haha'


任务列表


这个很实用,就是展示待办事项效果, 算是列表的变种,可以混合使用


  • - [ ] text : 方括号内部空格代指是待办事项
  • -  [x] text : 方括号内部 x代指事项已经完成


- v1版本
  - [x] 用户接口打通
  - [ ] 用户接口合并
    - [ ] 合并重复字段
    - [ ] 呵呵到



文字高亮


格式:双等号+文本+双等号


===听说我要呗高亮了===
==是啊==
==亮瞎眼了==



脚注


这个东西在写文献用的最多


格式:


  • 声明: [^text]: description
  • 引用: hello[^text]


[^李白]: 一个喝酒的诗人
床前明月光[^李白]



删除线


你没看错,这不属于第一个版本的草案的内容,也是后续才有的

格式:两个波浪线+文本+波浪线


~~我给删除了,你看~~



下标


把字缩放,适合用来表现公式类的


H~2~o



mermaid


mermaid 不仅仅可以画流程图,具体可以看mermaid 上手指南




目录
相关文章
|
人工智能 算法 前端开发
我和通义灵码的一周年
通义灵码是阿里巴巴推出的一款AI插件,大小约5.8M,适用于IDEA开发环境。它通过@workspace和@terminal两大功能,显著提升代码开发效率和质量。@workspace帮助开发者快速理解项目结构,智能导航至关键代码;@terminal则提供命令行下的代码搜索与实时补全,加速开发流程。实际应用中,通义灵码大幅缩短了新项目熟悉时间,减少了试错成本,提升了代码的规范性和稳定性。
322 0
|
XML JavaScript 前端开发
如何解析一个 HTML 文本
【10月更文挑战第23天】在实际应用中,根据具体的需求和场景,我们可以灵活选择解析方法,并结合其他相关技术来实现高效、准确的 HTML 解析。随着网页技术的不断发展,解析 HTML 文本的方法也在不断更新和完善,
|
安全
CRLF(HTTP响应拆分漏洞)
CRLF(HTTP响应拆分漏洞)
561 21
|
JSON 小程序 数据格式
小程序引入vant weapp组件的方法
小程序引入vant weapp组件的方法
|
Web App开发 编解码 JavaScript
【Android App】在线直播之搭建WebRTC的服务端(图文解释 简单易懂)
【Android App】在线直播之搭建WebRTC的服务端(图文解释 简单易懂)
687 0
|
JSON 测试技术 API
Postman Test 校验入门指南:轻松进行接口测试并验证响应
Postman 是一个广泛使用的 API 开发工具,它允许开发人员测试 API 的各个方面,包括请求、响应、身份验证等等,其中最常用的功能之一就是 Test 校验。那今天就一起来看看 Postman 的 Test 校验该如何使用。
Postman Test 校验入门指南:轻松进行接口测试并验证响应
|
SQL 存储 关系型数据库
如何定位慢查询SQL以及优化
如何定位慢查询SQL以及优化
632 0
如何定位慢查询SQL以及优化
|
弹性计算 固态存储
阿里云服务器的vCPU是什么意思?虚拟CPU?
阿里云服务器的vCPU是什么意思?虚拟CPU?阿里云服务器vCPU和CPU是什么意思?CPU和vCPU有什么区别?一台云服务器ECS实例的CPU选项由CPU物理核心数和每核线程数决定,CPU是中央处理器,一个CPU可以包含若干个物理核,通过超线程HT(Hyper-Threading)技术可以将一个物理核变成两个逻辑处理核。vCPU(virtual CPU)是ECS实例的虚拟处理核。云服务器吧来详细说下阿里云服务器CPU和vCPU的区别:
3357 0
|
算法 小程序 C语言
【c语言】 我使用c语言基础做了一个老少皆宜的“国民小游戏【扫雷】
扫雷小游戏是一款非常优秀悠闲的小游戏,在各个pc端上都会有他的身影出现,我们学习了编程,为何不自己做一个游扫雷小戏游戏呢?说做就做,来先看一下大概的效果图。
294 0
【c语言】 我使用c语言基础做了一个老少皆宜的“国民小游戏【扫雷】
|
Java 编译器 调度
多线程基础知识(中)
多线程基础知识(中)
149 0
多线程基础知识(中)