安装
了解如何在项目中安装 DocsJS。
环境要求
- Node.js 18.0 或更高版本
- npm、yarn 或 pnpm
包安装
bash
npm install @coding01/docsjsbash
yarn add @coding01/docsjsbash
pnpm add @coding01/docsjs对等依赖
DocsJS 根据框架有可选的对等依赖：
React
bash
npm install react react-domVue
bash
npm install vueCDN 使用
快速原型开发可以使用 CDN 版本：
html
<script type="module">
import { defineDocsWordElement } from "https://cdn.jsdelivr.net/npm/@coding01/docsjs@latest/dist/index.js";
defineDocsWordElement();
</script>
<docs-word-editor></docs-word-editor>验证安装
创建一个简单的测试文件验证安装：
html
<!DOCTYPE html>
<html>
<head>
<title>DocsJS 测试</title>
</head>
<body>
<script type="module">
import { defineDocsWordElement } from "@coding01/docsjs";
defineDocsWordElement();
</script>
<docs-word-editor lang="zh"></docs-word-editor>
</body>
</html>TypeScript 支持
DocsJS 使用 TypeScript 编写，包含类型定义。无需额外安装即可获得 TypeScript 支持。
ts
import { defineDocsWordElement, CoreEngine } from "@coding01/docsjs";
import type { PluginConfig, ProfileConfig } from "@coding01/docsjs";体积友好的引入方式
按场景选择最小入口：
- React：
@coding01/docsjs/react - Vue：
@coding01/docsjs/vue - 仅 Web Component 内核：
@coding01/docsjs/core
建议优先使用 ESM import，并对低频重能力使用懒加载：
ts
const { BillingManager } = await import("@coding01/docsjs");