Bm.md

🚀 更好用的 Markdown 排版助手

本项目是一款强大的 Markdown 排版助手，可一键适配微信公众号、网页与图片，为用户提供便捷、高效的排版体验。

🚀 快速开始

# 克隆项目
git clone https://github.com/miantiao-me/bm.md.git
cd bm.md

# 安装依赖
pnpm install

# 启动开发服务器
pnpm dev

访问 http://localhost:2663 即可开始使用。

✨ 主要特性

• 📝 实时预览：基于 CodeMirror 6 的 Markdown 编辑器，真正实现所见即所得。
• 🎨 14 种排版样式：涵盖从专业商务到复古怀旧等多种风格，充分满足不同场景需求。
• 🌈 14 种代码主题：支持浅色、深色等多种代码高亮风格。
• 📱 多平台适配：可一键复制排版内容到微信公众号。
• 🖼️ 图片导出：能将排版内容导出为图片进行分享。
• 🔌 开发者友好：提供 REST API 和 MCP 协议集成。
• ⌨️ 快捷操作：配备命令面板和全局快捷键，实现高效操作。

🔧 技术细节

• 框架：采用 TanStack Start（React 19 + TanStack Router）。
• 构建：使用 Vite 7 进行构建。
• 样式：结合 Tailwind CSS 4 和 shadcn/ui 进行样式设计。
• 部署：借助 Nitro 实现部署，支持 Cloudflare Workers、Vercel、Netlify、Docker、Alibaba ESA、Tencent EdgeOne 等多种环境。

本项目由阿里云ESA提供加速、计算和保护:

阿里云部署配置如下：

安装命令: pnpm install
构建命令: pnpm run build
根目录: /
静态资源目录: dist/client
函数文件路径: dist/server/server.js

其他环境部署配置可参考 Nitro 文档。

📚 详细文档

• 功能说明：完整的功能介绍。
• 架构设计：技术架构的详细解析。
• UI 设计：界面设计的相关说明。
• API 文档：REST API 参考。

🤝 贡献

欢迎提交 Issue 和 Pull Request，共同为项目发展贡献力量。

📄 许可证

本项目采用 AGPL - 3.0 许可证。