# @calumk/editorjs-codecup 中文文档

规范地址：https://npmcn.com/package/%40calumk/editorjs-codecup/

版本：1\.3\.0
npm 元数据更新时间：2025-03-09T17:41:48.627Z
中文译文更新时间：2026-11-09T00:13:14.700Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.7 MB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2024-01-11T18:44:08.428Z
- 最新版本发布：2025-03-09T17:41:48.472Z
- 近 30 天下载量：27297（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

代码, 用于编辑器JS

## 安装

```sh
npm install @calumk/editorjs-codecup
```

也可以使用：`pnpm add @calumk/editorjs-codecup`、`yarn add @calumk/editorjs-codecup`、`bun add @calumk/editorjs-codecup`

## README

# 编辑器Js - 代码Cup

### 国家预防机制

```
npm i @calumk/editorjs-codecup
```

### 联合来文

```
https://cdn.jsdelivr.net/npm/@calumk/editorjs-codecup@latest
```

* * *

## 关于

这是编辑器Js的包装 [代码Cup](https://github.com/calumk/codecup) - 一个可爱的轻量级零分码

它是为了改进:

-   [https://github.com/editor-js/码](https://github.com/editor-js/code) - 太简单了
-   [https://github.com/dev-juju/codebox 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/dev-juju/codebox) - 主动性定型,出口的数据比降能处理的数据多

## 演示

![Demo ](https://npmcn.com/package/%40calumk/editorjs-codecup/example-media/example2.gif)

## 以下列方式建造:

-   [代码Cup](https://github.com/calumk/codecup)
-   [棱镜](https://www.npmjs.com/package/prismjs)

* * *

## 安装/ 使用

```javascript
import EditorJS from '@editorjs/editorjs';
import editorjsCodecup from '@calumk/editorjs-codecup';

var editor = new EditorJS({
  // ...
  tools: {
    ...
    code : editorjsCodecup
  },
});
```

### 语言选择

该插件提供了两种处理语言选择的方法:

1.  **自由形式语言输入**:默认情况下(当没有配置语言时),用户可以通过文本输入输入输入任何有效的Prism.js语言密钥.
    
2.  **预定义语言下移**: 当提供语言配置时,用户可以通过下放菜单从预定义的语言列表中选择.
    

您可以使用这些选项配置语言选择行为 :

#### 预定义语言

提供 Prism.js 语言密钥的自定义映射 :

```javascript
var editor = new EditorJS({
  // ...
  tools: {
    code: {
      class: editorJsCodeCup,
      config: {
        languages: { 
          javascript: "JavaScript",
          python: "Python",
          java: "Java",
          cpp: "C++",
          csharp: "C#",
          go: "Go",
          none: "Plain Text",
        }
      } 
    }
  },
});
```

#### 强制显示语言输入

如果您想要同时允许预定义的语言选择和自由形式的语言输入,请使用 `forceShowLanguageInput` 选项 :

```javascript
var editor = new EditorJS({
  // ...
  tools: {
    code: {
      class: editorJsCodeCup,
      config: {
        languages: { 
          javascript: "JavaScript",
          python: "Python",
          // ... other languages
        },
        forceShowLanguageInput: true // Shows both dropdown and language input
      } 
    }
  },
});
```

参见 [Prism.js 支持语言](https://prismjs.com/#supported-languages) 用于可用语言映射.

## 数据格式

从该区块进口/出口的数据如下:

| 名称 | 说明 |
| --- | --- |
| 代码 | 在编辑器中显示的代码, 有换行符 |
| 语言(可选) | 编程语言 |
| 显示行号( 可选) | 显示/隐藏行号( 默认为真) |
| 显示 Copy按钮( 可选) | 将显示/ 隐藏副本按钮( 默认为真) |

由于语言和行号是可选的 `code` 块可以使用此插件

* * *

## 捐款

@ calumk (帮助)

@keertyverma (歌词)

## 常见问题

### @calumk/editorjs-codecup 是什么？

代码, 用于编辑器JS

### 如何安装 @calumk/editorjs-codecup？

在项目目录运行 npm install @calumk/editorjs-codecup，或使用 pnpm add / yarn add / bun add。

### @calumk/editorjs-codecup 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/calumk\_\_editorjs-codecup 是否存在。

### @calumk/editorjs-codecup 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @calumk/editorjs-codecup 可以商用吗？

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

### @calumk/editorjs-codecup 的下载量有多少？

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

### @calumk/editorjs-codecup 还在维护吗？

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