你可能不知道的markdown语法

发布于:2024-04-30 ⋅ 阅读:(39) ⋅ 点赞:(0)

前言

作为一名程序员,在书写技术文章时,必不可少的要用到markdown语法。

但是你有没有感觉自己好像懂markdown,但是又好像不懂。

下面就让我们一起来学习下你不懂的markdown。

语法

带选择框的列表

带选择框的列表:

- [ ] 待完成
- [x] 已完成

或是

* [ ] 待完成
* [x] 已完成

效果:

  • 待完成
  • 已完成

标记

有时我们需要重点向读者展示某部分文字,除了加粗倾斜外,还可以标记文字的背景颜色,使其突出显示,语法如下:

<mark>这是重点关注的</mark>

效果:

这是重点关注的

删除

当然,有时一些信息已经过时,我们希望告诉读者这些信息将会被废弃或是删除,就可以使用删除语法

<del>这是废弃的内容</del>

或是

~~这是废弃的内容~~

效果:

这是废弃的内容

分割线

有时为了更好的组织文章结构,需要使用分割线来将文章分割为几部分,就可以使用分割线语法:

***

或是

---

效果:


引用

当我们文章中的一部分内容是从其他文章中引用过来的,我们需要清楚的告诉读者,这是就可以使用引用语法:

> 这是引用的内容

效果:

这是引用的内容

表格

表格应该算是使用比较普遍的了,我这里主要强调下表格的对齐方式语法,如下:

| 列1 | 列2 | 列3 | 
|:-------|:-------:|--------:| 
| 左对齐 | 居中对齐 | 右对齐|

对齐方式主要取决于这一行:|:-------|:-------:|--------:|

  • 左对齐,冒号在左侧:|:-------|

  • 居中对齐,冒号两侧都有:|:-------:|

  • 右对齐,冒号在右侧:|-------:|

效果:

列1 列2 列3
左对齐 居中对齐 右对齐

图片居中和设置宽高

大家应该都知道图片的markdown语法是怎么书写的:

![zustand](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5593871979214b8d80dc6ac6e49193a4~tplv-k3u1fbpfcp-jj-mark:0:0:0:0:q75.image#?w=1452&h=681&s=542401&e=png&b=fefdfd)

效果:

zustand

但是有个问题,图片是默认左对齐且宽度有点宽,视觉上并不优雅,那我想让这张图片宽度小点,且居中显示,怎么书写呢?

其实,markdown语法到页面显示的原理是 通过解析markdown语法,根据特定的规则生成对应的html标签并添加具体的样式,从而显示在网页上的。

所以,我们可以在markdown中直接书写html标签,解析器会将这部分html标签原样插入到特定的位置,这样我们就可以自己定制样式了。

比如:

  • 居中可以使用p标签的align属性

  • 图片的宽高可以使用img标签的widthheight属性

那实现图片限制宽度切居中就可以这么书写:

<p align=center>
    <img width="500" src="https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5593871979214b8d80dc6ac6e49193a4~tplv-k3u1fbpfcp-jj-mark:0:0:0:0:q75.image#?w=1452&h=681&s=542401&e=png&b=fefdfd"/>
</p>

效果:

代码 Diff

有时在书写代码块时,需要向读者展示前后代码的修改,单纯的贴出前后代码的完整形态其实对于读者来说是不友好的,读者需要自己去寻找这两部分代码之间的差异。体验很差,说明度也不好。

那此时,你就需要使用代码的diff功能。

语法如下:

  • 首先需要声明这个代码块是diff类型的
  • 增加的代码只需要在代码最前面加一个+
  • 删除的代码只需要在代码最前面加一个-
```diff
+ let a = [];
- let b = [];
function add() {
+ let c = 1;
- let c = 2;
}
```

效果:

+ let a = [];
- let a = '';
function add() {
+ let c = 1;
- let c = 2;
}

总结

本文主要总结了一些高级点的markdown语法,希望这些语法对你书写markdown来说有那么一点点帮助。那这篇文章就是有价值的。