MarkFlow Lite:一款功能强大的纯前端 Markdown 编辑器
在当今数字写作时代,选择一款合适的 Markdown 编辑器至关重要。今天,我要向大家推荐一款令人印象深刻的开源项目 —— MarkFlow Lite,这是一个完全运行在浏览器中的纯前端 Markdown 编辑器,无需服务器支持,开箱即用。
项目简介
MarkFlow Lite 是一个现代化的在线 Markdown 编辑器,它将简洁的界面设计、强大的功能和卓越的用户体验完美结合。该项目基于 React + TypeScript + Vite 技术栈构建,充分利用了现代前端技术的优势。
核心特点
- 纯前端架构:无需后端服务器,所有功能都在浏览器中运行
- 实时编辑预览:支持边写边看的双向同步预览
- 丰富的语法支持:包括数学公式、流程图、代码高亮等
- 多平台部署:支持 Vercel、Netlify、GitHub Pages 等多种部署方式
- 开源免费:采用 MIT 许可证,完全免费使用
核心功能
1. 实时编辑与预览
MarkFlow Lite 提供了三种编辑模式:
- 编辑模式:专注于 Markdown 内容编写
- 预览模式:查看渲染后的最终效果
- 分屏模式:同时显示编辑区和预览区,实时同步
欢迎使用 MarkFlow Lite
这是一个功能强大的Markdown 编辑器,支持:
- 实时预览
- 数学公式:E = mc^2
- 代码高亮
- 流程图绘制
2. 丰富的 Markdown 语法支持
编辑器支持标准的 Markdown 语法,并扩展了许多实用功能:
- 基础语法:标题、列表、引用、链接、图片
- 文本样式:粗体、斜体、删除线、上下标
- 代码支持:行内代码和代码块,支持多种编程语言语法高亮
- 表格:简洁的表格语法
- 任务列表:支持复选框的任务管理
3. 数学公式渲染
集成 KaTeX 引擎,支持 LaTeX 数学公式:
行内公式:E = mc^2
块级公式:
4. Mermaid 流程图
支持多种类型的图表绘制:
支持的图表类型包括:
- 流程图 (Flowchart)
- 时序图 (Sequence Diagram)
- 甘特图 (Gantt Diagram)
- 类图 (Class Diagram)
- 状态图 (State Diagram)
文件管理与存储
本地存储
- 自动保存:编辑内容自动保存到浏览器本地存储
- 草稿恢复:意外关闭浏览器后可恢复未保存的草稿
- 文件管理:支持新建、打开、保存 Markdown 文件
云存储集成
MarkFlow Lite 支持多种云存储后端:
- AWS S3:连接到 S3 存储桶进行文件管理
- WebDAV:连接到任何支持 WebDAV 的服务器
- 本地存储:浏览器本地存储(默认)
通过文件资源管理器,用户可以:
- 连接和断开云存储服务
- 浏览远程文件夹结构
- 创建、编辑、删除远程文件
- 同步本地和远程文件
多格式导出
支持将 Markdown 文档导出为多种格式:
- PDF 导出:高质量的 PDF 文档,保留格式和样式
- HTML 导出:独立的 HTML 文件,可在浏览器中直接打开
- Markdown 导出:原始 Markdown 文件,便于后续编辑
用户体验优化
主题切换
提供深色和浅色两种主题:
- 浅色主题:适合白天使用,清晰明亮
- 深色主题:适合夜间使用,保护眼睛
快捷键支持
提供常用的快捷键操作:
Ctrl + B:粗体Ctrl + I:斜体Ctrl + K:插入链接
响应式设计
完美适配各种设备:
- 桌面端:完整的编辑体验
- 平板端:优化的触摸操作
- 手机端:简洁的移动界面
技术架构
前端技术栈
// 主要技术栈
- React 18.x - 用户界面框架
- TypeScript - 类型安全的 JavaScript
- Vite - 现代化构建工具
- Tailwind CSS - 实用优先的 CSS 框架
核心依赖
// Markdown 处理
"markdown-it": "^14.1.0",
"markdown-it-katex": "^2.0.3",
"mermaid": "^10.9.4",
// 代码高亮
"highlight.js": "^11.11.1",
// 文件导出
"html2pdf.js": "^0.12.0",
"jspdf": "^3.0.2",
// 云存储
"@aws-sdk/client-s3": "^3.888.0",
"webdav": "^5.8.0"
部署与使用
在线使用
直接访问 MarkFlow Lite 在线版 即可开始使用。
本地开发
# 克隆项目
git clone https://github.com/blankzsh/markflow-lite.git
# 进入项目目录
cd markflow-lite
# 安装依赖
npm install
# 启动开发服务器
npm run dev
# 构建生产版本
npm run build
多平台部署
项目支持多种部署方式:
# 部署到 Vercel
npm run build
vercel --prod
# 部署到 Netlify
npm run build
# 上传 dist 目录到 Netlify
# 部署到 GitHub Pages
npm run build
# 将 dist 目录推送到 gh-pages 分支
近期更新与修复
开发团队积极维护项目,最近修复了多个重要问题:
- 修复了流程图渲染过大问题,优化了图表尺寸控制
- 解决了代码块被表格遮挡的问题
- 修复了流程图渲染后页面底部出现大片空白的问题
- 优化了所有内容在同一层正确显示的顺序
- 移除了 PWA 功能及相关配置,解决了构建问题
开源社区
MarkFlow Lite 是一个活跃的开源项目:
- GitHub 仓库:https://github.com/blankzsh/markflow-lite
- 开源许可证:MIT License
- 贡献方式:欢迎提交 Issue 和 Pull Request
如何贡献
- Fork 项目到自己的 GitHub 账户
- 创建功能分支 (
git checkout -b feature/AmazingFeature) - 提交更改 (
git commit -m 'Add some AmazingFeature') - 推送到分支 (
git push origin feature/AmazingFeature) - 开启 Pull Request
适用场景
MarkFlow Lite 适合多种使用场景:
个人写作
- 博客文章:撰写技术博客和生活随笔
- 学习笔记:记录学习过程中的思考和总结
- 日记写作:个人日常记录和反思
团队协作
- 文档编写:技术文档和 API 文档
- 项目说明:项目介绍和使用指南
- 会议记录:团队会议纪要和决策记录
教育领域
- 课件制作:教学材料和课程内容
- 作业提交:学生作业和报告撰写
- 学术写作:论文和研究报告
项目亮点
1. 完全离线可用
由于是纯前端应用,MarkFlow Lite 可以完全离线使用,所有数据都存储在本地,保证了数据的安全性和隐私性。
2. 优秀的性能表现
基于 Vite 构建工具和 React 18,应用具有出色的性能表现,编辑和预览都非常流畅。
3. 丰富的扩展功能
除了基础的 Markdown 编辑功能外,还支持数学公式、流程图、代码高亮等高级功能。
4. 跨平台兼容
支持所有现代浏览器,包括 Chrome、Firefox、Safari、Edge 等,确保了良好的兼容性。
未来展望
基于项目的发展趋势和技术栈,我们可以期待以下功能:
即将推出的功能
- 更多导出格式:如 Word、EPUB 等
- 版本控制:文档历史版本管理
- 协作编辑:实时多人协作编辑
- 插件系统:支持第三方插件扩展
技术优化方向
- 性能优化:进一步提升大文件处理能力
- 移动端优化:更好的移动设备体验
- 无障碍访问:提升可访问性支持
总结
MarkFlow Lite 是一个功能强大、设计精美的 Markdown 编辑器,它凭借:
- 纯前端架构:无需服务器,即开即用
- 丰富的功能:支持数学公式、流程图、代码高亮
- 优秀的体验:实时预览、主题切换、快捷键支持
- 多平台部署:支持多种部署方式
- 开源免费:完全免费使用和修改
无论是个人写作、团队协作还是教育领域,MarkFlow Lite 都是一个值得推荐的选择。如果你正在寻找一款功能全面、易于使用的 Markdown 编辑器,不妨试试 MarkFlow Lite!
项目地址:https://github.com/blankzsh/markflow-lite
在线体验:https://editor.currso.com
联系方式:shell7@petalmail.com