Nuxt Content 中如何定义外部目录的内容集合

在 Nuxt Content 项目中，开发者有时需要将存放在项目根目录之外或特定子目录中的 Markdown 文件作为内容集合引入。本文详细介绍如何通过绝对路径配置实现这一需求。

问题背景

Nuxt Content 默认会从项目根目录下的 content 文件夹中读取内容文件。但在实际开发中，我们可能需要：

1. 引用存放在其他子目录中的内容
2. 引用存放在项目根目录外的内容（如 git 子模块中的文档）
3. 组织跨项目的文档共享

解决方案

通过 defineCollection 配置中的 source.cwd 属性，结合 Node.js 的 path.resolve 方法，可以指定任意目录作为内容源：

import path from 'path'

defineCollection({
  type: "page",
  source: {
    cwd: path.resolve("submodules/articles_release"), // 使用绝对路径
    include: "**/*.md", // 包含所有子目录下的md文件
  },
})

关键点解析

1. 绝对路径的必要性：

   • 相对路径（如 ../submodules）在某些构建环境下可能失效
   • path.resolve 确保始终解析为正确的绝对路径

2. 路径解析最佳实践：

   • 对于项目根目录下的子目录：path.resolve("docs")
   • 对于上级目录：path.resolve("../shared-docs")
   • 对于特定子模块：path.resolve("submodules/docs")

3. 多目录配置： 可以定义多个集合，每个集合指向不同的目录：

export const collections = {
  blog: defineCollection({
    source: {
      cwd: path.resolve("content/blog"),
      include: "**/*.md"
    }
  }),
  externalDocs: defineCollection({
    source: {
      cwd: path.resolve("../shared-docs"),
      include: "**/*.md"
    }
  })
}

注意事项

1. 文件权限：确保构建进程对目标目录有读取权限
2. 热更新：开发模式下，外部目录的更改可能需要手动触发刷新
3. 构建部署：生产环境中需确保目标目录存在且路径正确
4. 性能考虑：避免引用过大的外部目录，影响构建速度

通过这种配置方式，Nuxt Content 项目可以灵活地整合来自不同位置的文档内容，实现更复杂的文档管理和共享需求。