Observable Framework 自动生成目录页面的实现方案

在构建基于 Observable Framework 的文档网站时，开发者经常需要处理大量 Markdown 文件的目录组织问题。传统方式需要在配置文件中手动维护每个页面的路径和名称，这在内容频繁更新时会变得繁琐且容易出错。

默认行为分析

Observable Framework 默认会自动扫描项目目录中的 Markdown 文件并生成导航菜单。但这种自动生成的导航存在两个特点：

1. 仅显示单层结构，不会自动展示文件夹层级
2. 页面标题直接从文件名或 Markdown 的 front-matter 提取

高级目录组织方案

对于需要展示层级结构的场景（如博客分类），可以通过编程方式动态生成导航配置。核心思路是：

1. 使用 Node.js 文件系统模块读取目录内容
2. 解析每个 Markdown 文件的元数据获取标题
3. 构建符合 Framework 要求的页面配置对象

实现示例

以下是一个完整的配置示例，展示如何自动生成包含二级菜单的导航：

import { readdirSync } from "fs";
import { join } from "path";
import matter from "gray-matter";
import { readFileSync } from "fs";

function getMarkdownTitle(filePath) {
  const content = readFileSync(filePath, "utf-8");
  const { data } = matter(content);
  return data.title || path.basename(filePath, ".md");
}

export default {
  pages: [
    {
      name: "博客文章",
      pages: readdirSync("docs/blog").map((file) => ({
        name: getMarkdownTitle(join("docs/blog", file)),
        path: `/blog/${file.replace(/\.md$/, "")}`
      }))
    }
  ]
};

关键技术点

1. 文件系统操作：使用 Node.js 原生模块实现目录遍历
2. 元数据解析：通过 gray-matter 等库解析 Markdown 的 front-matter
3. 路径处理：注意处理文件扩展名和 URL 路径的转换
4. 错误处理：生产环境应添加文件存在性检查等容错机制

进阶优化方向

1. 支持多级目录嵌套
2. 自动排序功能（按日期或自定义顺序）
3. 增量生成机制提升构建性能
4. 与 CI/CD 流程集成实现自动化部署

这种方案特别适合内容型网站，开发者只需维护 Markdown 文件本身，导航结构会自动保持同步，大幅降低维护成本。对于需要更复杂导航逻辑的项目，还可以考虑扩展为自定义插件体系。