@canofold/vite

中文文档
0.8.3发布于 2026/10/21MITTypeScriptES Module构建来源已验证近 30 天下载 1855

用于交互式 Canofold 组件文档的官方 Vite 演示引擎.

中文使用文档

@canofold/vite

Canofold 官方 React + Vite Demo Engine。它复用组件项目已有的 Vite 配置、插件、别名和 CSS 依赖图,为普通 Markdown 中的组件示例提供开发预览、HMR 与生产构建。当前版本支持 React 18 和 React 19。

import { defineConfig } from 'canofold'
import { vite } from '@canofold/vite'

export default defineConfig({
  demos: {
    engine: vite()
  }
})

运行 canofold dev 即可。Canofold 与 Vite 共用一个 HTTP Server 和端口;同一开发会话只创建一个 Vite Server,组件、样式和 Demo 依赖由 Vite module graph 监听并通过 HMR 更新,Markdown 与 Canofold 配置仍由 Canofold 重建。

无需为文档单独维护 Vite 配置。@canofold/vite 会复用项目现有的 vite.config、插件、alias、React、TypeScript/JSX 与 CSS 配置。Demo 应像应用代码一样从组件包名或项目已有 alias 导入组件,组件 CSS 由组件或 Demo 自己 import;不要把每个组件样式登记到 Canofold 的 styles。

内嵌开发服务默认使用 logLevel: 'warn' 和 clearScreen: false,保留警告与错误,不重复打印依赖优化信息或清空终端;vite.config 中显式配置的值优先。

对于 package.json 有包名且 build.lib.entry 只有一个入口的标准组件库,Canofold 会在没有同名自定义 alias 时自动把包名解析到该源码入口,因此不需要把同一入口再写一遍 alias。多入口库和 workspace 不做推断,继续使用项目已有的 exports 或 alias。

生产构建中,Markdown 浏览器增强、Demo 运行时和项目组件进入同一 Vite 构建图。React 与 React DOM 由组件项目解析并去重,Demo 与 CSS 按需分块,不会把全部示例和样式无条件放进入口。同一构建图会输出轻量 Markdown 入口和 Demo 入口:没有 Demo 的页面不会因为原生 Markdown 交互而静态加载 React,有 Demo 的页面则复用 Demo 入口中的 Markdown 增强能力。

demos.setup 只用于所有 Demo 共享的 Provider、主题、国际化或路由环境;普通组件不需要设置。

demos.setup 引入的 CSS 会在开发和生产环境中自动加载到 Demo 页面,客户端导航切换同样有效。组件 CSS 仍跟随对应 Demo 按需加载,不要在站点的 styles 中重复登记同一份样式。

Demo 默认渲染在文档页面中。sandbox="iframe" 会把可信的本地 Demo 放进受限 iframe,隔离 DOM 与全局样式;它不是运行不可信代码的安全边界。

版本与发布记录

@canofold/vite 共发布 25 个版本,首次发布于 2026/09/18;过去 12 个月发布了 25 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.8.3latest2026/10/2119 天前
0.8.22026/10/1921 天前
0.8.12026/10/1822 天前
0.8.02026/10/1822 天前
0.7.12026/10/1822 天前
0.7.02026/10/1723 天前

关于 @canofold/vite 的常见问题

@canofold/vite 是什么?

用于交互式 Canofold 组件文档的官方 Vite 演示引擎.

如何安装 @canofold/vite?

在项目目录运行 npm install @canofold/vite,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vite(^6.4.0 || ^7.0.0 || ^8.0.0)、react(^18.2.0 || ^19.0.0)、canofold(^0.8.3)、react-dom(^18.2.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@canofold/vite 支持 TypeScript 吗?

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

@canofold/vite 支持 ESM 还是 CommonJS?

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

@canofold/vite 需要什么版本的 Node.js?

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

@canofold/vite 可以商用吗?

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

@canofold/vite 的下载量有多少?

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

@canofold/vite 还在维护吗?

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