@docfy/core
The core components of Docfy, a documentation site builder.
Compatibility
Installation
npm install @docfy/core
# or
yarn add @docfy/core
Usage
const Docfy = require('@docfy/core').default;
const path = require('path');
new Docfy()
.run([
{
root: path.join(__dirname, 'docs'),
urlPrefix: 'docs',
pattern: '**/*.md',
},
])
.then(result => {
console.log(result);
});
Refer to the documentation site.
License
This project is licensed under the MIT License.
关于 @docfy/core 的常见问题
@docfy/core 是什么？
The core components of Docfy, a documentation site builder
如何安装 @docfy/core？
在项目目录运行 npm install @docfy/core，或使用 pnpm add / yarn add / bun add。
@docfy/core 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@docfy/core 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@docfy/core 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=22.22.2。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@docfy/core 可以商用吗？
@docfy/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@docfy/core 的下载量有多少？
根据 npm 官方下载统计，@docfy/core 在 2026/10/13 – 2026/11/11 这 30 天内被下载 54,562 次，日均约 1,819 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@docfy/core 还在维护吗？
最新版本 0.14.3 发布于 2026/10/13（30 天前）；至今共发布 23 个版本，其中过去 12 个月发布了 9 个；首次发布于 2020/06/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。