@airalogy/aimd-renderer 2.5.0 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/README.md +6 -5
  2. package/README.zh-CN.md +6 -5
  3. package/dist/aimd-renderer.css +1 -1
  4. package/dist/common/processor.d.ts.map +1 -1
  5. package/dist/common/unified-token-renderer.d.ts.map +1 -1
  6. package/dist/html.js +1 -1
  7. package/dist/index.d.ts +1 -1
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +262 -217
  10. package/dist/{processor-B2mByErv.js → processor-CHbNEcN8.js} +2687 -2094
  11. package/dist/vue/index.d.ts +1 -1
  12. package/dist/vue/index.d.ts.map +1 -1
  13. package/dist/vue/vue-renderer.d.ts +22 -1
  14. package/dist/vue/vue-renderer.d.ts.map +1 -1
  15. package/dist/vue.js +10 -9
  16. package/package.json +6 -6
  17. package/src/__tests__/renderer.test.ts +191 -1
  18. package/src/common/processor.ts +173 -41
  19. package/src/common/unified-token-renderer.ts +104 -24
  20. package/src/index.ts +3 -0
  21. package/src/styles/katex.css +109 -0
  22. package/src/vue/index.ts +3 -0
  23. package/src/vue/vue-renderer.ts +318 -48
package/README.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # @airalogy/aimd-renderer
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/%40airalogy%2Faimd-renderer?logo=npm&color=cb3837)](https://www.npmjs.com/package/@airalogy/aimd-renderer)
4
- [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/airalogy/aimd/blob/main/LICENSE)
4
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/airalogy/airalogy/blob/main/LICENSE)
5
5
 
6
6
  Rendering engine for AIMD (Airalogy Markdown): HTML output, Vue output, and field extraction.
7
7
 
8
8
  Assigner blocks are hidden from normal rendered output by default. You can opt into collapsed or expanded assigner display when building authoring/debug views, while extracted field metadata remains available through `parseAndExtract`.
9
9
  `parseAndExtract` returns the canonical core field structure, including simple `var` metadata in `fields.var_definitions`.
10
+ Default `var` and `var_table` previews render AIMD `title`, preserve the canonical field id for automation, and expose `description` plus `example`/`examples` details only on hover or keyboard focus.
10
11
 
11
12
  > Protocol-level AIMD syntax, assigner semantics, and validation rules are normative in Airalogy docs. `@airalogy/aimd-*` docs describe how the frontend parser, renderer, and recorder implement those rules.
12
13
 
@@ -21,7 +22,7 @@ pnpm add @airalogy/aimd-renderer @airalogy/aimd-core
21
22
  ```ts
22
23
  import { renderToHtml, parseAndExtract } from "@airalogy/aimd-renderer"
23
24
 
24
- const content = "{{step|sample_preparation}}"
25
+ const content = '{{var|sample_name: str, title="Sample name", description="Human-readable sample label", examples=["S-001"]}}'
25
26
  const { html } = await renderToHtml(content)
26
27
  const fields = parseAndExtract(content)
27
28
 
@@ -100,9 +101,9 @@ Use `@airalogy/aimd-renderer/styles` only if you want to preload styles manually
100
101
 
101
102
  ## Documentation
102
103
 
103
- - EN: <https://airalogy.github.io/aimd/en/packages/aimd-renderer>
104
- - 中文: <https://airalogy.github.io/aimd/zh/packages/aimd-renderer>
105
- - Source docs: `aimd/docs/en/packages/aimd-renderer.md`, `aimd/docs/zh/packages/aimd-renderer.md`
104
+ - EN: <https://airalogy.github.io/airalogy/aimd/en/packages/aimd-renderer>
105
+ - 中文: <https://airalogy.github.io/airalogy/aimd/zh/packages/aimd-renderer>
106
+ - Source docs: `docs/aimd/en/packages/aimd-renderer.md`, `docs/aimd/zh/packages/aimd-renderer.md`
106
107
 
107
108
  ## Citation
108
109
 
package/README.zh-CN.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # @airalogy/aimd-renderer
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/%40airalogy%2Faimd-renderer?logo=npm&color=cb3837)](https://www.npmjs.com/package/@airalogy/aimd-renderer)
4
- [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/airalogy/aimd/blob/main/LICENSE)
4
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/airalogy/airalogy/blob/main/LICENSE)
5
5
 
6
6
  AIMD（Airalogy Markdown）渲染引擎：支持 HTML 渲染、Vue 渲染与字段提取。
7
7
 
8
8
  默认情况下，assigner 代码块不会出现在普通渲染输出中。只有在作者视图或调试视图中显式开启时，才会以折叠或展开形式显示；`parseAndExtract` 仍会保留相关字段元数据。
9
9
  `parseAndExtract` 返回 core 的规范字段结构，其中也包括 `fields.var_definitions` 里的普通 `var` 元数据。
10
+ 默认的 `var` 和 `var_table` 预览会渲染 AIMD 的 `title`，保留用于自动化的规范字段 id，并且只在 hover 或键盘 focus 时展示 `description` 与 `example`/`examples` 详情。
10
11
 
11
12
  > 协议级 AIMD 语法、assigner 语义与校验规则以 Airalogy 文档为准；`@airalogy/aimd-*` 文档只描述前端 parser、renderer、recorder 如何实现这些规范。
12
13
 
@@ -21,7 +22,7 @@ pnpm add @airalogy/aimd-renderer @airalogy/aimd-core
21
22
  ```ts
22
23
  import { renderToHtml, parseAndExtract } from "@airalogy/aimd-renderer"
23
24
 
24
- const content = "{{step|sample_preparation}}"
25
+ const content = '{{var|sample_name: str, title="样本名", description="样本的人类可读标签", examples=["S-001"]}}'
25
26
  const { html } = await renderToHtml(content)
26
27
  const fields = parseAndExtract(content)
27
28
 
@@ -100,6 +101,6 @@ const { nodes } = await renderToVue(content, {
100
101
 
101
102
  ## 文档
102
103
 
103
- - EN: <https://airalogy.github.io/aimd/en/packages/aimd-renderer>
104
- - 中文: <https://airalogy.github.io/aimd/zh/packages/aimd-renderer>
105
- - 文档源码：`aimd/docs/en/packages/aimd-renderer.md`、`aimd/docs/zh/packages/aimd-renderer.md`
104
+ - EN: <https://airalogy.github.io/airalogy/aimd/en/packages/aimd-renderer>
105
+ - 中文: <https://airalogy.github.io/airalogy/aimd/zh/packages/aimd-renderer>
106
+ - 文档源码：`docs/aimd/en/packages/aimd-renderer.md`、`docs/aimd/zh/packages/aimd-renderer.md`