bmmd
v0.2.0
Published
Markdown 排版 CLI,支持微信公众号与 HTML 输出。
Readme
bm.md
更好用的 Markdown 排版助手|微信公众号专门适配,支持输出到网页与图片。
✨ 特性
- 📝 实时预览 - 基于 CodeMirror 6 的 Markdown 编辑器,所见即所得
- 🎨 15 种排版样式 - 从专业商务到复古怀旧,满足不同场景需求
- 🌈 14 种代码主题 - 支持浅色/深色多种代码高亮风格
- 📱 平台适配 - 微信公众号专门适配,同时支持通用 HTML 输出
- 📊 图表与信息图 - 支持 Mermaid 与 AntV Infographic
- 🖼️ 图片导出 - 下载 JPEG 或复制 PNG 图片
- 📄 PDF 与打印 - 支持高质量分页 PDF 导出和直接打印
- 🌓 明暗模式 - 支持浅色、深色界面切换
- 🔌 开发者友好 - 提供 CLI、REST API 和 MCP 协议集成
- ⌨️ 快捷操作 - 命令面板 + 全局快捷键,高效操作
🚀 快速开始
# 克隆项目
git clone https://github.com/miantiao-me/bm.md.git
cd bm.md
# 安装依赖
pnpm install
# 启动开发服务器
pnpm dev访问 http://localhost:2663 开始使用。
CLI 使用
bmmd 可在命令行中复用核心 Markdown 处理能力,支持文件输入或 stdin,默认输出到 stdout。安装后直接使用 bmmd;未安装时可通过 pnpm dlx bmmd 临时运行。
# 全局安装后运行
pnpm add -g bmmd
bmmd render article.md --platform wechat --output article.html
# 临时运行,无需安装
pnpm dlx bmmd render article.md --platform wechat --output article.html
# 管道输入
cat article.md | bmmd extract
# 修复 Markdown 并写回源文件
bmmd lint article.md --fix本地开发可执行 pnpm build:cli 构建 CLI,入口文件为 bin/bmmd.mjs。
🛠️ 技术栈
- 框架: TanStack Start (React 19 + TanStack Router)
- 构建: Vite 8
- 样式: Tailwind CSS 4 + shadcn/ui
- 部署: Nitro (支持 Cloudflare Workers / Vercel / Netlify / Docker / Alibaba ESA / Tencent EdgeOne 等)
阿里云部署配置:
安装命令: pnpm install
构建命令: pnpm run build
根目录: /
静态资源目录: dist/client
函数文件路径: dist/server/server.js腾讯云 EdgeOne 部署配置:
框架预设: Other
根目录: ./
输出目录: .edgeone
编译命令: pnpm run build
安装命令: pnpm installEdgeOne 构建环境由 std-env 自动识别,Nitro 会自动选择官方 preset。
其他环境部署配置参考 Nitro 文档。
📖 文档
🙏 致谢
- Kami — 「Kami」排版风格的灵感来源。
🤝 贡献
欢迎提交 Issue 和 Pull Request。
