@sciexpr/markdown 0.1.0

package/dist/index.cjs

@@ -0,0 +1,142 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  formulaPlugin: () => formulaPlugin
+});
+module.exports = __toCommonJS(index_exports);
+function formulaPlugin(md, options = {}) {
+  const {
+    enableChemistry = false,
+    enableNumbering = false,
+    inlineDelimiter = "$",
+    blockDelimiter = "$$"
+  } = options;
+  let formulaCounter = 0;
+  md.block.ruler.before("fence", "formula_block", (state, startLine, endLine, silent) => {
+    const pos = state.bMarks[startLine];
+    const max = state.eMarks[startLine];
+    const lineText = state.src.slice(pos, max);
+    if (!lineText.startsWith(blockDelimiter)) return false;
+    let nextLine = startLine;
+    let formula = lineText.slice(blockDelimiter.length);
+    const closingIdx = formula.lastIndexOf(blockDelimiter);
+    if (closingIdx !== -1) {
+      formula = formula.slice(0, closingIdx);
+    } else {
+      for (nextLine = startLine + 1; nextLine < endLine; nextLine++) {
+        const nextPos = state.bMarks[nextLine];
+        const nextMax = state.eMarks[nextLine];
+        const nextText = state.src.slice(nextPos, nextMax);
+        if (nextText.includes(blockDelimiter)) {
+          const beforeClose = nextText.slice(0, nextText.lastIndexOf(blockDelimiter));
+          formula += "\n" + beforeClose;
+          break;
+        }
+        formula += "\n" + nextText;
+      }
+    }
+    formula = formula.replace(/^\n+|\n+$/g, "").trim();
+    if (silent) return true;
+    const token = state.push("formula_block", "div", 0);
+    token.attrSet("class", "sciexpr-formula sciexpr-block");
+    token.content = formula;
+    token.block = true;
+    if (enableNumbering) {
+      formulaCounter++;
+      token.attrSet("data-formula-id", `formula-${formulaCounter}`);
+    }
+    state.line = nextLine + 1;
+    return true;
+  });
+  md.inline.ruler.before("escape", "formula_inline", (state, silent) => {
+    const pos = state.pos;
+    const src = state.src;
+    if (src.slice(pos, pos + inlineDelimiter.length) !== inlineDelimiter) return false;
+    if (src.slice(pos, pos + 2) === "$$") return false;
+    const start = pos + inlineDelimiter.length;
+    let end = src.indexOf(inlineDelimiter, start);
+    if (end === -1) return false;
+    const formula = src.slice(start, end).trim();
+    if (!formula) return false;
+    if (!silent) {
+      const token = state.push("formula_inline", "span", 0);
+      token.attrSet("class", "sciexpr-formula sciexpr-inline");
+      token.content = formula;
+    }
+    state.pos = end + inlineDelimiter.length;
+    return true;
+  });
+  if (enableChemistry) {
+    md.inline.ruler.before("formula_inline", "chemistry_inline", (state, silent) => {
+      const pos = state.pos;
+      const src = state.src;
+      if (src.slice(pos, pos + 4) !== "\\ce{") return false;
+      let depth = 1;
+      let end = pos + 4;
+      while (end < src.length && depth > 0) {
+        if (src[end] === "{") depth++;
+        else if (src[end] === "}") depth--;
+        end++;
+      }
+      if (depth !== 0) return false;
+      const formula = src.slice(pos + 4, end - 1).trim();
+      if (!formula) return false;
+      if (!silent) {
+        const token = state.push("chemistry_inline", "span", 0);
+        token.attrSet("class", "sciexpr-formula sciexpr-chemistry");
+        token.content = `\\ce{${formula}}`;
+      }
+      state.pos = end;
+      return true;
+    });
+  }
+  md.renderer.rules.formula_block = (tokens, idx) => {
+    const token = tokens[idx];
+    const formula = token.content.replace(/\n/g, " ").trim();
+    const formulaId = token.attrGet("data-formula-id");
+    const latex = options.katexRenderer ? "" : `<code class="sciexpr-latex-source">${escapeHtml(formula)}</code>`;
+    const numberHtml = formulaId ? `<span class="sciexpr-formula-number">(${formulaId.replace("formula-", "")})</span>` : "";
+    return `<div class="sciexpr-formula sciexpr-block" data-formula="${escapeAttr(formula)}"${formulaId ? ` data-formula-id="${escapeAttr(formulaId)}"` : ""}>${numberHtml}${latex}</div>`;
+  };
+  md.renderer.rules.formula_inline = (tokens, idx) => {
+    const token = tokens[idx];
+    const formula = token.content.replace(/\n/g, " ").trim();
+    return `<span class="sciexpr-formula sciexpr-inline" data-formula="${escapeAttr(formula)}">${escapeHtml(formula)}</span>`;
+  };
+  if (enableChemistry) {
+    md.renderer.rules.chemistry_inline = (tokens, idx) => {
+      const token = tokens[idx];
+      const formula = token.content.replace(/\n/g, " ").trim();
+      return `<span class="sciexpr-formula sciexpr-chemistry" data-formula="${escapeAttr(formula)}">${escapeHtml(formula)}</span>`;
+    };
+  }
+}
+function escapeHtml(text) {
+  return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+function escapeAttr(text) {
+  return text.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  formulaPlugin
+});

