@mathcrowd/mmarked 1.6.3

package/CHANGELOG.md

@@ -0,0 +1,112 @@
+## [1.6.3](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.6.1...v1.6.3) (2024-09-24)
+
+
+### Bug Fixes
+
+* npm install command fixed. ([b0bea6d](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/b0bea6d48eafa1dcd361fc6b01ad8db84c24b2ff))
+
+
+
+## [1.6.1](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.6.0...v1.6.1) (2024-09-20)
+
+
+### Bug Fixes
+
+* demo page links fixed. ([9b40d38](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/9b40d38a572ac1dd3c3dfdd70ed28d8072ab54c0))
+
+
+
+# [1.6.0](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.5.5...v1.6.0) (2024-09-20)
+
+
+### Features
+
+* web integration supported. ([487f2cc](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/487f2cccc4489c13329ca7181408818f107b3eda))
+
+
+
+## [1.5.5](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.5.0...v1.5.5) (2024-09-18)
+
+
+### Bug Fixes
+
+* github ci updated. ([7481f32](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/7481f32b5b1f4fe64cf4ffa95f1ac2dd5a0109ca))
+
+
+### Features
+
+* support unnumbered theorem block. ([32cf3a0](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/32cf3a0f44dfa0cf3797a16b2f7bc9104775f413))
+
+
+
+# [1.5.0](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.3.3...v1.5.0) (2024-09-04)
+
+
+
+## [1.3.3](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.3.2...v1.3.3) (2024-08-14)
+
+
+### Bug Fixes
+
+* image size. [#7](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/issues/7) ([4bf2f68](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/4bf2f680d61cf8084a2be66e5709d46509b3a1a0))
+
+
+
+## [1.3.2](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.3.1...v1.3.2) (2024-08-08)
+
+
+### Bug Fixes
+
+* add 'px' to image size. ([7aacb77](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/7aacb77512d418652e5e6b194fbb7278ce447c1d))
+
+
+
+## [1.3.1](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.2.2...v1.3.1) (2024-08-06)
+
+
+### Features
+
+* image resizable. ([986e236](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/986e2362e404e03f1358ad9da2892493111c70f3))
+* project reorgnized. ([2d4b437](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/2d4b4374e9451e0236e8d609c26f19ebcdf09872))
+* rollup livereload / highlight added. ([4b893bf](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/4b893bf535165a61821d89c0e341d5820473710d))
+
+
+
+## [1.2.2](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.2.1...v1.2.2) (2024-08-01)
+
+
+
+## [1.2.1](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/v1.2.0...v1.2.1) (2024-08-01)
+
+
+### Bug Fixes
+
+* ts error https://github.com/markedjs/marked/issues/3101 ([1991650](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/1991650e64c513adb97bb4d31b12f3d0ae10a352))
+
+
+
+# [1.2.0](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/compare/3d84e4de2829de5ae4f03efc51eadc9b279eb775...v1.2.0) (2024-08-01)
+
+
+### Bug Fixes
+
+* demo page rollup ([4b52589](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/4b5258944d35b5dd962ead3c5fa3a129c897c0c8))
+* footnote bug [#2](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/issues/2). ([6be6c7a](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/6be6c7a8b70be0dc75f9b342647ed99110655827))
+* renderMarkdown/renderMarkdownCompact return value reorgnized. ([4a2df5f](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/4a2df5fa8fd092212cf0572a24f658f1d6147e77))
+* use crypto and buffer in browser for demo. ([42fe470](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/42fe470f926049c88be5da33451a6eacd12b159d))
+
+
+### Features
+
+* br rules ignored. ([f57bf7e](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/f57bf7e86fc67f277343ad9a9e11a5e3fff58359))
+* demo added. ([6bb7b4e](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/6bb7b4ecd8339169c3c8d6ed8dd20bb2f87fe3a2))
+* fig caption supported. ([325c093](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/325c093ade1036addc9dd2435b52e0e8ed11ed68))
+* generate theorem/solution block classname. ([1a9ddac](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/1a9ddac0be4fa84f9a653362aada5cc6b66d4e51))
+* handle error for tex2svg ([6a43864](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/6a43864a5b93a628da0e20352db27679702909a9))
+* theorem rewrited. ([c7190d9](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/c7190d90329bfabe133eb467fd62f436e005c8ac))
+* trigger updating dependencies. ([a0d167b](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/a0d167b6de42fdfd5f3eb712d24bf926af3ce650))
+* upgrade marked.js to v13 ([af45a2f](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/af45a2f90f207069df23f0da65ff7dab31155e24))
+* use section instead of div. ([3d84e4d](https://cloud.mathcrowd.cn:2444/agile/frontend/mathcrowd-marked-lib/commits/3d84e4de2829de5ae4f03efc51eadc9b279eb775))
+
+
+

package/COPYRIGHT.md

@@ -0,0 +1,11 @@
+All Rights Reserved
+
+Copyright © Mathcrowd 2016-2024 ([charles@mathcrowd.cn](mailto:charles@mathcrowd.cn))  
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# mathcrowd-marked-lib
+
+[![npm version](https://badge.fury.io/js/%40mathcrowd%2Fmmarked.svg)](https://badge.fury.io/js/%40mathcrowd%2Fmmarked)
+[![License: Custom](https://img.shields.io/badge/License-Custom-yellow.svg)](https://opensource.org/licenses/)
+
+A powerful TypeScript library for rendering customized markdown syntax with LaTeX support, designed for mathematical visualization in educational contexts.
+
+## 🌟 Features
+
+- ✅ **Full CommonMark syntax support:** Comprehensive compatibility with CommonMark standards.
+- 🔢 **Footnotes Blocks:** Supports rendering auto-numbered footnotes with easy reference links.
+- 📘 **Theorem-like blocks:**  Supports rendering mathematical theorems, lemmas, and examples in a block format with titles, auto-numbering, and reference links.
+- 🖼️ **Image resizing capabilities:** Allows for customizable rendering of images and videos using simple syntax.
+- 🔍 **Hidden/show solution blocks:** Provides a solution block with a toggle button for easy visibility control, implemented with straightforward syntax.
+- 🧮 **TeX to SVG conversion:** Converts TeX equations to scalable vector graphics for high-quality rendering.
+- 🔗 **Easy Integration with Existing Systems:** Supports both server-side and browser-side implementations for flexible use.
+
+## 🚀 Quick Start
+
+### Server Side Integration
+
+
+#### Installation
+
+```bash
+npm install @mathcrowd/mmarked mathjax-full highlight.js
+```
+
+### Basic Usage
+
+```typescript
+import { tex2svg, renderMarkdown } from '@mathcrowd/mmarked'
+
+// Convert TeX to SVG
+const svg = tex2svg('$x^2$')
+
+// Render Markdown to HTML
+const html = renderMarkdown('### Heading').parsed
+```
+
+
+### Web Browser Side Integration
+
+```html
+<!doctype html>
+<html>
+
+<head>
+    <meta charset="utf-8" />
+    <title>Marked in the browser</title>
+</head>
+
+<body>
+    <div id="content"></div>
+    <script src="dist/browser.umd.js"></script>
+    <script>
+        const { tex2svg, renderMarkdown } = marked
+        document.getElementById('content').innerHTML =
+            tex2svg(renderMarkdown('# Marked in the browser \n\n $x^2+y^2=1$ \n\nRendered by **mmarked**.').parsed);
+        console.log(renderMarkdown('# Marked in the browser\n\nRendered by **mmarked**.').lexed)
+    </script>
+</body>
+
+</html>
+```
+
+## 📚 API Reference
+
+| Function | Description |
+|----------|-------------|
+| `tex2svg(tex: string): string` | Converts TeX to SVG in HTML format |
+| `renderMarkdown(markdown: string): {parsed:string, lexed: Token[], time: number}` | Renders Markdown to HTML |
+| `renderMarkdownCompact(markdown: string): {parsed:string, lexed: Token[], time: number}` | Renders Markdown to HTML without `<p>` tags |
+
+⚠️ **Important**: Always purify the output HTML using [DOMPurify](https://github.com/cure53/DOMPurify) to prevent XSS attacks.
+
+## 📖 Documentation
+
+For detailed documentation in Chinese, visit our [Product Page](https://lab.mathcrowd.cn/markdown).
+
+## 🎮 Demo
+
+Try out our interactive demo [here](https://mathedu4all.github.io/mathcrowd-marked-lib/demo/).
+
+## 👥 About Mathcrowd
+
+Mathcrowd is an innovative startup founded by experienced independent developers and mathematics educators. We're on a mission to revolutionize math education in China through cutting-edge technology. Our goal is to create an engaging online community for math enthusiasts and self-learners, offering rich, interactive, and visualized learning content.
+
+🌐 MCLab Official Website: [https://lab.mathcrowd.cn](https://lab.mathcrowd.cn) 
+
+🌐 Our Online Math Community: [https://www.mathcrowd.cn](https://www.mathcrowd.cn) 
+
+## 📄 License
+
+All Rights Reserved
+
+Copyright © Mathcrowd 2016-2024 (charles@mathcrowd.cn)
+
+```
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more details.
+
+## 📞 Support
+
+For any questions or issues, please [open an issue](https://github.com/mathedu4all/mathcrowd-marked-lib/issues) on our GitHub repository.

package/demo.html

@@ -0,0 +1,20 @@
+<!doctype html>
+<html>
+
+<head>
+    <meta charset="utf-8" />
+    <title>Marked in the browser</title>
+</head>
+
+<body>
+    <div id="content"></div>
+    <script src="dist/browser.umd.js"></script>
+    <script>
+        const { tex2svg, renderMarkdown } = marked
+        document.getElementById('content').innerHTML =
+            tex2svg(renderMarkdown('# Marked in the browser \n\n $x^2+y^2=1$ \n\nRendered by **mathcrowd-marked-lib**.').parsed);
+        console.log(renderMarkdown('# Marked in the browser\n\nRendered by **marked**.').lexed)
+    </script>
+</body>
+
+</html>