@current-docs/embed

中文文档
0.1.0发布于 2026/07/04MITES Module近 30 天下载 2057

Embeddable Current docs surface for Next.js App Router hosts: layout, page, search, and OpenAPI components plus install templates. Published as TypeScript source; consume via transpilePackages.

原始使用文档

@current-docs/embed

Embeddable Current docs surface for Next.js App Router hosts. It re-exports the Fumadocs layout, page, search, and OpenAPI building blocks behind one stable import, plus templates/ with the files the docs-embed skill copies into a host app (route group, search route, OpenAPI proxy).

The package ships as TypeScript source, not compiled JS. The host's Next.js build transpiles it, so transpilePackages: ['@current-docs/embed'] in next.config.ts is required. The fumadocs-* packages are regular dependencies and come with the install; the host only needs next, react, and react-dom (peer deps).

Install

npm install @current-docs/embed fumadocs-mdx

Inside this monorepo use "@current-docs/embed": "workspace:*"; in an onboarded repo use "@current-docs/embed": "^0.1.0" from npm.

Usage

// next.config.ts: transpilePackages: ['@current-docs/embed'], wrap with createMDX()
// lib/docs-source.ts
import { createOpenAPI, loader } from '@current-docs/embed';
import { docs } from '@/.source/server';

export const source = loader({ baseUrl: '/help', source: docs.toFumadocsSource() });

// app/help/layout.tsx
import { DocsLayout, RootProvider } from '@current-docs/embed';
// wrap children: <RootProvider><DocsLayout tree={source.getPageTree()}>{children}</DocsLayout></RootProvider>

The full wiring (layout, catch-all page, search and proxy routes, source config) lives in templates/; the docs-embed skill copies them in and adjusts paths.

版本与发布记录

@current-docs/embed 共发布 1 个版本,首次发布于 2026/07/04;过去 12 个月发布了 1 个版本。

版本发布日期距今
0.1.0latest2026/07/044 个月前

关于 @current-docs/embed 的常见问题

@current-docs/embed 是什么?

Embeddable Current docs surface for Next.js App Router hosts: layout, page, search, and OpenAPI components plus install templates. Published as TypeScript source; consume via transpilePackages.

如何安装 @current-docs/embed?

在项目目录运行 npm install @current-docs/embed,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:next(^16.0.0)、react(^19.2.0)、react-dom(^19.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@current-docs/embed 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/current-docs__embed 是否存在。

@current-docs/embed 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@current-docs/embed 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@current-docs/embed 可以商用吗?

@current-docs/embed 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@current-docs/embed 的下载量有多少?

根据 npm 官方下载统计,@current-docs/embed 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,057 次,日均约 69 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@current-docs/embed 还在维护吗?

最新版本 0.1.0 发布于 2026/07/04(4 个月前);至今共发布 1 个版本,其中过去 12 个月发布了 1 个;首次发布于 2026/07/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。