@webc.site/math 0.1.1 → 0.1.3

package/README.md

@@ -21,11 +21,11 @@ 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
 
@@ -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).
 
@@ -90,8 +90,11 @@ Depending on your project setup, choose one of the following methods to import t
 ```javascript
 // Import the bundle (includes Source Han Sans t, monospace c, and math font m)
 import "18s/_.css";
+```
+
+Or import math font `m` only:
 
-// Or import math font m only
+```javascript
 import "18s/m.css";
 ```
 
@@ -100,8 +103,11 @@ import "18s/m.css";
 ```css
 /* Import the bundle (includes Source Han Sans t, monospace c, and math font m) */
 @import "18s/_.css";
+```
 
-/* Or import math font m only */
+Or import math font `m` only:
+
+```css
 @import "18s/m.css";
 ```
 
@@ -185,7 +191,7 @@ Designed to be extremely lightweight, this library supports the most commonly us
 - **Matrices & Multi-line Layouts**:
   - Matrix environments: `matrix`, `pmatrix`, `bmatrix`, `vmatrix`, `Vmatrix` (e.g., `\begin{pmatrix} a & b \\ c & d \end{pmatrix}`)
   - Systems of equations & conditional branches: `cases` (e.g., `\begin{cases} x & x \ge 0 \\ -x & x < 0 \end{cases}`)
-  - Monospace grid arrays: `array`
+  - General-purpose array layouts: `array`
   - Line breaks & alignments: use `\\`, `\\*`, or `\\[width]` (for custom row spacing, e.g. `\\[10px]`) for line breaks, and `&` for column alignments
 
 ### Unsupported Syntax (Non-Goals)
@@ -202,7 +208,7 @@ 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.
 
@@ -246,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.
 
@@ -274,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.
 
@@ -372,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.
 
@@ -398,7 +404,8 @@ The `18s` project provides a optimized math font `m` (Latin Modern Math, derived
 - [使用方法](#使用方法)
 - [功能特性](#功能特性)
 - [支持的语法清单](#支持的语法清单)
-- [什么是 MathML？](#什么是-mathml？)
+- [什么是 MathML？](#什么是-mathml)
+  - [为什么需要 TeX 公式转 MathML？](#为什么需要-tex-公式转-mathml)
 - [性能对比](#性能对比)
 - [设计思路与调用流程](#设计思路与调用流程)
 - [如何添加新的语法支持](#如何添加新的语法支持)
@@ -469,8 +476,11 @@ npm install 18s
 ```javascript
 // 引入合并后的字体 CSS（包含思源黑体 t、代码字体 c 及数学字体 m）
 import "18s/_.css";
+```
 
-// 或者仅按需引入数学字体 m
+或者仅按需引入数学字体 `m`：
+
+```javascript
 import "18s/m.css";
 ```
 
@@ -479,8 +489,11 @@ import "18s/m.css";
 ```css
 /* 引入合并后的字体 CSS（包含思源黑体 t、代码字体 c 及数学字体 m） */
 @import "18s/_.css";
+```
 
-/* 或者仅按需引入数学字体 m */
+或者仅按需引入数学字体 `m`：
+
+```css
 @import "18s/m.css";
 ```
 

package/package.json

@@ -1 +1 @@
-{"name":"@webc.site/math","version":"0.1.1","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.3","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"}}