Rspress项目中静态资源引用的正确姿势

静态资源引用问题分析

在Rspress项目中使用Markdown编写文档时，开发者经常会遇到图片等静态资源引用的问题。一个典型的场景是当开发者尝试使用![](doc/a.png)这样的相对路径引用图片时，会遇到编译错误，而同样的路径在其他Markdown编辑器如MarkText中却能正常显示。

问题根源探究

这个问题的本质在于Rspress作为一个基于Web的文档框架，其资源解析机制遵循Web部署标准。在Web构建过程中，资源路径需要明确的相对关系指示符（如./或../），而不能简单地依赖操作系统的文件路径解析方式。

解决方案详解

标准解决方案

Rspress官方文档明确指出，在MDX文件中使用静态资源时，应当遵循特定的路径规范。正确的做法是：

1. 将静态资源放置在项目根目录下的public文件夹中
2. 在Markdown中使用绝对路径引用，如/img/a.png

高级配置方案

对于确实需要使用相对路径的场景，可以通过修改Rspress配置来实现：

// rspress.config.ts
export default defineConfig({
  builderConfig: {
    tools: {
      rspack: {
        resolve: {
          preferRelative: true,
        },
      },
    },
  },
});

这个配置会启用Rspack的preferRelative解析选项，使构建工具更倾向于解析为相对路径。但需要注意，这种方案在文档文件层级较深时可能无法达到预期效果。

最佳实践建议

1. 优先使用绝对路径：将资源放在public目录下，使用/开头的绝对路径引用
2. 保持路径一致性：统一使用./前缀的相对路径或绝对路径，避免混用
3. 考虑构建环境：记住开发环境和生产环境的路径解析可能有所不同
4. 测试验证：在不同层级的Markdown文件中测试资源引用，确保在各种情况下都能正常工作

总结

Rspress作为专业的文档框架，其资源引用机制设计考虑了Web部署的实际需求。开发者应当遵循框架的最佳实践，而不是依赖特定编辑器的解析行为。通过理解Web构建原理和Rspress的设计思想，可以避免这类资源引用问题，构建出更加健壮的文档项目。