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 上手指南




目录
相关文章
|
JavaScript API
markdown-it 插件如何写(二)
「这是我参与2022首次更文挑战的第4天,活动详情查看:2022首次更文挑战」。
309 0
markdown-it 插件如何写(二)
|
6月前
|
程序员
Markdown简易教程
Markdown教程概览:一种轻量级标记语言,用于编写易读易写的文本,可转换为HTML、Word等多种格式。常用功能包括标题(#号表示级别)、段落、字体样式(斜体、粗体、删除线等)、分隔线、列表(有序、无序、任务列表)、代码块、数学公式、链接、图片和视频。支持引用、表格和脚注等。推荐编辑器有Typora。官方教程:[Markdown 基本语法](https://markdown.com.cn/basic-syntax/)。
41 0
|
搜索推荐 程序员 PHP
Markdown新手入门必知必会
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。
130 0
Markdown新手入门必知必会
|
Java uml
最全markdown入门教程
这是一篇可以开启你 Markdown编辑器 之旅必备的技术文章。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章,了解一下Markdown的基本语法知识。
最全markdown入门教程
|
Windows
最简单的Markdown教程
Markdown是一种轻量级的标记语言;目标是实现“易读易写”。
199 0
最简单的Markdown教程
|
JavaScript
Markdown 写文档做笔记的利器
Markdown 写文档做笔记的利器
Markdown 写文档做笔记的利器
|
JavaScript 容器
markdown-it 插件如何写(三)
「这是我参与2022首次更文挑战的第5天,活动详情查看:2022首次更文挑战」。
291 0
markdown-it 插件如何写(三)