Skip to content

技术博客:VitePress 知识站为什么要把示例代码和真实资源分开表达

有些“资源问题”本质上并不是资源问题

当一个知识站开始做资源巡检后,很多问题会自然暴露出来。

但剩余问题越少,越需要分清问题的本质。因为有些看起来像“图片缺失”的条目,其实并不是页面真的缺图,而是示例代码直接写成了可渲染的 HTML。

为什么示例代码要显式写成代码块

如果一段 HTML 示例直接出现在 Markdown 正文里,站点会把它当成真实标签渲染。

这会带来两个问题:

  • 读者不容易一眼判断这是代码还是页面输出
  • 巡检脚本会把里面的 src 当成真实资源依赖

把它改成代码块之后,语义就稳定了:这是一段示例,不是页面真实资源。

历史缺图为什么不一定要强行补回来

知识库里总会有一些迁移很早的内容,原图已经不可恢复。

这类页面如果继续强行依赖不存在的文件,只会让资源治理一直拖着尾巴。更稳妥的方式,是删除失效引用,并补一行必要说明,让读者知道原位置曾经有辅助图示即可。

M13 真正收口的是什么

这一轮收口的不是几条图片链接,而是资源治理的判断标准:

  • 真实页面依赖就修
  • 示例代码就改表达方式
  • 无法恢复的历史资源就做说明并卸载依赖

当这个标准稳定下来后,资源治理就不会反复在同类问题上打转。

共 20 个模块,1301 篇 Markdown 文档。