BetterPortal Docs Site
BetterPortal service that renders Markdown files from the repository-level docs/ directory as a BetterPortal documentation site.
npm install
npm run build
npm start
The service runs on http://localhost:3400 by default and is mounted in bp-config.yaml at /docs.
关于 @betterportal/docs-site 的常见问题
@betterportal/docs-site 是什么?
BetterPortal documentation site service
如何安装 @betterportal/docs-site?
在项目目录运行 npm install @betterportal/docs-site,或使用 pnpm add / yarn add / bun add。
@betterportal/docs-site 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@betterportal/docs-site 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@betterportal/docs-site 可以商用吗?
@betterportal/docs-site 使用 (AGPL-3.0-only OR Commercial) 许可。可在 AGPL-3.0、Commercial 中任选其一遵守。以上为概括,不构成法律意见,请以许可原文为准。
@betterportal/docs-site 的下载量有多少?
根据 npm 官方下载统计,@betterportal/docs-site 在 2026/10/08 – 2026/11/06 这 30 天内被下载 1,814 次,日均约 60 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@betterportal/docs-site 还在维护吗?
最新版本 11.0.9 发布于 2026/11/07(1 天前);至今共发布 152 个版本,其中过去 12 个月发布了 152 个;首次发布于 2026/06/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。