EventCatalog静态站点部署中的路径解析问题解决方案

问题背景

在使用EventCatalog构建静态站点并部署时，开发者可能会遇到一个常见的路径解析问题：当从dist文件夹部署静态站点后，页面中的链接无法正确解析，导致URL路径出现异常。具体表现为链接会重定向到包含错误转义字符的路径，如https://www.eventcatalog.dev/%5Cdocs这样的格式。

问题分析

这个问题通常发生在以下场景中：

1. 开发者使用@eventcatalog/core版本2.2.6构建静态站点
2. 构建完成后从dist文件夹部署站点
3. 站点中的导航链接或内部链接无法正确解析

根本原因在于站点配置中缺少对基础路径的正确设置，特别是homePageLink配置项的缺失或不正确。当这个配置项未设置时，EventCatalog生成的静态页面中的链接可能会包含错误的路径分隔符或相对路径格式。

解决方案

解决这个问题的关键在于正确配置homePageLink参数。这个配置项用于指定站点的基础链接路径，确保所有生成的内部链接都能基于这个路径正确解析。

配置方法

在EventCatalog的配置文件中（通常是eventcatalog.config.js），添加或修改homePageLink配置：

module.exports = {
  // 其他配置...
  homePageLink: '/', // 设置基础路径为根目录
  // 或者根据实际部署路径设置
  // homePageLink: '/docs/' 
};

配置说明

1. 根目录部署：如果站点部署在域名根目录下，应设置为'/'
2. 子目录部署：如果站点部署在子目录下（如/docs/），则应设置为对应的子目录路径
3. 绝对路径：确保使用正确的正斜杠(/)作为路径分隔符

最佳实践

为了避免类似问题，建议在部署EventCatalog静态站点时遵循以下步骤：

1. 预部署检查：

   • 本地构建后，先在本地服务器测试dist文件夹中的内容
   • 检查所有链接是否能够正确跳转

2. 环境适配：

   • 根据实际部署环境调整homePageLink配置
   • 开发环境和生产环境可能需要不同的配置

3. 版本兼容性：

   • 确保使用的@eventcatalog/core版本是最新的稳定版
   • 检查版本更新日志中关于路径处理的改进

总结

EventCatalog作为文档站点生成工具，在静态站点部署时可能会遇到路径解析问题。通过正确配置homePageLink参数，可以确保生成的静态页面中的所有链接都能正确解析。这个问题虽然看似简单，但对于站点的可用性至关重要，特别是在生产环境部署时。开发者应当在构建前充分考虑部署环境，并进行充分的测试，以确保站点功能的完整性。