package/dist/index.d.cts

@@ -0,0 +1,44 @@
+import MarkdownIt from 'markdown-it';
+import { KatexRenderer, RenderOptions } from '@sciexpr/renderer';
+
+/**
+ * markdown-it 插件配置
+ */
+interface MarkdownFormulaOptions {
+    /** KaTeX 渲染器实例 */
+    katexRenderer?: KatexRenderer;
+    /** 渲染选项 */
+    renderOptions?: RenderOptions;
+    /** 是否启用化学式自动识别 */
+    enableChemistry?: boolean;
+    /** 是否启用公式编号 */
+    enableNumbering?: boolean;
+    /** 自定义行内公式分隔符（默认 $） */
+    inlineDelimiter?: string;
+    /** 自定义块级公式分隔符（默认 $$） */
+    blockDelimiter?: string;
+    /** 是否提取公式元数据到 token.meta */
+    extractMeta?: boolean;
+}
+/**
+ * 科学公式 markdown-it 插件
+ *
+ * 支持：
+ * - 行内公式 $...$ → KaTeX HTML
+ * - 块级公式 $$...$$ → KaTeX HTML（display mode）
+ * - 可选的化学式自动识别（\ce{...}）
+ *
+ * @example
+ * ```ts
+ * import MarkdownIt from 'markdown-it';
+ * import { formulaPlugin } from '@sciexpr/markdown';
+ *
+ * const md = new MarkdownIt();
+ * md.use(formulaPlugin, { renderOptions: { displayMode: false } });
+ *
+ * const html = md.render('E = $mc^2$');
+ * ```
+ */
+declare function formulaPlugin(md: MarkdownIt, options?: MarkdownFormulaOptions): void;
+
+export { type MarkdownFormulaOptions, formulaPlugin };

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import MarkdownIt from 'markdown-it';
+import { KatexRenderer, RenderOptions } from '@sciexpr/renderer';
+
+/**
+ * markdown-it 插件配置
+ */
+interface MarkdownFormulaOptions {
+    /** KaTeX 渲染器实例 */
+    katexRenderer?: KatexRenderer;
+    /** 渲染选项 */
+    renderOptions?: RenderOptions;
+    /** 是否启用化学式自动识别 */
+    enableChemistry?: boolean;
+    /** 是否启用公式编号 */
+    enableNumbering?: boolean;
+    /** 自定义行内公式分隔符（默认 $） */
+    inlineDelimiter?: string;
+    /** 自定义块级公式分隔符（默认 $$） */
+    blockDelimiter?: string;
+    /** 是否提取公式元数据到 token.meta */
+    extractMeta?: boolean;
+}
+/**
+ * 科学公式 markdown-it 插件
+ *
+ * 支持：
+ * - 行内公式 $...$ → KaTeX HTML
+ * - 块级公式 $$...$$ → KaTeX HTML（display mode）
+ * - 可选的化学式自动识别（\ce{...}）
+ *
+ * @example
+ * ```ts
+ * import MarkdownIt from 'markdown-it';
+ * import { formulaPlugin } from '@sciexpr/markdown';
+ *
+ * const md = new MarkdownIt();
+ * md.use(formulaPlugin, { renderOptions: { displayMode: false } });
+ *
+ * const html = md.render('E = $mc^2$');
+ * ```
+ */
+declare function formulaPlugin(md: MarkdownIt, options?: MarkdownFormulaOptions): void;
+
+export { type MarkdownFormulaOptions, formulaPlugin };

package/dist/index.js

