@isdk/mdast-plus 0.1.1 → 0.1.3

package/docs/README.md

@@ -15,12 +15,13 @@ English | [简体中文](_media/README.cn.md) | [GitHub](https://github.com/isdk
 ## Features
 
 - **Fluent API**: Chainable interface `mdast(input).use(plugin).toHTML()`.
-- **Staged Plugins**: Organize transformations into `normalize`, `compile`, and `finalize` stages with priority ordering.
+- **Staged Plugins**: Organize transformations into `parse`, `normalize`, `compile`, `finalize`, and `stringify` stages.
 - **Semantic Normalization**:
   - **Directives**: Canonicalizes admonition names and extracts titles from labels.
   - **Table Spans**: Support for `rowspan` and `colspan` in HTML output.
   - **Code Meta**: Structured parsing of code block metadata strings.
   - **Image Sizing**: URL "sugar" support (e.g., `image.png#=500x300`) for image dimensions.
+  - **Inline Styles**: Built-in support for `==Highlight==`, `~Subscript~`, and `^Superscript^`.
 - **Deeply Typed**: Built on TypeScript with full support for unist/mdast module augmentation.
 
 ## Installation
@@ -43,6 +44,17 @@ const html = await mdast(':::warning[Special Note]\nBe careful!\n:::')
 // Result: <div title="Special Note" class="warning"><p>Be careful!</p></div>
 ```
 
+### Configure Input Options
+
+You can pass options to input plugins (like `remark-gfm` or `remark-parse`) using the second argument of `.from()`:
+
+```typescript
+// Enable single tilde strikethrough (~text~)
+const md = await mdast('Hello ~world~')
+  .from('markdown', { remarkGfm: { singleTilde: true } })
+  .toMarkdown();
+```
+
 ### Image Sizing
 
 ```typescript
@@ -50,36 +62,64 @@ const html = await mdast('![Cat](cat.png#=500x300)').toHTML();
 // Result: <img src="cat.png" alt="Cat" width="500" height="300">
 ```
 
+### AST Output
+
+```typescript
+// Get the fully processed AST (after normalization)
+const ast = await mdast('==Highlighted==').toAST();
+
+// Get the raw AST (after parsing, before normalization)
+const rawAst = await mdast('==Highlighted==').toAST({ stage: 'parse' });
+```
+
 ### Advanced Pipeline
 
 ```typescript
 const { content, assets } = await mdast(myInput)
   .data({ myGlobal: 'value' })
-  .use({
-    name: 'my-plugin',
-    stage: 'compile',
-    transform: async (tree) => {
-      // transform the AST
-    }
-  })
+  // Add a custom plugin at the 'compile' stage
+  .useAt('compile', myPlugin, { option: 1 })
+  .priority(10) // Run later than default plugins
   .to('html');
 ```
 
+### Plugin Behavior
+
+`mdast-plus` uses [unified](https://github.com/unifiedjs/unified) internally. If you add the same plugin function multiple times, the last configuration **overrides** the previous ones.
+
+```typescript
+// The plugin will run ONCE with option: 2
+pipeline.use(myPlugin, { option: 1 });
+pipeline.use(myPlugin, { option: 2 });
+```
+
+To run the same plugin logic multiple times (e.g., for different purposes), provide a distinct function reference:
+
+```typescript
+// The plugin will run TWICE
+pipeline.use(myPlugin, { option: 1 });
+pipeline.use(myPlugin.bind({}), { option: 2 });
+```
+
 ### Arbitrary Formats
 
 You can register custom input or output formats:
 
 ```typescript
-import { FluentProcessor, mdast } from '@isdk/mdast-plus';
+import { MdastPipeline, mdast, PipelineStage } from '@isdk/mdast-plus';
 
 // Register a custom output format
-FluentProcessor.registerFormat('reverse', {
-  stringify: (p) => {
-    p.Compiler = (tree) => {
-      // your custom stringification logic
-      return '...';
-    };
-  }
+MdastPipeline.register({
+  id: 'reverse',
+  output: [{
+    plugin: function() {
+      this.Compiler = (tree) => {
+        // your custom stringification logic
+        return '...';
+      };
+    },
+    stage: PipelineStage.stringify
+  }]
 });
 
 const result = await mdast('Hello').to('reverse');
@@ -91,9 +131,11 @@ const result = await mdast('Hello').to('reverse');
 
 Plugins are executed based on their `stage` and `order`:
 
-1.  **normalize** (order 0-100): Cleanup and canonicalize the tree.
-2.  **compile** (order 0-100): High-level semantic transformations.
-3.  **finalize** (order 0-100): Final preparation before output.
+1.  **parse** (0): Input parsing (e.g., `remark-parse`).
+2.  **normalize** (100): Cleanup and canonicalize the tree.
+3.  **compile** (200): High-level semantic transformations.
+4.  **finalize** (300): Final preparation before output (e.g. `rehype-sanitize`).
+5.  **stringify** (400): Output generation.
 
 ## Core Plugins Included
 
@@ -103,6 +145,7 @@ Plugins are executed based on their `stage` and `order`:
 | `normalize-table-span` | normalize | Migrates table cell spans to `hProperties`. |
 | `extract-code-meta` | normalize | Parses `title="foo"` from code block meta. |
 | `image-size` | normalize | Parses `#=WxH` from image URLs. |
+| `normalize-inline-styles` | normalize | Standardizes `==mark==`, `~sub~`, and `^sup^`. |
 
 ## Contributing
 

package/docs/_media/CONTRIBUTING.md

@@ -8,11 +8,13 @@ Thank you for your interest in contributing to `@isdk/mdast-plus`! This document
 
 ### Core Concepts
 
-1.  **Fluent API**: The main entry point is the `mdast()` function in `src/pipeline.ts`.
-2.  **Staged Plugins**: Plugins are categorized into three stages:
+1.  **Fluent API**: The main entry point is the `mdast()` function in `src/pipeline.ts`, backed by `MdastPipeline`.
+2.  **Staged Plugins**: Plugins are categorized into 5 stages (`PipelineStage`):
+    *   `parse`: Parsing input to AST.
     *   `normalize`: Cleanup and canonicalize the tree.
     *   `compile`: High-level semantic transformations.
     *   `finalize`: Final preparation before output.
+    *   `stringify`: Serializing AST to output.
 3.  **Universal Data Protocols**: Nodes use `node.data` for metadata, and `node.data.hProperties` for HTML attributes.
 
 ## Getting Started
@@ -55,39 +57,58 @@ pnpm run lint
 ## Adding a New Plugin
 
 1.  Create your plugin in `src/plugins/`.
-2.  Implement the `MdastPlugin` interface:
+2.  Implement the `MdastPlugin` interface. The `plugin` property should be a standard unified plugin.
 
 ```typescript
-import { MdastPlugin } from '../types';
+import { MdastPlugin, PipelineStage } from '../types';
+import { visit } from 'unist-util-visit';
+
+const myUnifiedPlugin = (options) => {
+  return (tree) => {
+    visit(tree, 'text', (node) => {
+      // transform logic
+    });
+  };
+};
 
 export const myPlugin: MdastPlugin = {
-  name: 'my-plugin',
-  stage: 'normalize', // 'normalize' | 'compile' | 'finalize'
+  plugin: myUnifiedPlugin,
+  stage: PipelineStage.normalize, // or 'compile', 'finalize'
   order: 50,          // 0-100
-  transform: async (tree, processor) => {
-    // Visit nodes and transform the tree
-  }
 };
 ```
 
-3.  Register your plugin in `src/pipeline.ts` in the `FluentProcessor` constructor if it should be a default plugin.
+3.  If it's a default plugin, add it to the `input` or `output` list of the relevant format in `src/formats/`.
 
 ## Adding a New Format
 
-1. Implement the `MdastFormatDefinition` interface.
-2. Register it using `FluentProcessor.registerFormat(name, definition)`.
+1. Define a `MdastFormat` object.
+2. Register it using `MdastPipeline.register(format)`.
 
 ```typescript
-import { FluentProcessor } from '../pipeline';
-
-FluentProcessor.registerFormat('json', {
-  stringify: (processor) => {
-    processor.Compiler = (tree) => JSON.stringify(tree);
-  }
+import { MdastPipeline, PipelineStage } from '../src/pipeline';
+
+MdastPipeline.register({
+  id: 'json',
+  title: 'JSON Format',
+  output: [{
+    plugin: function() {
+      this.Compiler = (tree) => JSON.stringify(tree);
+    },
+    stage: PipelineStage.stringify
+  }]
 });
 ```
 
 > **Note**: Format names are case-insensitive.
+>
+> **Important**: `unified` requires a `Compiler` to be attached for the process to complete successfully. If your format is intended to return an object (like the AST itself) rather than a string, you must provide a "pass-through" compiler:
+>
+> ```typescript
+> function astCompiler() {
+>   this.Compiler = (tree) => tree;
+> }
+> ```
 
 ## Coding Standards
 

package/docs/_media/README.cn.md

@@ -11,12 +11,13 @@
 ## 特性
 
 - **Fluent API**: 链式调用接口 `mdast(input).use(plugin).toHTML()`。
-- **分阶段插件**: 将转换组织为 `normalize`、`compile` 和 `finalize` 阶段，支持优先级排序。
+- **分阶段插件**: 将转换组织为 `parse`, `normalize`, `compile`, `finalize` 和 `stringify` 阶段。
 - **语义化规范**:
   - **指令 (Directives)**: 规范化提示框 (Admonition) 名称并从标签中提取标题。
   - **表格跨行/跨列**: 支持 HTML 输出中的 `rowspan` 和 `colspan`。
   - **代码元数据**: 对代码块元数据字符串进行结构化解析。
   - **图片尺寸**: 支持 URL 糖语法 (例如 `image.png#=500x300`) 来设置图片尺寸。
+  - **行内样式**: 内置对 `==高亮==`、`~下标~` 和 `^上标^` 的支持。
 - **深度类型支持**: 基于 TypeScript 构建，完整支持 unist/mdast 的模块扩充。
 
 ## 安装
@@ -39,6 +40,17 @@ const html = await mdast(':::warning[重要提示]\n请小心！\n:::')
 // 结果: <div title="重要提示" class="warning"><p>请小心！</p></div>
 ```
 
+### 配置输入选项
+
+您可以通过 `.from()` 的第二个参数向输入插件（如 `remark-gfm` 或 `remark-parse`）传递选项：
+
+```typescript
+// 启用单个波浪线删除线 (~text~)
+const md = await mdast('Hello ~world~')
+  .from('markdown', { remarkGfm: { singleTilde: true } })
+  .toMarkdown();
+```
+
 ### 图片尺寸
 
 ```typescript
@@ -46,36 +58,64 @@ const html = await mdast('![Cat](cat.png#=500x300)').toHTML();
 // 结果: <img src="cat.png" alt="Cat" width="500" height="300">
 ```
 
+### AST 输出
+
+```typescript
+// 获取处理后的完整 AST (在 normalization 之后)
+const ast = await mdast('==高亮内容==').toAST();
+
+// 获取原始 AST (在 parse 之后, normalization 之前)
+const rawAst = await mdast('==高亮内容==').toAST({ stage: 'parse' });
+```
+
 ### 高级工作流
 
 ```typescript
 const { content, assets } = await mdast(myInput)
   .data({ myGlobal: 'value' })
-  .use({
-    name: 'my-plugin',
-    stage: 'compile',
-    transform: async (tree) => {
-      // 转换 AST
-    }
-  })
+  // 在 'compile' 阶段添加自定义插件
+  .useAt('compile', myPlugin, { option: 1 })
+  .priority(10) // 比默认插件更晚执行
   .to('html');
 ```
 
+### 插件行为
+
+`mdast-plus` 内部使用 [unified](https://github.com/unifiedjs/unified)。如果您多次添加同一个插件函数，最后的配置将**覆盖**之前的配置。
+
+```typescript
+// 插件将只执行一次，且选项为: 2
+pipeline.use(myPlugin, { option: 1 });
+pipeline.use(myPlugin, { option: 2 });
+```
+
+若要多次运行相同的插件逻辑（例如用于不同目的），请提供不同的函数引用：
+
+```typescript
+// 插件将执行两次
+pipeline.use(myPlugin, { option: 1 });
+pipeline.use(myPlugin.bind({}), { option: 2 });
+```
+
 ### 任意格式支持
 
 您可以注册自定义的输入或输出格式：
 
 ```typescript
-import { FluentProcessor, mdast } from '@isdk/mdast-plus';
+import { MdastPipeline, mdast, PipelineStage } from '@isdk/mdast-plus';
 
 // 注册自定义输出格式
-FluentProcessor.registerFormat('reverse', {
-  stringify: (p) => {
-    p.Compiler = (tree) => {
-      // 您的自定义序列化逻辑
-      return '...';
-    };
-  }
+MdastPipeline.register({
+  id: 'reverse',
+  output: [{
+    plugin: function() {
+      this.Compiler = (tree) => {
+        // 您的自定义序列化逻辑
+        return '...';
+      };
+    },
+    stage: PipelineStage.stringify
+  }]
 });
 
 const result = await mdast('Hello').to('reverse');
@@ -87,9 +127,11 @@ const result = await mdast('Hello').to('reverse');
 
 插件根据它们的 `stage` (阶段) 和 `order` (顺序) 执行：
 
-1.  **normalize** (order 0-100): 清理并规范化树。
-2.  **compile** (order 0-100): 高级语义转换。
-3.  **finalize** (order 0-100): 输出前的最后准备。
+1.  **parse** (0): 输入解析 (例如 `remark-parse`)。
+2.  **normalize** (100): 清理并规范化树。
+3.  **compile** (200): 高级语义转换。
+4.  **finalize** (300): 输出前的最后准备 (例如 `rehype-sanitize`)。
+5.  **stringify** (400): 输出生成。
 
 ## 内置核心插件
 
@@ -99,6 +141,7 @@ const result = await mdast('Hello').to('reverse');
 | `normalize-table-span` | normalize | 将表格单元格跨度迁移到 `hProperties`。 |
 | `extract-code-meta` | normalize | 从代码块元数据中解析 `title="foo"`。 |
 | `image-size` | normalize | 从图片 URL 中解析 `#=WxH`。 |
+| `normalize-inline-styles` | normalize | 标准化 `==mark==`、`~sub~` 和 `^sup^`。 |
 
 ## 贡献