0. 如何优雅地编写通用markdown文章

284 阅读2分钟

1. 前言

Markdown格式的优势之一是通用性强。许多网站都支持Markdown格式解析。
如何轻松编写文章的同时将格式的通用性发挥出来?文本将介绍一种合适的工作方式。

2. 一款功能强大的编辑器

这里推荐 VSCode + Markdown All in One 插件。
VSCode 是多数人都熟悉的编辑器。
Markdown All in One插件支持预览、生成目录、快捷键格式修改,支持保存时自动格式化和更新目录。可以说,其功能很够用了。

3. 使图片显示变得容易

文档图片的加入有两个麻烦点。

  • 使用本地图片资源时,对文档迁移造成困难。
  • 默认的图片大小影响阅读体验

前者的解决办法是采用云图床 PicGo + Github

我们通过配置Github用户和Token将图片保存在Github工程中并生成URL。将URL插入Markdown文档中,实现本地图片上云。

具体配置方式见 PicGo 手册
这里提一个好用的插件 quick-capture ,提供截图+上传的一条龙服务。

后者的解决办法是使用html格式添加图片大小限制。

<img src="https://raw.githubusercontent.com/Yuefeng95/Images/main/img/202201301538348.png" height="300px" />  

通过统一所有图片的height实现全文图片的规整排布。
这里我们可以依赖PicGo的 自定义链接格式 实现 上传 + 限制图片大小 的一条龙操作。

4. 支持通用Markdown的分享网站有哪些

如下网站有完善Markdown格式支持

  • 掘金
  • Github

5. 解决一些网站的显示错误

5.1. 列表显示错误

部分网站如 confluence 中会将多级列表识别成同级的。这里的解决办法是通过 Markdown to HTML 网站将多级列表转换成 HTML 格式并替代 Markdown 格式的多级列表。

5.2. 图片加载失败

部分网站如 知乎 出现因图床资源加载延迟高出现加载失败的情况。这里的解决办法是通过公众的 CDN 网站实现图片缓存。多次加载后,高延迟的资源会因就近缓存变得加载变快。

原始的资源网站
raw.githubusercontent.com/Yuefeng95/I…
替换成 CDN 资源网站
cdn.jsdelivr.net/gh/Yuefeng9…