# @aicayzer/inkkit 中文文档

规范地址：https://npmcn.com/package/%40aicayzer/inkkit/

版本：0\.7\.2
npm 元数据更新时间：2026-11-03T00:25:50.995Z
中文译文更新时间：2026-11-06T01:17:21.491Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aicayzer/inkkit
原文对照：https://npmcn.com/package/%40aicayzer/inkkit/?lang=original
项目主页：https://github.com/aicayzer/inkkit#readme
源码仓库：https://github.com/aicayzer/inkkit

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.8 MB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=26
- 运行依赖：0 个
- 首次发布：2026-10-08T14:29:08.137Z
- 最新版本发布：2026-11-03T00:25:50.627Z
- 近 30 天下载量：7306（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：43（近 12 个月 43 个）

## 中文简介

保存 Markdown 编辑器供离线浏览和网络

## 安装

```sh
npm install @aicayzer/inkkit
```

也可以使用：`pnpm add @aicayzer/inkkit`、`yarn add @aicayzer/inkkit`、`bun add @aicayzer/inkkit`

## README

# 墨迹

一个用于网页和网页视图主机应用的Markdown编辑器. 人们编辑了格式化的文本,而您的应用程序会保存所写的Markdown:一个未经编辑的文档保存不变,编辑只重写它所触及的块.

墨水如何保护马克下 ![Inkkit keeps unchanged source and checks edited blocks before your app saves them.](https://npmcn.com/package/%40aicayzer/inkkit/docs/images/how-inkkit-works.svg) 

## 开始吧

```sh
npm install @aicayzer/inkkit
```

```ts
import { InkKitEditor } from '@aicayzer/inkkit'
import '@aicayzer/inkkit/style.css'

const editor = await InkKitEditor.mount(document.getElementById('editor')!, {
  changed() {},
  error(error) {
    console.error(error.code, error.message)
  },
})

editor.loadDocument({
  documentId: 'note',
  generation: 1,
  format: 'md',
  text: '# Hello\n\nStart writing.\n',
})

const { text } = editor.snapshot(1)
```

## 文档

[(原始内容存档于2013-10-10). inkkit.cyzr.me](https://inkkit.cyzr.me/) 涵盖Inkkit如何工作,兼容性,集成指南和API参考.

## 许可证

[麻省理工学院](https://npmcn.com/package/%40aicayzer/inkkit/LICENSE)第三方通知 [通知](https://npmcn.com/package/%40aicayzer/inkkit/NOTICE)。 。 。 .

## 常见问题

### @aicayzer/inkkit 是什么？

保存 Markdown 编辑器供离线浏览和网络

### 如何安装 @aicayzer/inkkit？

在项目目录运行 npm install @aicayzer/inkkit，或使用 pnpm add / yarn add / bun add。

### @aicayzer/inkkit 支持 TypeScript 吗？

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

### @aicayzer/inkkit 支持 ESM 还是 CommonJS？

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

### @aicayzer/inkkit 需要什么版本的 Node\.js？

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

### @aicayzer/inkkit 可以商用吗？

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

### @aicayzer/inkkit 的下载量有多少？

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

### @aicayzer/inkkit 还在维护吗？

最新版本 0\.7\.2 发布于 2026/11/03（3 天前）；至今共发布 43 个版本，其中过去 12 个月发布了 43 个；首次发布于 2026/10/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。