功能
类型生成
生成 TypeScript 类型和入口文件
fumadocs-mdx 命令可以生成 TypeScript 类型和入口文件(存储在 .source 文件夹中),无需运行开发或构建服务器。
基本用法
fumadocs-mdx配置
Post-install 设置
在 package.json 中添加脚本,在安装依赖时自动生成类型:
{
"scripts": {
"postinstall": "fumadocs-mdx"
}
}自定义路径
如果项目使用非默认位置,可以指定路径参数:
npx fumadocs-mdx "config-path" "output-dir"参数
| 参数 | 说明 | 默认值 |
|---|---|---|
config-path | 配置文件位置 | source.config.ts |
output-dir | 生成文件的目标目录 | .source |
这种方式确保 TypeScript 类型在项目初始化后立即可用,无需等待任何构建过程。