# @bendyline/squisq 中文文档

规范地址：https://npmcn.com/package/%40bendyline/squisq/

版本：2\.13\.14
npm 元数据更新时间：2026-11-07T19:46:18.322Z
中文译文更新时间：2026-11-07T22:03:42.870Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：2.9 MB，98 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.22\.2 \|\| ^24\.15\.0 \|\| \>=26\.0\.0
- 运行依赖：12 个
- 首次发布：2026-03-16T02:10:08.523Z
- 最新版本发布：2026-11-07T19:46:17.882Z
- 近 30 天下载量：8457（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：76（近 12 个月 76 个）

## 中文简介

用于 doc/块渲染、空间数学、Markdown和存储的无头公用事业

## 安装

```sh
npm install @bendyline/squisq
```

也可以使用：`pnpm add @bendyline/squisq`、`yarn add @bendyline/squisq`、`bun add @bendyline/squisq`

## README

# @bendyline/squisq (英语)

用于Doc/block渲染、空间数学、Markdown剖析和存储的无头工具。 框架不可知性——在浏览器或Node.js中运行,零框架依赖.

部分 [斯奎斯克语Name](https://github.com/bendyline/squisq) 单相机.

[![npm](https://img.shields.io/npm/v/@bendyline/squisq)](https://www.npmjs.com/package/@bendyline/squisq) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bendyline/squisq/blob/main/LICENSE)

## 安装

```bash
npm install @bendyline/squisq
```

## 里面的东西

| 模块 | 说明 |
| --- | --- |
| **计划** | 类型定义 - `Doc`, (中文(简体) ), `BlockTemplate`, (中文(简体) ), `Viewport`, (中文(简体) ), `Theme`, (中文(简体) ), `LayoutStrategy` |
| **医生** | 模板登记、26个块模板、动画/主题公用事业 |
| **减值** | 标记下解析、 字符串、 AST 类型( Q)`MarkdownDocument`),树木公用事业 |
| **空间** | Haversine 距离和轴承, 大圆形路径, Geohash 编码/解码 |
| **存储** | `StorageAdapter` 接口、 内存 + 本地版本 + 本地格式适配器 |

## 此发行中新建

斯奎格利广场降分标准(见 [`docs/SquigglySquare.md`](https://github.com/bendyline/squisq/blob/main/docs/SquigglySquare.md)) 获得若干编写能力:

-   **[单独说明](https://github.com/bendyline/squisq/blob/main/docs/SquigglySquare.md#standalone-annotations)** - 一个顶级的段落,正是 `{[templateName …]}` 成为无标题的模板块;后面的正文是其内容.
-   **[内在属性强制](https://github.com/bendyline/squisq/blob/main/docs/SquigglySquare.md#inline-attribute-coercion)** —— 说 `{[map center="47.6,-122.3" zoom=9]}` 财务报告和审定财务报表 `{[twoColumn left="Espresso|Bold"]}` 现在无需数据栏即可渲染(通过 `TEMPLATE_INPUT_DESCRIPTORS`) (中文(简体) ).
-   **[审定](https://github.com/bendyline/squisq/blob/main/docs/SquigglySquare.md#validation)** ——新设 `unknown-input` 编号 : `invalid-input-value` 编号 : `missing-input` 警告加进 `possible-data-fence` 编号 : `conflicting-annotation-key` 信息诊断(新的) `info` (a) 与《公约》第2条(a)项有关的问题.
-   **[YAML 数据栅栏](https://github.com/bendyline/squisq/blob/main/docs/SquigglySquare.md#structured-data-fences)** 现在接受一级嵌入式绘图(a) `map` `center` 可以纯YAML).
-   **[多行前题](https://github.com/bendyline/squisq/blob/main/docs/SquigglySquare.md#multi-line-frontmatter)** —— 说 `squisq-custom-templates` 编号 : `squisq-custom-themes` 可以通过 YAML 字形块 scalars 被写作为漂亮的 JSON(`key: |-`) (中文(简体) ).
-   **自定义模板符号 v2** (见 [`docs/SquigglySquare.md`](https://github.com/bendyline/squisq/blob/main/docs/SquigglySquare.md),"注册自定义模板")- `{attr:key}`,每个符号都有管道默认值,每层 `repeat` 与 `{item}` 编号 : `{index}` 标志.

新设 `@bendyline/squisq/doc` 出口: `coerceTemplateParams`, (中文(简体) ), `lintTemplateParams`, (中文(简体) ), `TEMPLATE_INPUT_DESCRIPTORS`,以及 `replaceDataFence`。 。 。 .

## 子路径导入

只导入您需要的 :

```ts
import type { Doc, BlockTemplate, Theme } from '@bendyline/squisq/schemas';
import { materializeBlockLayers, expandDocBlocks } from '@bendyline/squisq/doc';
import { parseMarkdown, stringifyMarkdown } from '@bendyline/squisq/markdown';
import { encodeGeohash, haversineDistance } from '@bendyline/squisq/spatial';
import { LocalStorageAdapter } from '@bendyline/squisq/storage';
```

或从根入一切相

```ts
import { parseMarkdown, haversineDistance, materializeBlockLayers } from '@bendyline/squisq';
```

## 快速示例

### 解析标记

```ts
import { parseMarkdown, stringifyMarkdown } from '@bendyline/squisq/markdown';

const doc = parseMarkdown('# Hello\n\nSome content');
console.log(doc.children); // AST nodes

const md = stringifyMarkdown(doc);
```

### 已导入 Markdown

`condenseMarkdownSource(source)` 删除表格对齐编码, 缩短 GFM分界线行,并减少装饰性主题断开为三个标记. 它保留了表格单元格和对齐,代码,数学,HTML,链接,脚注, 传言和前题 与 ; 如果无法证明等同性, API 将丢出. 它具有专有性,不总结文章或删除引文.

在链接/图像编辑后运行缩放,可以将加成表重新序列化.

```ts
import { condenseMarkdownSource } from '@bendyline/squisq/markdown';

const compactMarkdown = condenseMarkdownSource(importedMarkdown);
```

共享源转换登记册也暴露 `condense`,从 编辑器的变形菜单和 `squisq transform file.md --ops condense`。 。 。 .

### 作者 ASCII 时间线

时间线栅栏是真实的标记来源。 Unicode 标记为 自动检测; 清晰 `timeline` 语言也接受稀疏/ASCII 表单。 重复多个音轨的轨迹并使用事件代号 `branch:` 线条 用于叉或跨道链接。 在后面添加较长的点名文字 `::`; 可选 `side=above|below`, (中文(简体) ), `descriptionSide=above|below`,以及 `callout=false` 元数据 控制高密度点上的标签或抑制标签.

````markdown
## Runtime timing

```timeline
Kernel: ● T28 :: Δ28 {#t28 side=above descriptionSide=below} ─────● T29 {#t29} ─────● T30 {#t30} ───►
Client: ──────────────────● Frame A {#frame-a} ───● Frame B {#frame-b} ───►
branch: t29 -> frame-a : interpolate
```
````

`markdownToDoc()` 生成全球对齐的活动位置,同时保留 最初的栅栏字节用于标记下回转.

### 空间公用事业

```ts
import {
  destinationPoint,
  encodeGeohash,
  haversineDistance,
  sampleGreatCircle,
} from '@bendyline/squisq/spatial';

const distanceKm = haversineDistance({ lat: 47.6, lng: -122.3 }, { lat: 37.7, lng: -122.4 });
const hash = encodeGeohash(47.6, -122.3, 7);

// Points along the shortest route, and a position projected 5 km due east.
const route = sampleGreatCircle({ lat: 47.6, lng: -122.3 }, { lat: 51.5, lng: -0.1 }, 20);
const ahead = destinationPoint({ lat: 47.6, lng: -122.3 }, 90, 5_000);
```

### 实现块

```ts
import { materializeBlockLayers } from '@bendyline/squisq/doc';

const result = materializeBlockLayers(block, {
  theme,
  viewport,
  customTemplates: doc.customTemplates,
});

render(result.layers);
if (result.diagnostic) report(result.diagnostic);
```

Cononical 实现器处理作者的层层,内置和文档范围 模板,主题运动,和持久地分层. 失败模板生成 a 默认情况下可见倒置加结构化诊断;通过 `failureMode: 'empty'` 当一个主机故意想要不退缩 UI.

### 主题系统

```ts
import {
  compileTheme,
  createThemeRegistry,
  getAvailableThemes,
  resolveTheme,
} from '@bendyline/squisq/schemas';

const themes = getAvailableThemes(); // 11 built-in themes
const theme = resolveTheme('cinematic');

// Host-level custom themes live in an explicit caller-owned registry.
const registry = createThemeRegistry([
  compileTheme({ id: 'brand', name: 'Brand', seedColors: { primary: '#6633cc' } }),
]);
const brand = resolveTheme('brand', registry);
```

## 相关软件包

| 软件包 | 说明 |
| --- | --- |
| [@bendyline/squisq-反应](https://www.npmjs.com/package/@bendyline/squisq-react) | 渲染道克的反应组件 |
| [@bendyline/squisq-formats (中文(简体) )](https://www.npmjs.com/package/@bendyline/squisq-formats) | DOCX, PDF, HTML 导入/导出 |
| [@bendyline/squisq-editor-反应](https://www.npmjs.com/package/@bendyline/squisq-editor-react) | 使用原始/ WYSIWYG/ 预览模式进行反应编辑器 |

## 许可证

[麻省理工学院](https://github.com/bendyline/squisq/blob/main/LICENSE)

## 常见问题

### @bendyline/squisq 是什么？

用于 doc/块渲染、空间数学、Markdown和存储的无头公用事业

### 如何安装 @bendyline/squisq？

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

### @bendyline/squisq 支持 TypeScript 吗？

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

### @bendyline/squisq 支持 ESM 还是 CommonJS？

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

### @bendyline/squisq 需要什么版本的 Node\.js？

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

### @bendyline/squisq 可以商用吗？

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

### @bendyline/squisq 的下载量有多少？

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

### @bendyline/squisq 还在维护吗？

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