@bendyline/squisq (英语)

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

部分 斯奎斯克语Name 单相机.

安装

npm install @bendyline/squisq

里面的东西

此发行中新建

斯奎格利广场降分标准(见 docs/SquigglySquare.md) 获得若干编写能力:

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

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

子路径导入

只导入您需要的 :

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';

或从根入一切相

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

快速示例

解析标记

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 将丢出. 它具有专有性,不总结文章或删除引文.

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

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 元数据 控制高密度点上的标签或抑制标签.

## 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() 生成全球对齐的活动位置,同时保留 最初的栅栏字节用于标记下回转.

空间公用事业

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);

实现块

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.

主题系统

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);

相关软件包

许可证

麻省理工学院