# @deepnote/blocks 中文文档

规范地址：https://npmcn.com/package/%40deepnote/blocks/

版本：5\.0\.0
npm 元数据更新时间：2026-11-05T11:39:39.951Z
中文译文更新时间：2026-11-11T20:29:08.562Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：551 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.14\.0
- 运行依赖：3 个
- 首次发布：2025-10-31T16:06:40.185Z
- 最新版本发布：2026-11-05T11:39:39.756Z
- 近 30 天下载量：11290（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 17 个）

## 中文简介

块包定义了"深 Note Blocks".

## 安装

```sh
npm install @deepnote/blocks
```

也可以使用：`pnpm add @deepnote/blocks`、`yarn add @deepnote/blocks`、`bun add @deepnote/blocks`

## README

# @deepnote/块

块包定义了"深 Note Blocks".

## 概览

这个软件包提供TypeScript类型和与Deepnote笔记本块合作的公用事业,包括:

-   **块类型**: 代码, SQL, 文本, Markdown, 输入, 可视化, 按钮, 大数字, 图像, 分隔符
-   **Python 代码生成**: 将块转换为可执行 Python 代码
-   **马克下调转换**: 将文本块转换为/从下标格式转换

## 支持的块类型

### 代码和数据块

-   **代码**: Python 代码执行
-   **坐标**: SQL 有可变任务查询执行

### 输入块

-   **输入文本**: 单行文本输入
-   **输入文本区域**: 多行文本输入
-   **输入检查框**: 布尔复选框
-   **输入选择**: 单一或多选择的下拉
-   **输入-滑动器**: 数字幻灯片
-   **输入文件**: 文件路径选择器
-   **输入日期**: 摘取日期器
-   **输入日期范围**: 有预设的日期范围( 过去7天, 过去一个月等)

### 显示块

-   **视觉**: 使用 Vega-Lite 的交互式图表
-   **枢轴表**: DataFrame (β) 的无码交叉抽取
-   **大数**: 带有 Jinja2 模板的 KPI 显示
-   **按钮**: 有可变控件的交互式按钮

### 文本下方块( Markdown) (Markdown)

-   **文本单元格-h1/h2/h3**页:1
-   **文本单元格p**: 段落
-   **文本单元格组合**: 项目符号列表
-   **文本单元格待办事宜**: 复选框
-   **文本单元格显示**: 突出说明
-   **分隔符**: 水平规则 (`<hr>`(中文(简体) )
-   **图像**: 有对齐和大小的嵌入图像

## 使用量

### Python 代码生成

```typescript
import { createPythonCode } from "@deepnote/blocks";

// Code block
const codeBlock = {
  type: "code",
  content: 'print("Hello, world!")',
  // ...
};
createPythonCode(codeBlock); // 'print("Hello, world!")'

// SQL block
const sqlBlock = {
  type: "sql",
  content: "SELECT * FROM users",
  metadata: {
    deepnote_variable_name: "df_users",
    sql_integration_id: "abc-123",
  },
  // ...
};
createPythonCode(sqlBlock);
// df_users = _dntk.execute_sql('SELECT * FROM users', 'SQL_ABC_123', ...)

// Input checkbox
const checkboxBlock = {
  type: "input-checkbox",
  metadata: {
    deepnote_variable_name: "is_enabled",
    deepnote_variable_value: true,
  },
  // ...
};
createPythonCode(checkboxBlock); // is_enabled = True

// Input date range
const dateRangeBlock = {
  type: "input-date-range",
  metadata: {
    deepnote_variable_name: "date_range",
    deepnote_variable_value: "past7days",
  },
  // ...
};
createPythonCode(dateRangeBlock);
// from datetime import datetime as _deepnote_datetime, timedelta as _deepnote_timedelta
// date_range = [_deepnote_datetime.now().date() - _deepnote_timedelta(days=7), ...]
```

### 马克下调转换

```typescript
import { createMarkdown, stripMarkdown } from "@deepnote/blocks";

const headingBlock = {
  type: "text-cell-h1",
  content: "Main Title",
  // ...
};

const markdown = createMarkdown(headingBlock); // "# Main Title"
const plainText = stripMarkdown(headingBlock); // "Main Title"

const todoBlock = {
  type: "text-cell-todo",
  content: "Complete task",
  metadata: { checked: true },
  // ...
};

createMarkdown(todoBlock); // "- [x] Complete task"

const separatorBlock = {
  type: "separator",
  content: "",
  // ...
};

createMarkdown(separatorBlock); // "<hr>"

const imageBlock = {
  type: "image",
  content: "",
  metadata: {
    deepnote_img_src: "https://example.com/image.png",
    deepnote_img_width: "500",
    deepnote_img_alignment: "center",
  },
  // ...
};

createMarkdown(imageBlock); // '<img src="https://example.com/image.png" width="500" align="center" />'
```

## 常见问题

### @deepnote/blocks 是什么？

块包定义了"深 Note Blocks"\.

### 如何安装 @deepnote/blocks？

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

### @deepnote/blocks 支持 TypeScript 吗？

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

### @deepnote/blocks 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @deepnote/blocks 需要什么版本的 Node\.js？

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

### @deepnote/blocks 可以商用吗？

@deepnote/blocks 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @deepnote/blocks 的下载量有多少？

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

### @deepnote/blocks 还在维护吗？

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