@csg-org/document-core

中文文档
0.0.15发布于 2026/08/11MITTypeScriptESM + CJS零依赖近 30 天下载 1980

用于渲染指向式文档的工具(核心软件包)

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. buildBlockComponent
  4. buildBlockConfigurationSchema

@ usewaypoint/ 文件核心

这是用于构建电子邮件信件的核心库 路径。它不具有倾向性,而且轻于依赖性,因此可用于编写复杂的文档.

[尖叫声] 此库仍在开发中, 最终界面为主题 更改

安装

安装 npm

npm install --save @usewaypoint/document-core

使用量

图书馆的根是 DocumentBlocksDictionary 词典. 这是将块名称映射到一个具有zod schema和相应的反应组件的物体上.

const dictionary = {
  Alert: {
    schema: z.object({
      message: z.string(),
    }),
    Component: ({ message }: { message: string }) => {
      return <div>{message.toUpperCase()}</div>
    }
  }
}

此字典对象被传递到构建器函数中作为参数.

buildBlockComponent

const Block = buildBlockComponent(dictionary);

<Block type="Alert" data={{message: 'Hello World' }} />

buildBlockConfigurationSchema

const Schema = buildBlockConfigurationSchema(dictionary);

const parsedData = Schema.safeParse({
  type: 'Alert',
  data: { message: 'Hello World' },
});

版本与发布记录

@csg-org/document-core 共发布 9 个版本,首次发布于 2026/01/08;过去 12 个月发布了 9 个版本。

版本发布日期距今
0.0.15latest2026/08/113 个月前
0.0.142026/08/113 个月前
0.0.132026/03/217 个月前
0.0.122026/03/018 个月前
0.0.112026/01/309 个月前
0.0.102026/01/309 个月前

关于 @csg-org/document-core 的常见问题

@csg-org/document-core 是什么?

用于渲染指向式文档的工具(核心软件包)

如何安装 @csg-org/document-core?

在项目目录运行 npm install @csg-org/document-core,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^16 || ^17 || ^18)、zod(^1 || ^2 || ^3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@csg-org/document-core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@csg-org/document-core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@csg-org/document-core 可以商用吗?

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

@csg-org/document-core 的下载量有多少?

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

@csg-org/document-core 还在维护吗?

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