多年经验总结,写出最惊艳的 Markdown 高级用法

点赞再看,养成习惯,微信搜索【高级前端进阶】关注我。

本文 GitHub https://github.com/yygmind 已收录,有一线大厂面试完整考点和系列文章,欢迎 Star。

最近在学习的时候看到了 Markdown 代码 diff 高亮的效果,感觉挺有意思的。突然发现还有这么一个好玩的用法,然后我就想着整理一波 Markdown 的高级用法,下面是我整理的一些内容,如果还没用过 Markdown 这些技巧,快来试试吧。

代码diff

如果你做过代码 Code Review,对下面这种效果肯定很熟悉

// 数组去重
const unique = (arr)=>{
-    return Array.from(new Set(arr))
+  return [...new Set(arr)]
}

这种代码的增删对比效果就是通过 diff 来做的,原始代码如下

​```diff
// 数组去重
const unique = (arr)=>{
-    return Array.from(new Set(arr))
+  return [...new Set(arr)]
}
​```

在 Markdown 中,``` 用来表示代码块,跟在后面的是语言类型,比如 js、java 和 diff 等

上面的 diff 代码最终在 html 中会转换成下面这段(不过在不同转化器中转换效果会有所差异),最终通过修改样式达到上面的效果。

<pre>
    <code>
        "//&nbsp;数组去重"
        <br>
        "const unique = (arr)=>{"
        <br>
        <span class="deletion">"-  return Array.from(new Set(arr))"</span>
        <br>
        <span class="addition">"+  return [...new Set(arr)]"</span>
        <br>
        "}"
        <br>
    </code>
</pre>

待办事项

很多 Demo 代码都会实现一个 TodoList,我们用 Markdown 来做一个,实现下面这种 Todo 效果

  • 待完成
  • 已完成
  • 未完成

原始写法是下面这样

-空格[空格]空格待完成

-空格[x]空格已完成

-空格[空格]空格~~未完成~~

图片设置宽高

图片描述

插入图片方式比较简单,上面这张图片原始写法如下,只要有 ![]() 就行了

![图片描述](https://upload-images.jianshu.io/upload_images/1621760-df34d946976c4b64.png)

但是这时候的图片宽高是不受限制的,如何生成给定宽高的图片,我们先来看下效果。

<img src='https://upload-images.jianshu.io/upload_images/1621760-df34d946976c4b64.png' width=300px height=200px/>

这时候我们可以使用 img 标签,原始写法如下

<img src='https://upload-images.jianshu.io/upload_images/1621760-df34d946976c4b64.png' width=300px height=200px />

// 写法二,自动缩放
<img src='https://upload-images.jianshu.io/upload_images/1621760-df34d946976c4b64.png' width=40%/>

原理也很简单,因为 ![]() 转化成 html 后就会变成 img 标签,所以我们直接在 Markdown 中写 img 标签并且加上宽高就可以了。

// 原始 markdown 语法
![图片描述](https://upload-images.jianshu.io/upload_images/1621760-df34d946976c4b64.png)

// 转化成 html 后语法
<img src="https://upload-images.jianshu.io/upload_images/1621760-df34d946976c4b64.png" alt="图片描述">

折叠

之前写过一篇 Array 原型方法源码实现大解密 的文章,里面就用到了这一能力。点击下面例子的「展开查看规范」后,就会展开更多内容。

<details>
<summary>展开查看规范</summary>
这是展开后的内容1
</details>

原始写法比较简单,用到了 <details><summary> 标签

<details>
<summary>展开查看规范</summary>
这是展开后的内容1
</details>

锚点链接

锚点是网页制作中的一种,又叫命名锚记。命名锚记就像一个迅速定位器一样,它是一种页面内的超级链接。

锚点链接就是点击后会跳转到对应的锚点位置,想到链接跳转就能想到 <a></a> 标签

在这里我们有 2 种方式实现这个效果

  • Markdown 原始写法 [名称](#id)

  • HTML 语法 <a href="#id">名称</a>

点击我跳转到目录树

<a href="#目录树">名称</a>

原始写法就是下面这种了

[点击我跳转到目录树](#目录树)

<a href="#目录树">名称</a>

目录树

这种直接在文章中使用 [TOC] 就可以,会转化成下面这种格式

<div class="table-of-contents">
    <ul>
        <li><a href="">代码diff</a></li>
        <li><a href="">待办事项</a></li>
        ...
    </ul>
</div>

不过这样也存在兼容性问题,Github 中并不支持,可以使用 github-markdown-toc 这个库自动生成,其实它的原理就是自动生成锚标记,然后就可以页面内跳转了。

换行

最后来介绍下怎么换行,比如最长使用的 Markdown 工具是 Typora,换行后发到 github 发现并没有什么卵用,其实这时候使用 CSS 的 <br> 标签就可以了。


上面这一行就是换行效果了

文章持续更新,可以微信搜索「高级前端进阶 」第一时间阅读,回复【资料】【面试】【简历】有我准备的一线大厂面试资料,本文 GitHub https://github.com/yygmind 已收录,有一线大厂面试完整考点和系列文章,欢迎 Star。

有任何问题都可以来问我

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容