@webc.site/math 0.1.2 → 0.1.4

package/README.md

@@ -21,22 +21,22 @@ The world's smallest and fastest web Markdown formula renderer designed to parse
 - [What is MathML?](#what-is-mathml)
   - [Why Compile TeX Formulas to MathML?](#why-compile-tex-formulas-to-mathml)
 - [Benchmark](#benchmark)
-- [Design & Calling Process](#design--calling-process)
+- [Design and Calling Process](#design-and-calling-process)
 - [How to Add Syntax Support](#how-to-add-syntax-support)
 - [Tech Stack](#tech-stack)
 - [Directory Structure](#directory-structure)
-- [History & Background](#history--background)
+- [History and Background](#history-and-background)
 
 ## Usage
 
 ### JavaScript Example
 
-#### 1. Replace Formulas in Markdown (using `@webc.site/math/md`)
+#### 1. Replace Formulas in Markdown (using `@webc.site/math/md.js`)
 
 Parses Markdown text, automatically identifying and replacing inline/block equations with MathML.
 
 ```javascript
-import mdMath from "@webc.site/math/md";
+import mdMath from "@webc.site/math/md.js";
 
 const markdown = "Euler's identity: $$e^{i\\pi} + 1 = 0$$";
 const html = mdMath(markdown);
@@ -56,7 +56,7 @@ const tex = "e^{i\\pi} + 1 = 0";
 const html = mathml(tex, true); // true for block math, false/empty for inline math
 ```
 
-### CSS & Math Font Configuration
+### CSS and Math Font Configuration
 
 For browser mathematical layout engines to present beautifully typeset math equations, we highly recommend using a math font. The **Latin Modern Math** font provided in the `18s` package is recommended (derived from Knuth's classical Computer Modern typeface, with a complete mathematical symbol set and OpenType MATH table support).
 
@@ -208,9 +208,9 @@ Currently, the following LaTeX extensions, macro definitions, or custom styling
 8. **Equation Numbering & Custom Tags**: `\tag`, `\newtagform`, `\usetagform`, etc.
 9. **Arbitrary Operator Limits**: Except for predefined big operators (`\sum`, `\int`) and limit-like operators (`\lim`), using `\limits` on arbitrary commands or structures (e.g., `\operatorname{sn}\limits_{...}`) is not supported.
 
-## Error Handling & Fault Tolerance
+## Error Handling and Fault Tolerance
 
-When parsing Markdown text using `@webc.site/math/md`, if a mathematical formula contains invalid LaTeX syntax (such as an unclosed `\left`), the parser automatically catches the compilation error internally and gracefully falls back to displaying the raw formula text (e.g., `$$x + \left( y$$`). This ensures that a single syntax error in a formula won't throw JavaScript exceptions or crash your application. Therefore, you **do not** need to wrap it in a `try...catch` block when calling this function.
+When parsing Markdown text using `@webc.site/math/md.js`, if a mathematical formula contains invalid LaTeX syntax (such as an unclosed `\left`), the parser automatically catches the compilation error internally and gracefully falls back to displaying the raw formula text (e.g., `$$x + \left( y$$`). This ensures that a single syntax error in a formula won't throw JavaScript exceptions or crash your application. Therefore, you **do not** need to wrap it in a `try...catch` block when calling this function.
 
 Note that calling `@webc.site/math` (the TeX compiler core) directly with invalid LaTeX syntax will throw an array containing an error code (see the internal error codes table below). If you are using the core TeX compiler directly, it is recommended to wrap the call in a `try...catch` block.
 
@@ -252,7 +252,7 @@ Our compiler acts as a translator that turns TeX into standard MathML tags on th
 
 Because the compilation is purely a fast tag-mapping step and layout is handled natively, CPU usage is minimal. This makes it ideal for **WYSIWYG editors, live markdown previewers, and interactive apps** where formulas need to be rendered dynamically on every keystroke without lag—even on low-end mobile devices.
 
-#### 4. Unified Frontend & SSR Capabilities
+#### 4. Unified Frontend and SSR Capabilities
 
 Since the output is standard HTML with MathML elements, the same compiler works seamlessly for dynamic client-side rendering (CSR), server-side rendering (SSR), and static site generation (SSG) alike.
 
@@ -280,7 +280,7 @@ Based on compiling standard test equations (measured using [sh/benchmark.js](htt
 
 ![](demo/speed.svg)
 
-## Design & Calling Process
+## Design and Calling Process
 
 The parser processes input Markdown string, isolates TeX expressions, and translates them to MathML structures.
 
@@ -378,7 +378,7 @@ The `SHOW_MAP` dictionary converts AST nodes into standard MathML markup strings
 └── test.sh              # Formatter, linter, and compiler test runner
 ```
 
-## History & Background
+## History and Background
 
 Mathematical typesetting on the web has historically relied on heavy libraries like MathJax or KaTeX. These libraries fetch large bundles and execute extensive CSS and layout calculations, causing page loading latencies.
 
@@ -404,8 +404,8 @@ The `18s` project provides a optimized math font `m` (Latin Modern Math, derived
 - [使用方法](#使用方法)
 - [功能特性](#功能特性)
 - [支持的语法清单](#支持的语法清单)
-- [什么是 MathML？](#什么是-mathml？)
-  - [为什么需要 TeX 公式转 MathML？](#为什么需要-tex-公式转-mathml？)
+- [什么是 MathML？](#什么是-mathml)
+  - [为什么需要 TeX 公式转 MathML？](#为什么需要-tex-公式转-mathml)
 - [性能对比](#性能对比)
 - [设计思路与调用流程](#设计思路与调用流程)
 - [如何添加新的语法支持](#如何添加新的语法支持)
@@ -417,12 +417,12 @@ The `18s` project provides a optimized math font `m` (Latin Modern Math, derived
 
 ### JavaScript 示例
 
-#### 1. 替换 Markdown 中的公式（使用 `@webc.site/math/md`）
+#### 1. 替换 Markdown 中的公式（使用 `@webc.site/math/md.js`）
 
 输入 Markdown 文本，自动识别其中的行内/块级公式并替换为 MathML。
 
 ```javascript
-import mdMath from "@webc.site/math/md";
+import mdMath from "@webc.site/math/md.js";
 
 const markdown = "欧拉恒等式：$$e^{i\\pi} + 1 = 0$$";
 const html = mdMath(markdown);
@@ -596,7 +596,7 @@ math {
 
 ## 错误处理与容错机制
 
-在使用 `@webc.site/math/md` 解析 Markdown 文本时，如果数学公式中包含非法的 LaTeX 语法（例如未闭合的 `\left`），内部会自动捕获该语法错误，并优雅地退化为显示原始的公式文本（如 `$$x + \left( y$$`），而不会抛出 JavaScript 异常或导致网页/应用渲染崩溃。因此，调用该函数时**无需**使用 `try...catch` 块包裹。
+在使用 `@webc.site/math/md.js` 解析 Markdown 文本时，如果数学公式中包含非法的 LaTeX 语法（例如未闭合的 `\left`），内部会自动捕获该语法错误，并优雅地退化为显示原始的公式文本（如 `$$x + \left( y$$`），而不会抛出 JavaScript 异常或导致网页/应用渲染崩溃。因此，调用该函数时**无需**使用 `try...catch` 块包裹。
 
 但需要注意的是，如果直接使用 `@webc.site/math` 的默认导出（TeX 编译器核心）来渲染非法的 LaTeX 语法，它会抛出包含错误码的数组（详见下文错误码表）。因此，直接调用 TeX 编译器时建议使用 `try...catch` 进行包裹。
 

package/mathml.d.ts

@@ -0,0 +1 @@
+export default function mathml(tex: string, block?: boolean): string;

package/md.d.ts

@@ -0,0 +1 @@
+export default function mdMath(md: string): string;

package/package.json

@@ -1 +1 @@
-{"name":"@webc.site/math","version":"0.1.2","description":"The world's smallest and fastest web Markdown formula renderer / 全球最小最快的网页Markdown公式渲染器","keywords":["markdown","math","mathml","render","tex"],"homepage":"https://math.webc.site","license":"MulanPSL-2.0","author":"i18n.site@gmail.com","repository":{"type":"git","url":"git+https://github.com/webc-site/math.git"},"type":"module","exports":{".":"./mathml.js","./*":"./*"},"scripts":{"prepare":"husky"},"dependencies":{},"lint-staged":{"**/*.svg":"bun sh/hook/svg.js","**/*.styl":"bun sh/hook/styl.js"}}
+{"name":"@webc.site/math","version":"0.1.4","description":"The world's smallest and fastest web Markdown formula renderer / 全球最小最快的网页Markdown公式渲染器","keywords":["markdown","math","mathml","render","tex"],"homepage":"https://math.webc.site","license":"MulanPSL-2.0","author":"i18n.site@gmail.com","repository":{"type":"git","url":"git+https://github.com/webc-site/math.git"},"type":"module","exports":{".":{"types":"./mathml.d.ts","default":"./mathml.js"},"./md.js":{"types":"./md.d.ts","default":"./md.js"},"./*":"./*"},"dependencies":{}}