@webc.site/math 0.1.3 → 0.1.5

package/README.md

@@ -13,7 +13,7 @@
   
 <a href="https://math.webc.site" target="_blank"><img src="https://raw.githubusercontent.com/webc-site/math/dev/readme/en/svg/badge.demo.svg" alt="demo" /></a>
 
-The world's smallest and fastest web Markdown formula renderer designed to parse mathematical formulas within Markdown text.
+Say goodbye to hundreds of KB of KaTeX/MathJax and bloated CSS/fonts! With an ultra-lightweight size of just ~4KB (Gzipped), it instantly compiles LaTeX equations into native MathML supported by all modern browsers, delivering zero-overhead, lightning-fast rendering.
 
 - [Usage](#usage)
 - [Features](#features)
@@ -31,12 +31,12 @@ The world's smallest and fastest web Markdown formula renderer designed to parse
 
 ### 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);
@@ -210,7 +210,7 @@ Currently, the following LaTeX extensions, macro definitions, or custom styling
 
 ## 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.
 
@@ -399,7 +399,7 @@ The `18s` project provides a optimized math font `m` (Latin Modern Math, derived
 &nbsp;&nbsp;
 <a href="https://math.webc.site" target="_blank"><img src="https://raw.githubusercontent.com/webc-site/math/dev/readme/zh/svg/badge.demo.svg" alt="demo" /></a>
 
-全球最小最快的网页 Markdown 公式渲染器，用于解析 Markdown 文本中的数学公式。
+告别数百 KB 的 KaTeX/MathJax 与臃肿的 CSS 字体包！仅约 4KB (Gzip) 的极致体积，将 LaTeX 公式瞬间编译为现代浏览器原生支持的 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.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"}}
+{"name":"@webc.site/math","version":"0.1.5","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":{}}