@@ -0,0 +1,117 @@
+// src/index.ts
+function formulaPlugin(md, options = {}) {
+  const {
+    enableChemistry = false,
+    enableNumbering = false,
+    inlineDelimiter = "$",
+    blockDelimiter = "$$"
+  } = options;
+  let formulaCounter = 0;
+  md.block.ruler.before("fence", "formula_block", (state, startLine, endLine, silent) => {
+    const pos = state.bMarks[startLine];
+    const max = state.eMarks[startLine];
+    const lineText = state.src.slice(pos, max);
+    if (!lineText.startsWith(blockDelimiter)) return false;
+    let nextLine = startLine;
+    let formula = lineText.slice(blockDelimiter.length);
+    const closingIdx = formula.lastIndexOf(blockDelimiter);
+    if (closingIdx !== -1) {
+      formula = formula.slice(0, closingIdx);
+    } else {
+      for (nextLine = startLine + 1; nextLine < endLine; nextLine++) {
+        const nextPos = state.bMarks[nextLine];
+        const nextMax = state.eMarks[nextLine];
+        const nextText = state.src.slice(nextPos, nextMax);
+        if (nextText.includes(blockDelimiter)) {
+          const beforeClose = nextText.slice(0, nextText.lastIndexOf(blockDelimiter));
+          formula += "\n" + beforeClose;
+          break;
+        }
+        formula += "\n" + nextText;
+      }
+    }
+    formula = formula.replace(/^\n+|\n+$/g, "").trim();
+    if (silent) return true;
+    const token = state.push("formula_block", "div", 0);
+    token.attrSet("class", "sciexpr-formula sciexpr-block");
+    token.content = formula;
+    token.block = true;
+    if (enableNumbering) {
+      formulaCounter++;
+      token.attrSet("data-formula-id", `formula-${formulaCounter}`);
+    }
+    state.line = nextLine + 1;
+    return true;
+  });
+  md.inline.ruler.before("escape", "formula_inline", (state, silent) => {
+    const pos = state.pos;
+    const src = state.src;
+    if (src.slice(pos, pos + inlineDelimiter.length) !== inlineDelimiter) return false;
+    if (src.slice(pos, pos + 2) === "$$") return false;
+    const start = pos + inlineDelimiter.length;
+    let end = src.indexOf(inlineDelimiter, start);
+    if (end === -1) return false;
+    const formula = src.slice(start, end).trim();
+    if (!formula) return false;
+    if (!silent) {
+      const token = state.push("formula_inline", "span", 0);
+      token.attrSet("class", "sciexpr-formula sciexpr-inline");
+      token.content = formula;
+    }
+    state.pos = end + inlineDelimiter.length;
+    return true;
+  });
+  if (enableChemistry) {
+    md.inline.ruler.before("formula_inline", "chemistry_inline", (state, silent) => {
+      const pos = state.pos;
+      const src = state.src;
+      if (src.slice(pos, pos + 4) !== "\\ce{") return false;
+      let depth = 1;
+      let end = pos + 4;
+      while (end < src.length && depth > 0) {
+        if (src[end] === "{") depth++;
+        else if (src[end] === "}") depth--;
+        end++;
+      }
+      if (depth !== 0) return false;
+      const formula = src.slice(pos + 4, end - 1).trim();
+      if (!formula) return false;
+      if (!silent) {
+        const token = state.push("chemistry_inline", "span", 0);
+        token.attrSet("class", "sciexpr-formula sciexpr-chemistry");
+        token.content = `\\ce{${formula}}`;
+      }
+      state.pos = end;
+      return true;
+    });
+  }
+  md.renderer.rules.formula_block = (tokens, idx) => {
+    const token = tokens[idx];
+    const formula = token.content.replace(/\n/g, " ").trim();
+    const formulaId = token.attrGet("data-formula-id");
+    const latex = options.katexRenderer ? "" : `<code class="sciexpr-latex-source">${escapeHtml(formula)}</code>`;
+    const numberHtml = formulaId ? `<span class="sciexpr-formula-number">(${formulaId.replace("formula-", "")})</span>` : "";
+    return `<div class="sciexpr-formula sciexpr-block" data-formula="${escapeAttr(formula)}"${formulaId ? ` data-formula-id="${escapeAttr(formulaId)}"` : ""}>${numberHtml}${latex}</div>`;
+  };
+  md.renderer.rules.formula_inline = (tokens, idx) => {
+    const token = tokens[idx];
+    const formula = token.content.replace(/\n/g, " ").trim();
+    return `<span class="sciexpr-formula sciexpr-inline" data-formula="${escapeAttr(formula)}">${escapeHtml(formula)}</span>`;
+  };
+  if (enableChemistry) {
+    md.renderer.rules.chemistry_inline = (tokens, idx) => {
+      const token = tokens[idx];
+      const formula = token.content.replace(/\n/g, " ").trim();
+      return `<span class="sciexpr-formula sciexpr-chemistry" data-formula="${escapeAttr(formula)}">${escapeHtml(formula)}</span>`;
+    };
+  }
+}
+function escapeHtml(text) {
+  return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+function escapeAttr(text) {
+  return text.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+export {
+  formulaPlugin
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@sciexpr/markdown",
+  "version": "0.1.0",
+  "description": "Scientific Expression Engine - markdown-it plugin for formula rendering",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "scientific",
+    "expression",
+    "markdown",
+    "markdown-it",
+    "katex"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "haoguodong09-svg",
+    "email": "haoguodong09@gmail.com"
+  },
+  "homepage": "https://github.com/haoguodong09-svg/scientific-expression-engine#readme",
+  "bugs": {
+    "url": "https://github.com/haoguodong09-svg/scientific-expression-engine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/haoguodong09-svg/scientific-expression-engine",
+    "directory": "packages/markdown"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@sciexpr/renderer": "0.1.0"
+  },
+  "peerDependencies": {
+    "markdown-it": "^14.0.0"
+  },
+  "devDependencies": {
+    "markdown-it": "^14.0.0",
+    "@types/markdown-it": "^14.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0",
+    "vitest": "^2.0.0",
+    "rimraf": "^5.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "tsc --noEmit",
+    "clean": "rimraf dist",
+    "test": "vitest run"
+  }
+}