@mathcrowd/mmarked 3.1.3 → 3.1.4

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [3.1.4](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v3.1.3...v3.1.4) (2026-04-10)
+
+
+### Bug Fixes
+
+* exclude .map files from npm package ([69a9436](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/69a9436b8742972cd10a8f9314092590b3fdddb8))
+* prevent trigger-update race condition by fetching existing update-dependencies branch ([e3f0826](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/e3f0826f7a03e7ac2bc5af0a6e370beebb1a7f6f))
+* rebase update-dependencies branch on main before updating ([a6709bb](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/a6709bbbd90362b6e8be302edf48aefcd4a359e5))
+* upgrade trigger-update to semver-aware strategy and add release script ([3c0a5b2](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/3c0a5b257c354969040f5e07b995195a77d2ec07))
+
+
+### Features
+
+* add i18n locale support for built-in labels (zh/en) ([4bb0bf9](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/4bb0bf99f647ced1e6340a9c7ba672df412a0d2f))
+
 ## [3.1.3](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v3.1.2...v3.1.3) (2026-03-27)
 
 ## [3.1.2](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v3.1.1...v3.1.2) (2026-03-23)

package/README.md

@@ -25,6 +25,7 @@ Transform your Markdown experience with **mmarked** - a powerful TypeScript libr
 ### Core Capabilities
 
 - ✅ **Full CommonMark Support** - Complete compatibility with standard Markdown syntax
+- 🌐 **I18n Support** - Built-in Chinese/English locale for theorem, proof, footnote labels
 - 🔗 **Easy Integration** - Works seamlessly in Node.js and browser environments
 - 📦 **Lightweight Core** - Minimal dependencies, extensible architecture
 - ⚡ **High Performance** - Optimized rendering pipeline for fast output
@@ -77,6 +78,10 @@ This fundamental theorem (see [~pythagoras]) relates the sides of right triangle
 
 console.log(result.parsed) // HTML output
 console.log(result.time)   // Rendering time in ms
+
+// Render with English locale
+const enResult = renderMarkdown(`...`, { locale: 'en' })
+// Theorem → "Theorem", Proof → "Proof", Footnotes → "Footnotes"
 ```
 
 ### License Configuration (Node.js Only)
@@ -234,12 +239,16 @@ configureLicense({
 
 ### Core Functions
 
-#### `renderMarkdown(markdown: string)`
+#### `renderMarkdown(markdown: string, options?: { locale?: Locale })`
 
 Renders Markdown to HTML with full feature support.
 
 **License:** Requires valid license for commercial use in Node.js. Free in browsers.
 
+**Parameters:**
+- `markdown`: Markdown source string
+- `options.locale`: `'zh'` (default) or `'en'` — controls built-in labels for theorem-like blocks, solution/proof blocks, and footnote headings
+
 **Returns:**
 ```typescript
 {
@@ -249,10 +258,27 @@ Renders Markdown to HTML with full feature support.
 }
 ```
 
+**Locale mapping:**
+
+| Keyword | `zh` (default) | `en` |
+|---------|---------------|------|
+| `theorem` | 定理 | Theorem |
+| `lemma` | 引理 | Lemma |
+| `corollary` | 推论 | Corollary |
+| `axiom` | 公理 | Axiom |
+| `definition` | 定义 | Definition |
+| `example` | 例 | Example |
+| `proof` | 证明 | Proof |
+| `solution` | 解答 | Solution |
+| Footnote heading | 脚注 | Footnotes |
+
 **Example:**
 ```typescript
 const { parsed, time } = renderMarkdown('# Hello $x^2$')
 console.log(`Rendered in ${time}ms`)
+
+// English locale
+const { parsed: enHtml } = renderMarkdown(md, { locale: 'en' })
 ```
 
 #### `renderMarkdownCompact(markdown: string)`

package/README.zh.md

@@ -25,6 +25,7 @@
 ### 核心能力
 
 - ✅ **完整 CommonMark 支持** - 与标准 Markdown 语法完全兼容
+- 🌐 **多语言支持** - 内置中英文 locale，定理、证明、脚注等标签自动切换
 - 🔗 **轻松集成** - 在 Node.js 和浏览器环境中无缝运行
 - 📦 **轻量核心** - 最少依赖，可扩展架构
 - ⚡ **高性能** - 优化的渲染管道，输出快速
@@ -77,6 +78,10 @@ $$a^2 + b^2 = c^2$$
 
 console.log(result.parsed) // HTML 输出
 console.log(result.time)   // 渲染耗时（毫秒）
+
+// 使用英文 locale 渲染
+const enResult = renderMarkdown(`...`, { locale: 'en' })
+// 定理 → "Theorem"，证明 → "Proof"，脚注 → "Footnotes"
 ```
 
 ### 许可证配置（仅 Node.js）
@@ -234,12 +239,16 @@ configureLicense({
 
 ### 核心函数
 
-#### `renderMarkdown(markdown: string)`
+#### `renderMarkdown(markdown: string, options?: { locale?: Locale })`
 
 将 Markdown 渲染为 HTML，支持所有功能。
 
 **许可证：** Node.js 商业使用需要有效许可证。浏览器免费使用。
 
+**参数：**
+- `markdown`：Markdown 源字符串
+- `options.locale`：`'zh'`（默认）或 `'en'` —— 控制定理类块、证明/解答块、脚注标题的内置标签语言
+
 **返回值：**
 ```typescript
 {
@@ -249,10 +258,27 @@ configureLicense({
 }
 ```
 
+**Locale 对照表：**
+
+| 关键字 | `zh`（默认） | `en` |
+|--------|-------------|------|
+| `theorem` | 定理 | Theorem |
+| `lemma` | 引理 | Lemma |
+| `corollary` | 推论 | Corollary |
+| `axiom` | 公理 | Axiom |
+| `definition` | 定义 | Definition |
+| `example` | 例 | Example |
+| `proof` | 证明 | Proof |
+| `solution` | 解答 | Solution |
+| 脚注标题 | 脚注 | Footnotes |
+
 **示例：**
 ```typescript
 const { parsed, time } = renderMarkdown('# 你好 $x^2$')
 console.log(`渲染耗时 ${time}ms`)
+
+// 英文 locale
+const { parsed: enHtml } = renderMarkdown(md, { locale: 'en' })
 ```
 
 #### `renderMarkdownCompact(markdown: string)`