mdast-util-math-inline 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 weavepage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# mdast-util-math-inline
+
+[mdast](https://github.com/syntax-tree/mdast) utilities for inline math (`:math[...]`).
+
+## Install
+
+```bash
+npm install mdast-util-math-inline
+```
+
+## Usage
+
+```javascript
+import { fromMarkdown } from 'mdast-util-from-markdown'
+import { toMarkdown } from 'mdast-util-to-markdown'
+import { mathInline } from 'micromark-extension-math-inline'
+import { mathInlineFromMarkdown, mathInlineToMarkdown } from 'mdast-util-math-inline'
+
+// Parse
+const tree = fromMarkdown(':math[x^2]', {
+  extensions: [mathInline()],
+  mdastExtensions: [mathInlineFromMarkdown()]
+})
+
+// Stringify
+const md = toMarkdown(tree, {
+  extensions: [mathInlineToMarkdown()]
+})
+```
+
+## AST
+
+### `InlineMath`
+
+```typescript
+interface InlineMath extends Literal {
+  type: 'inlineMath'
+  value: string
+  data?: {
+    hName: 'code'
+    hProperties: { className: ['language-math', 'math-inline'] }
+    hChildren: [{ type: 'text', value: string }]
+  }
+}
+```
+
+The `data` fields enable compatibility with `remark-rehype` and `rehype-katex`.
+
+## Escaping
+
+When serializing to markdown:
+- `]` is escaped as `\]`
+- `\` before `]` or `\` is escaped as `\\`
+- Balanced brackets don't need escaping
+
+## License
+
+MIT

package/dist/from-markdown.d.ts

@@ -0,0 +1,22 @@
+import type { Extension } from 'mdast-util-from-markdown';
+import type { Literal } from 'mdast';
+export interface InlineMath extends Literal {
+    type: 'inlineMath';
+    data?: {
+        hName: string;
+        hProperties: {
+            className: string[];
+        };
+        hChildren: Array<{
+            type: 'text';
+            value: string;
+        }>;
+    };
+}
+declare module 'mdast' {
+    interface PhrasingContentMap {
+        inlineMath: InlineMath;
+    }
+}
+export declare function mathInlineFromMarkdown(): Extension;
+//# sourceMappingURL=from-markdown.d.ts.map

package/dist/from-markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"from-markdown.d.ts","sourceRoot":"","sources":["../src/from-markdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAkB,SAAS,EAAS,MAAM,0BAA0B,CAAA;AAChF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAEpC,MAAM,WAAW,UAAW,SAAQ,OAAO;IACzC,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE;YAAE,SAAS,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;QACpC,SAAS,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAClD,CAAA;CACF;AAED,OAAO,QAAQ,OAAO,CAAC;IACrB,UAAU,kBAAkB;QAC1B,UAAU,EAAE,UAAU,CAAA;KACvB;CACF;AAED,wBAAgB,sBAAsB,IAAI,SAAS,CAsClD"}

package/dist/from-markdown.js

@@ -0,0 +1,38 @@
+export function mathInlineFromMarkdown() {
+    let mathValue = '';
+    return {
+        enter: {
+            mathInline: enterMathInline,
+            mathInlineData: enterMathInlineData
+        },
+        exit: {
+            mathInlineData: exitMathInlineData,
+            mathInline: exitMathInline
+        }
+    };
+    function enterMathInline(token) {
+        // @ts-expect-error: inlineMath is a custom node type
+        this.enter({ type: 'inlineMath', value: '' }, token);
+    }
+    function enterMathInlineData() {
+        mathValue = '';
+    }
+    function exitMathInlineData(token) {
+        mathValue = processEscapes(this.sliceSerialize(token));
+    }
+    function exitMathInline(token) {
+        // @ts-expect-error: accessing custom node
+        const node = this.stack[this.stack.length - 1];
+        node.value = mathValue;
+        node.data = {
+            hName: 'code',
+            hProperties: { className: ['language-math', 'math-inline'] },
+            hChildren: [{ type: 'text', value: mathValue }]
+        };
+        this.exit(token);
+    }
+}
+function processEscapes(input) {
+    return input.replace(/\\([\]\\])/g, '$1');
+}
+//# sourceMappingURL=from-markdown.js.map

package/dist/from-markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"from-markdown.js","sourceRoot":"","sources":["../src/from-markdown.ts"],"names":[],"mappings":"AAkBA,MAAM,UAAU,sBAAsB;IACpC,IAAI,SAAS,GAAG,EAAE,CAAA;IAElB,OAAO;QACL,KAAK,EAAE;YACL,UAAU,EAAE,eAAe;YAC3B,cAAc,EAAE,mBAAmB;SACpC;QACD,IAAI,EAAE;YACJ,cAAc,EAAE,kBAAkB;YAClC,UAAU,EAAE,cAAc;SAC3B;KACF,CAAA;IAED,SAAS,eAAe,CAAuB,KAAY;QACzD,qDAAqD;QACrD,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;IACtD,CAAC;IAED,SAAS,mBAAmB;QAC1B,SAAS,GAAG,EAAE,CAAA;IAChB,CAAC;IAED,SAAS,kBAAkB,CAAuB,KAAY;QAC5D,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,SAAS,cAAc,CAAuB,KAAY;QACxD,0CAA0C;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAe,CAAA;QAC5D,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;QACtB,IAAI,CAAC,IAAI,GAAG;YACV,KAAK,EAAE,MAAM;YACb,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,EAAE;YAC5D,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;SAChD,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClB,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;AAC3C,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { mathInlineFromMarkdown, type InlineMath } from './from-markdown.js';
+export { mathInlineToMarkdown } from './to-markdown.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { mathInlineFromMarkdown } from './from-markdown.js';
+export { mathInlineToMarkdown } from './to-markdown.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAmB,MAAM,oBAAoB,CAAA;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/to-markdown.d.ts

@@ -0,0 +1,3 @@
+import type { Options } from 'mdast-util-to-markdown';
+export declare function mathInlineToMarkdown(): Options;
+//# sourceMappingURL=to-markdown.d.ts.map

package/dist/to-markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-markdown.d.ts","sourceRoot":"","sources":["../src/to-markdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAGrD,wBAAgB,oBAAoB,IAAI,OAAO,CAc9C"}

package/dist/to-markdown.js

@@ -0,0 +1,68 @@
+export function mathInlineToMarkdown() {
+    return {
+        handlers: {
+            // @ts-expect-error: inlineMath is a custom node type
+            inlineMath: handleInlineMath
+        },
+        unsafe: [
+            {
+                character: ':',
+                after: 'math\\[',
+                inConstruct: ['phrasing']
+            }
+        ]
+    };
+}
+function handleInlineMath(node) {
+    return ':math[' + escapeValue(node.value) + ']';
+}
+function escapeValue(value) {
+    // Pre-count ] to know how many we have for balancing
+    let remainingClose = 0;
+    for (const char of value) {
+        if (char === ']')
+            remainingClose++;
+    }
+    let result = '';
+    let bracketDepth = 0;
+    for (let i = 0; i < value.length; i++) {
+        const char = value[i];
+        if (char === '[') {
+            // Escape if there aren't enough remaining ] to balance
+            if (bracketDepth >= remainingClose) {
+                result += '\\[';
+            }
+            else {
+                bracketDepth++;
+                result += char;
+            }
+        }
+        else if (char === ']') {
+            remainingClose--;
+            if (bracketDepth > 0) {
+                // Balanced bracket, no escape needed
+                bracketDepth--;
+                result += char;
+            }
+            else {
+                // Unbalanced, must escape
+                result += '\\]';
+            }
+        }
+        else if (char === '\\') {
+            // Escape backslash if followed by ] or \ or [ (to prevent creating escape sequences)
+            const next = value[i + 1];
+            if (next === ']' || next === '\\' || next === '[') {
+                result += '\\\\';
+            }
+            else {
+                result += '\\';
+            }
+        }
+        else {
+            result += char;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=to-markdown.js.map

package/dist/to-markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-markdown.js","sourceRoot":"","sources":["../src/to-markdown.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,oBAAoB;IAClC,OAAO;QACL,QAAQ,EAAE;YACR,qDAAqD;YACrD,UAAU,EAAE,gBAAgB;SAC7B;QACD,MAAM,EAAE;YACN;gBACE,SAAS,EAAE,GAAG;gBACd,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,CAAC,UAAU,CAAC;aAC1B;SACF;KACF,CAAA;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAgB;IACxC,OAAO,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;AACjD,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,qDAAqD;IACrD,IAAI,cAAc,GAAG,CAAC,CAAA;IACtB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,KAAK,GAAG;YAAE,cAAc,EAAE,CAAA;IACpC,CAAC;IAED,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,IAAI,YAAY,GAAG,CAAC,CAAA;IAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QAErB,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,uDAAuD;YACvD,IAAI,YAAY,IAAI,cAAc,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CAAA;YACjB,CAAC;iBAAM,CAAC;gBACN,YAAY,EAAE,CAAA;gBACd,MAAM,IAAI,IAAI,CAAA;YAChB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,cAAc,EAAE,CAAA;YAChB,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;gBACrB,qCAAqC;gBACrC,YAAY,EAAE,CAAA;gBACd,MAAM,IAAI,IAAI,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACN,0BAA0B;gBAC1B,MAAM,IAAI,KAAK,CAAA;YACjB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACzB,qFAAqF;YACrF,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YACzB,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBAClD,MAAM,IAAI,MAAM,CAAA;YAClB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,IAAI,CAAA;YAChB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,IAAI,CAAA;QAChB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "mdast-util-math-inline",
+  "version": "1.0.0",
+  "description": "mdast utility to parse and serialize inline math (:math[...])",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "test": "echo 'Tests run via remark-math-inline package'",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "mdast-util-from-markdown": "^2.0.0",
+    "mdast-util-to-markdown": "^2.0.0",
+    "micromark-extension-math-inline": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/mdast": "^4.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^2.0.0"
+  },
+  "keywords": ["mdast", "math", "latex", "katex", "inline"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/weavepage/remark-math-inline.git",
+    "directory": "packages/mdast-util-math-inline"
+  }
+}