Rspress项目中静态资源路径配置的最佳实践

在Rspress项目中，静态资源的路径配置是一个常见但容易出错的问题。特别是在配置了base路径后，如何正确引入logo等静态资源，需要开发者特别注意。

问题背景

当我们在Rspress项目中配置了base路径后，静态资源的引用可能会出现404错误。这是因为构建后的资源路径没有自动加上base前缀，导致浏览器无法正确加载这些资源。

解决方案

Rspress提供了normalizeImagePath工具函数，专门用于处理静态资源路径问题。这个函数会自动为资源路径添加配置的base前缀，确保构建后资源能够被正确加载。

import { normalizeImagePath } from 'rspress/runtime';

export default defineConfig({
  root: path.join(__dirname, 'docs'),
  base: '/base',
  icon: normalizeImagePath('/rspress-light-logo.png'),
  logo: {
    light: normalizeImagePath('/rspress-light-logo.png'),
    dark: normalizeImagePath('/rspress-dark-logo.png'),
  },
})

实现原理

normalizeImagePath函数的工作原理是：

1. 读取项目配置中的base路径
2. 为传入的资源路径自动添加base前缀
3. 返回处理后的完整路径

这样无论在开发环境还是生产环境，资源路径都能保持一致，避免了开发时正常但构建后失效的问题。

注意事项

1. 所有在配置文件中引用的静态资源都应该使用normalizeImagePath处理
2. 在MDX文件中引用的静态资源也需要同样的处理
3. 确保静态资源文件确实存在于项目目录中
4. 路径应该以斜杠开头，表示从项目根目录开始

通过遵循这些最佳实践，可以确保Rspress项目中的静态资源在各种环境下都能正确加载，提升项目的稳定性和可维护性。