bm.md

# bm.md A better Markdown typesetting assistant, specially adapted for WeChat public accounts, supporting output to web pages and images. --- ## ✨ Features - 📝 **Real-time Preview** - Markdown editor based on CodeMirror 6, what you see is what you get - 🎨 **15 Typesetting Styles** - From professional business to retro nostalgia, meeting different scenario needs - 🌈 **14 Code Themes** - Supporting light/dark multiple code highlighting styles - 📱 **Platform Adaptation** - Specially adapted for WeChat public accounts, also supporting general HTML output - 📊 **Charts and Infographics** - Supporting Mermaid and AntV Infographic - 🖼️ **Image Export** - Download JPEG or copy PNG images - 📄 **PDF and Printing** - Supporting high-quality paginated PDF export and direct printing - 🌓 **Light/Dark Mode** - Supporting light and dark interface switching - 🔌 **Developer Friendly** - Providing CLI, REST API, and MCP protocol integration - ⌨️ **Quick Operations** - Command panel + global shortcuts, efficient operation ## 🚀 Quick Start ```bash # Clone the project git clone https://github.com/miantiao-me/bm.md.git cd bm.md # Install dependencies pnpm install # Start the development server pnpm dev ``` Visit http://localhost:2663 to start using. ### CLI Usage `bmmd` can reuse core Markdown processing capabilities in the command line, supporting file input or stdin, and default output to stdout. Install and use `bmmd` directly; or use `pnpm dlx bmmd` temporarily without installation. ```bash # Run after global installation pnpm add -g bmmd bmmd render article.md --platform wechat --output article.html # Temporary run without installation pnpm dlx bmmd render article.md --platform wechat --output article.html # Pipeline input cat article.md | bmmd extract # Fix Markdown and write back to source file bmmd lint article.md --fix ``` Local development can execute `pnpm build:cli` to build CLI, with the entry file being `bin/bmmd.mjs`. ## 🛠️ Tech Stack - **Framework**: [TanStack Start](https://tanstack.com/start) (React 19 + TanStack Router) - **Build**: [Vite 8](https://vite.dev) - **Styles**: [Tailwind CSS 4](https://tailwindcss.com) + [shadcn/ui](https://ui.shadcn.com) - **Deployment**: [Nitro](https://nitro.build) (supporting Cloudflare Workers / Vercel / Netlify / Docker / Alibaba ESA / Tencent EdgeOne, etc.) Alibaba Cloud deployment configuration: ```txt Installation command: pnpm install Build command: pnpm run build Root directory: / Static resource directory: dist/client Function file path: dist/server/server.js ``` Tencent Cloud EdgeOne deployment configuration: ```txt Framework preset: Other Root directory: ./ Output directory: .edgeone Compilation command: pnpm run build Installation command: pnpm install ``` EdgeOne build environment is automatically identified by std-env, and Nitro will automatically select the official preset. Refer to [Nitro](https://nitro.build/deploy) documentation for other environment deployment configurations. ## 📖 Documentation - [Feature Description](https://github.com/miantiao-me/bm.md/blob/master/docs/features.md) - Complete feature introduction - [Architecture Design](https://github.com/miantiao-me/bm.md/blob/master/docs/architecture.md) - Technical architecture explanation - [UI Design](https://github.com/miantiao-me/bm.md/blob/master/docs/design.md) - Interface design explanation - [UI Skill](https://github.com/miantiao-me/bm.md/blob/master/docs/ui-skill.md) - Intelligent agent UI constraint - [API Documentation](https://bm.md/docs) - REST API reference ## 🙏 Acknowledgements - [Kami](https://github.com/tw93/Kami) — Inspiration source for the "Kami" typesetting style. ## 🤝 Contribution Welcome to submit issues and pull requests. ## 📄 License [AGPL-3.0](https://github.com/miantiao-me/bm.md/blob/master/LICENSE)