Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathedu4all/mmarked
A Typescript library for rendering customized markdown syntax and providing tex2svg for server-side rendering.
https://github.com/mathedu4all/mmarked
highlightjs markdown markedjs mathjax
Last synced: 28 days ago
JSON representation
A Typescript library for rendering customized markdown syntax and providing tex2svg for server-side rendering.
- Host: GitHub
- URL: https://github.com/mathedu4all/mmarked
- Owner: mathedu4all
- License: other
- Created: 2024-09-04T08:06:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-11T12:33:38.000Z (about 2 months ago)
- Last Synced: 2024-11-28T06:41:49.712Z (about 1 month ago)
- Topics: highlightjs, markdown, markedjs, mathjax
- Homepage: https://lab.mathcrowd.cn/mmarked
- Size: 5.84 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# mmarked
[](https://badge.fury.io/js/%40mathcrowd%2Fmmarked)
[](https://creativecommons.org/licenses/by-nc/4.0)
[中文](./README.zh.md)
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:** Support for auto-numbered footnotes with easy reference links
- 📘 **Theorem-like blocks:** Support for mathematical theorems, lemmas, and examples in a block format with titles, auto-numbering, and reference links
- 🖼️ **Image resizing capabilities:** Customizable rendering of images and videos using simple syntax
- 🔍 **Hidden/Show solution blocks:** Solution blocks with toggle buttons for easy visibility control, implemented with straightforward syntax
- 🧮 **TeX to SVG conversion:** Conversion of TeX equations to scalable vector graphics for high-quality rendering
- 🔗 **Easy Integration with Existing Systems:** Support for both server-side and browser-side implementations
## 🚀 Quick Start
### Editor Integration
Use mmarked in VSCode: https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked
Use mmarked in Logseq: https://github.com/mathedu4all/mmarked-logseq-extension
### 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
```
### Browser-Side Integration
```html
Marked in the browser
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);
```
## 📚 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 `
` 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/mmarked).
## 🎮 Demo
Try out our interactive demo [here](https://mathedu4all.github.io/mmarked/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)
💬 Join Our Discord: [https://discord.gg/6VMUVA5Yq2](https://discord.gg/6VMUVA5Yq2)
## 📄 License
See [LICENSE](./LICENSE.md)
For commercial use, please contact [email protected] for licensing details.
## 🤝 Contributing
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more details.
## 📞 Support
For questions or issues, please [open an issue](https://github.com/mathedu4all/mathcrowd-marked-lib/issues) on our GitHub repository.