{"id":17781691,"url":"https://github.com/mathedu4all/mmarked-vscode-extension","last_synced_at":"2026-05-10T19:12:32.303Z","repository":{"id":259571197,"uuid":"878215490","full_name":"mathedu4all/mmarked-vscode-extension","owner":"mathedu4all","description":"An alternative to the builtin markdown previewer based on @mathcrowd/mmarked.","archived":false,"fork":false,"pushed_at":"2024-10-28T12:45:33.000Z","size":175,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T13:15:28.954Z","etag":null,"topics":["markdown","markdown-previewer","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mathedu4all.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-25T01:15:58.000Z","updated_at":"2024-11-07T11:07:46.000Z","dependencies_parsed_at":"2024-10-26T16:21:23.323Z","dependency_job_id":"ac485698-8b7d-469b-9062-5e551cf65ea1","html_url":"https://github.com/mathedu4all/mmarked-vscode-extension","commit_stats":null,"previous_names":["mathedu4all/mmarked-vscode-extension"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathedu4all%2Fmmarked-vscode-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathedu4all%2Fmmarked-vscode-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathedu4all%2Fmmarked-vscode-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathedu4all%2Fmmarked-vscode-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mathedu4all","download_url":"https://codeload.github.com/mathedu4all/mmarked-vscode-extension/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246706025,"owners_count":20820783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markdown-previewer","vscode-extension"],"created_at":"2024-10-27T04:04:15.501Z","updated_at":"2026-05-10T19:12:32.298Z","avatar_url":"https://github.com/mathedu4all.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MMarked - Enhanced Markdown Preview for VS Code\n\n[![Version](https://img.shields.io/visual-studio-marketplace/v/MCLab.mmarked?label=Version\u0026color=blue)](https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked)\n[![Installs](https://img.shields.io/visual-studio-marketplace/i/MCLab.mmarked?label=Installs\u0026color=success)](https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked)\n[![Downloads](https://img.shields.io/visual-studio-marketplace/d/MCLab.mmarked?label=Downloads\u0026color=orange)](https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked)\n[![Rating](https://img.shields.io/visual-studio-marketplace/r/MCLab.mmarked?label=Rating\u0026color=yellow)](https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked)\n[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n\nA powerful Visual Studio Code extension that brings advanced Markdown rendering with LaTeX math support, powered by [@mathcrowd/mmarked](https://github.com/mathedu4all/mmarked).\n\n**[中文文档](./README.zh.md)** | **[Marketplace](https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked)** | **[GitHub](https://github.com/mathedu4all/mmarked-vscode-extension)**\n\n## 📖 Overview\n\nTransform your Markdown editing experience with **MMarked** - a specialized preview extension designed for educational and mathematical content. Built on the powerful [@mathcrowd/mmarked](https://github.com/mathedu4all/mmarked) library, it brings real-time rendering of complex LaTeX formulas, theorem blocks, and custom syntax to your VS Code workspace.\n\n**Perfect for:**\n- 📚 Educators creating math course materials\n- 🎓 Students writing technical notes and assignments\n- 📝 Researchers authoring academic papers\n- 💡 Anyone working with mathematical notation in Markdown\n\n## ✨ Features\n\n### Core Capabilities\n- ✅ **Full CommonMark Support** - Complete compatibility with standard Markdown syntax\n- ⚡ **Real-Time Preview** - Instant visual feedback as you type (300ms debounced)\n- 🌗 **Smart Theme Switching** - Automatically adapts to your VS Code theme (light/dark)\n- 📋 **WeChat Export** - One-click copy HTML optimized for WeChat Official Account editor\n\n### Mathematical Content\n- 🧮 **Advanced LaTeX Rendering** - Powered by MathJax for professional-quality formulas\n- 📐 **TeX to SVG Conversion** - Optional high-quality SVG output for equations\n- 🔢 **Auto-Numbered Footnotes** - Easy-to-use reference system\n\n### Educational Features\n- 📘 **Theorem-Like Blocks** - Dedicated syntax for theorems, lemmas, definitions, and examples\n  - Auto-numbering support\n  - Cross-reference linking\n  - Customizable titles\n- 🔍 **Collapsible Solution Blocks** - Hide/show answers with toggle buttons\n- 🎯 **Syntax Highlighting** - Code blocks enhanced by highlight.js\n\n### Media \u0026 Customization\n- 🖼️ **Local Image Support** - Automatic path resolution for relative images\n- 📏 **Image/Video Resizing** - Simple syntax for custom dimensions\n- 🎨 **Custom CSS** - Configure your own stylesheets for complete control\n\n## 🚀 Installation\n\n### Method 1: VS Code Marketplace (Recommended)\n1. Open Visual Studio Code\n2. Go to Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on Mac)\n3. Search for **\"mmarked\"**\n4. Click **Install**\n\n### Method 2: Quick Install\nClick here: [Install MMarked](vscode:extension/MCLab.mmarked)\n\n### Method 3: Command Line\n```bash\ncode --install-extension MCLab.mmarked\n```\n\n## 📘 Usage\n\n### Quick Start\n1. **Open** any Markdown file (`.md`)\n2. **Click** the VSCode preview button (👁️) in the editor title bar for standard preview, or\n3. **Press** `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac) to open the command palette\n4. **Type** and select: `Markdown: Open Preview` for mmarked preview\n5. **Edit** your Markdown and see live updates in the preview pane\n\n### Copy to WeChat Official Account\n1. **Open** your Markdown file\n2. **Click** the copy button (📋) in the editor title bar, or use command palette\n3. **Select**: `Copy HTML for WeChat`\n4. **Paste** into WeChat Official Account editor - formatting preserved!\n\n### Keyboard Shortcuts\nYou can assign custom keyboard shortcuts in VS Code:\n1. Go to `File` \u003e `Preferences` \u003e `Keyboard Shortcuts`\n2. Search for `mmarked.previewMarkdown` or `mmarked.copyToWeChat`\n3. Set your preferred key bindings\n\n### Tips\n- The preview updates automatically with a 300ms delay as you type\n- Preview panel opens in the second editor column by default\n- Local images are automatically resolved relative to your document\n- WeChat export includes inlined CSS for consistent rendering\n\n## ⚙️ Configuration\n\nCustomize the extension by adding settings to your VS Code configuration file (`.vscode/settings.json` or User Settings):\n\n### Available Settings\n\n| Setting | Type | Default | Description |\n|---------|------|---------|-------------|\n| `mmarked.cssUrl` | `string` | `https://cdn2.mathcrowd.cn/assets/styles/mathcrowd.css` | URL for the light theme stylesheet |\n| `mmarked.darkCssUrl` | `string` | `https://cdn2.mathcrowd.cn/assets/styles/mathcrowd-dark.css` | URL for the dark theme stylesheet |\n| `mmarked.enableTex2svg` | `boolean` | `false` | Enable TeX to SVG conversion for better quality math rendering |\n| `mmarked.removeLinksForWeChat` | `boolean` | `false` | Remove hyperlinks when copying to WeChat |\n| `mmarked.showPreviewButton` | `boolean` | `false` | Show mmarked preview button in editor title bar (use command palette instead to avoid duplicate buttons) |\n\n### Example Configuration\n\n```json\n{\n  \"mmarked.cssUrl\": \"https://cdn2.mathcrowd.cn/assets/styles/mathcrowd.css\",\n  \"mmarked.darkCssUrl\": \"https://cdn2.mathcrowd.cn/assets/styles/mathcrowd-dark.css\",\n  \"mmarked.enableTex2svg\": true,\n  \"mmarked.removeLinksForWeChat\": false,\n  \"mmarked.showPreviewButton\": false\n}\n```\n\n### Using Custom Stylesheets\n\nYou can use your own CSS by providing a custom URL:\n\n```json\n{\n  \"mmarked.cssUrl\": \"https://your-domain.com/styles/custom-light.css\",\n  \"mmarked.darkCssUrl\": \"https://your-domain.com/styles/custom-dark.css\"\n}\n```\n\n**Note:** Custom CSS must be hosted on a public URL (local files are not supported for security reasons).\n\n## 📚 About MMarked\n\n**MMarked** is a specialized Markdown renderer designed for educational and mathematical content. It extends standard Markdown with powerful features for academic writing, including theorem blocks, numbered definitions, collapsible solutions, and advanced LaTeX support.\n\n🔗 **Learn More:**\n- [MMarked Product Page](https://lab.mathcrowd.cn/mmarked)\n- [MMarked GitHub Repository](https://github.com/mathedu4all/mmarked)\n- [Documentation \u0026 Syntax Guide](https://lab.mathcrowd.cn/mmarked)\n\n## 🤝 Support \u0026 Community\n\n### Get Help\n- 🐛 **Bug Reports:** [GitHub Issues](https://github.com/mathedu4all/mmarked-vscode-extension/issues)\n- 💡 **Feature Requests:** [GitHub Issues](https://github.com/mathedu4all/mmarked-vscode-extension/issues)\n- 📖 **Documentation:** [MMarked Docs](https://lab.mathcrowd.cn/mmarked)\n- 💬 **Community Chat:** [Join Our Discord](https://discord.gg/6VMUVA5Yq2)\n\n### Library-Specific Issues\nFor questions about the `@mathcrowd/mmarked` library itself (not the VS Code extension), please [open an issue](https://github.com/mathedu4all/mmarked/issues) on the MMarked repository.\n\n## 🌟 About Mathcrowd\n\n**Mathcrowd** is an innovative education technology company founded by experienced developers and educators, dedicated to transforming mathematics education through cutting-edge technology. We create engaging, interactive, and visualized learning experiences for math enthusiasts and self-learners.\n\n### Connect With Us\n- 🌐 [MCLab Official Website](https://lab.mathcrowd.cn)\n- 📚 [Online Math Community](https://www.mathcrowd.cn)\n- 💬 [Discord Server](https://discord.gg/6VMUVA5Yq2)\n- 💖 [Support Our Work](https://www.mathcrowd.cn/crowd-funding/charging)\n\n## 🛠️ Development \u0026 Contributing\n\nInterested in contributing to this extension? We welcome pull requests, bug reports, and feature suggestions!\n\n**For developers and contributors, see:**\n- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Complete development guide\n- **[GitHub Repository](https://github.com/mathedu4all/mmarked-vscode-extension)** - Source code\n- **[Changelog](CHANGELOG.md)** - Version history\n\n## 📄 License\n\nThis extension is licensed under the [MIT License](LICENSE).\n\n---\n\n## 🙏 Acknowledgments\n\n- Built with [@mathcrowd/mmarked](https://github.com/mathedu4all/mmarked)\n- Math rendering powered by [MathJax](https://www.mathjax.org/)\n- Code highlighting by [highlight.js](https://highlightjs.org/)\n\n---\n\n**Note:** This extension bundles `@mathcrowd/mmarked` to ensure compatibility and optimal performance.\n\n**Enjoy using MMarked!** ⭐ If you find it helpful, please consider [leaving a review](https://marketplace.visualstudio.com/items?itemName=MCLab.mmarked\u0026ssr=false#review-details) on the Marketplace!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathedu4all%2Fmmarked-vscode-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathedu4all%2Fmmarked-vscode-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathedu4all%2Fmmarked-vscode-extension/lists"}