# @antonz/codapi 中文文档
规范地址：https://npmcn.com/package/%40antonz/codapi/
版本：0\.20\.1
npm 元数据更新时间：2026-08-21T05:03:26.013Z
中文译文更新时间：2026-11-07T06:12:59.037Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40antonz/codapi
原文对照：https://npmcn.com/package/%40antonz/codapi/?lang=original
项目主页：https://codapi.org/
源码仓库：https://github.com/nalgeon/codapi-js
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：53.6 kB，14 个文件
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2023-08-16T17:38:15.681Z
- 最新版本发布：2026-08-21T05:03:25.857Z
- 近 30 天下载量：2043（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：58（近 12 个月 2 个）
## 中文简介
用于文档,教育和乐趣的交互式代码示例.
## 安装
```sh
npm install @antonz/codapi
```
也可以使用：`pnpm add @antonz/codapi`、`yarn add @antonz/codapi`、`bun add @antonz/codapi`
## README
# 交互式代码示例
_文献、教育和娱乐_ 🎉
将交互式代码片段直接嵌入您的产品文档,在线课程或博客文章中.
```
┌───────────────────────────────┐
│ def greet(name): │
│ print(f"Hello, {name}!") │
│ │
│ greet("World") │
└───────────────────────────────┘
Run ► Edit ✓ Done
┌───────────────────────────────┐
│ Hello, World! │
└───────────────────────────────┘
```
要点 :
- 将静态代码实例自动转换为迷你游戏场.
- 轻而易入.
- 用于任何编程语言,数据库,或软件的沙盒.
- 开源. 使用Apache -2.0许可.
有关科达皮的介绍,请参见此帖: [游戏和盈利的互动代码示例](https://antonz.org/code-examples/)。 。 。 .
## 安装
安装方式 `npm`数字 :
```
npm install @antonz/codapi
```
或使用CDN:
```html
```
可选样式 :
```html
```
## 使用量
见最适合您使用的指南 :
- [HTML/ 马可达](https://npmcn.com/package/%40antonz/codapi/docs/html.md)
- [多龙](https://npmcn.com/package/%40antonz/codapi/docs/docusaurus.md)
- [文档](https://npmcn.com/package/%40antonz/codapi/docs/docsify.md)
- [狮身人面像](https://github.com/uthcode/sphinxcontrib-coderun)
- [文字压力](https://npmcn.com/package/%40antonz/codapi/docs/wordpress.md)
- [标题](https://npmcn.com/package/%40antonz/codapi/docs/notion.md)
- [Dev.to/Medium/Substack/新闻通讯](https://npmcn.com/package/%40antonz/codapi/docs/code-links.md) (或不支持JavaScript嵌入的其他平台)
您还需要一个工作 Codapi 服务器, 无论是基于云的 [科达皮.org](https://codapi.org/) 或者说 [自动托管](https://github.com/nalgeon/codapi)。除非您正在使用浏览器游乐场(见下文).
## 高级特性
Codapi提供了一些超越简单代码操场的功能:
- [输出模式](https://npmcn.com/package/%40antonz/codapi/docs/output-modes.md) 用于显示图像、HTML碎片和交互式DOM.
- [模板](https://npmcn.com/package/%40antonz/codapi/docs/templates.md) 隐藏部分代码在幕后.
- [多文件](https://npmcn.com/package/%40antonz/codapi/docs/files.md) 游戏场.
- [自定义动作](https://npmcn.com/package/%40antonz/codapi/docs/custom-actions.md)。 。 。 .
- [代码单元格](https://npmcn.com/package/%40antonz/codapi/docs/code-cells.md) 一个像Jupyter笔记本的体验.
## 浏览者游乐场
大多数游乐场(如Go或PostgreSQL)在Codapi服务器上运行代码.
还有两个游乐场完全在浏览器中工作,不需要可达皮服务器—— [Java 脚本](https://npmcn.com/package/%40antonz/codapi/docs/browser-only.md#javascript) 财务报告和审定财务报表 [获取](https://npmcn.com/package/%40antonz/codapi/docs/browser-only.md#fetch)。 。 。 .
## 样式
部件默认为未设置 。 使用 `snippet.css` 用来做一些基本的造型 或者添加自己的.
以下是部件结构:
```html
Edit
✓ Done
Hello, World!
```
`codapi-snippet` 是顶级元素。 它包含工具栏(`codapi-toolbar`)和代码执行输出(`codapi-output`) (中文(简体) ). 工具栏包含运行 `button`,一个或多个动作按钮(`a`)和状态栏(`codapi-status`) (中文(简体) ).
## 支助
科达皮主要是一个 [一个人](https://antonz.org/) 项目,不由《维也纳公约》基金或任何东西支持.
如果您发现Codapi有用, 请在 GitHub 上显示, 并在您的同伴中传播这个词 。 这确实有助于推进项目.
页:1 [订阅](https://antonz.org/subscribe/) 以保留在新的特性之上.
## 常见问题
### @antonz/codapi 是什么？
用于文档,教育和乐趣的交互式代码示例\.
### 如何安装 @antonz/codapi？
在项目目录运行 npm install @antonz/codapi，或使用 pnpm add / yarn add / bun add。
### @antonz/codapi 支持 TypeScript 吗？
该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/antonz\_\_codapi 是否存在。
### @antonz/codapi 可以商用吗？
@antonz/codapi 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @antonz/codapi 的下载量有多少？
根据 npm 官方下载统计，@antonz/codapi 在 2026/10/06 – 2026/11/04 这 30 天内被下载 2,043 次，日均约 68 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @antonz/codapi 还在维护吗？
最新版本 0\.20\.1 发布于 2026/08/21（2 个月前）；至今共发布 58 个版本，其中过去 12 个月发布了 2 个；首次发布于 2023/08/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。