Next.js 与 Markdoc 集成项目配置指南

一、项目目录结构及介绍

开源项目 @markdoc/next.js 的目录结构如下：

pages/
├── _app.js          # Next.js 应用主组件
├── docs/
│   └── getting-started.md  # Markdoc 文档页面
├── index.js         # Next.js 应用入口页面
.gitignore           # 忽略文件列表
LICENSE             # 项目许可证文件
README.md           # 项目说明文件
babel.config.json   # Babel 配置文件
package-lock.json   # 依赖锁定文件
package.json        # 项目配置及依赖文件

• pages/: 存放 Next.js 的页面文件，包括 Markdoc 文档页面。
• _app.js: Next.js 的主组件，可用于所有页面的共享布局或数据。
• docs/: 存放 Markdoc 文档的目录。
• index.js: Next.js 应用的首页。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• LICENSE: 项目遵循的 MIT 许可证。
• README.md: 项目说明文档。
• babel.config.json: Babel 配置文件，用于 JavaScript 的转译。
• package-lock.json: 包含项目依赖的详细版本信息。
• package.json: 定义了项目的配置信息和依赖项。

二、项目的启动文件介绍

项目的启动主要是通过 package.json 中的脚本进行的。以下是 package.json 文件中可能包含的启动脚本：

"scripts": {
  "dev": "next dev",
  "build": "next build",
  "start": "next start",
  "test": "jest"
}

• npm run dev: 启动开发服务器，通常监听在 http://localhost:3000。
• npm run build: 构建应用程序的生产版本。
• npm run start: 启动生产服务器。
• npm run test: 运行测试。

三、项目的配置文件介绍

项目的配置主要通过 next.config.js 文件进行。以下是 next.config.js 的基本配置：

const withMarkdoc = require('@markdoc/next.js');

module.exports = withMarkdoc({
  pageExtensions: ['js', 'md'], // 支持的页面文件扩展名
});

在这个配置文件中，我们使用 @markdoc/next.js 提供的插件来扩展 Next.js 的页面文件类型，使其支持 .md 格式的 Markdoc 文档。pageExtensions 选项允许你指定额外的文件扩展名，用于 Next.js 的页面文件。在这个例子中，我们添加了 md 作为 Markdoc 文档的扩展名。