Skip to content

alltobebetter/MarkDo

Repository files navigation

MarkDo - 优雅的Markdown编辑器

一个功能丰富、界面美观的在线Markdown编辑器,支持实时预览和多种导出格式。

✨ 主要功能

📝 编辑功能

  • 实时预览:左侧编辑,右侧实时显示渲染结果
  • 丰富工具栏:支持常用Markdown语法快速插入
  • 撤销重做:支持Ctrl+Z/Ctrl+Y快捷键和工具栏按钮
  • 搜索替换:小型搜索栏,支持实时搜索和正则表达式
  • 智能编辑:自动处理列表、引用等格式
  • 自动保存:内容自动保存到本地存储
  • 字数统计:实时显示字符数

🎨 显示功能

  • 语法高亮:使用highlight.js进行代码语法高亮
  • 数学公式:集成KaTeX,支持LaTeX数学公式
  • 主题切换:支持明暗两种主题模式
  • 全屏模式:支持F11全屏编辑,专注写作
  • 同步滚动:编辑区和预览区支持同步滚动

📱 PWA功能(新增)

  • 应用安装:可安装到桌面,像原生应用一样使用
  • 离线支持:支持离线编辑和查看
  • 自动更新:后台自动更新到最新版本
  • 快速启动:缓存优化,启动速度更快

📤 导入导出功能

  • 文件导入:支持导入.md、.markdown、.txt文件
  • Markdown文件:下载原始.md文件
  • PNG图片:将渲染后的内容导出为高清图片
  • PDF文档:将渲染后的内容导出为PDF文件
  • HTML文档:导出为独立的HTML文件,包含样式和脚本

🛠 技术栈

  • 前端框架:纯HTML/CSS/JavaScript
  • Markdown解析:marked.js
  • 数学公式:KaTeX
  • 代码高亮:highlight.js
  • 图标库:Lucide
  • 字体:LXGW WenKai(霞鹜文楷)
  • 导出功能:html2canvas + jsPDF

🚀 使用方法

  1. 在左侧编辑器中输入Markdown内容
  2. 右侧会实时显示渲染效果,编辑器右上角显示字符统计
  3. 使用工具栏快速插入常用语法
  4. 使用快捷键提高效率:
    • Ctrl+Z/Y:撤销/重做
    • Ctrl+F:搜索替换
    • F11:全屏模式
  5. 点击工具栏按钮导入文件或导出:
    • 📤 导入按钮:导入MD文件
    • 📷 图片按钮:导出为PNG图片
    • 📄 文档按钮:导出为PDF文件
    • 🌐 代码按钮:导出为HTML文件
    • 📥 下载按钮:下载Markdown源文件
    • ☁️ 安装按钮:安装PWA应用(支持时显示)

📋 支持的Markdown语法

  • 标题(H1-H6)
  • 文本样式(加粗、斜体、删除线)
  • 列表(有序、无序)
  • 链接和图片
  • 代码块和行内代码
  • 表格
  • 引用
  • 数学公式(LaTeX语法)

🎯 导出功能特点

PNG图片导出

  • 高清晰度(2x缩放)
  • 保持完整样式
  • 自动文件命名
  • 支持长内容

PDF文档导出

  • A4页面格式
  • 自动分页处理
  • 保持原始样式
  • 适合打印

样式保真度

  • 代码块语法高亮完整保留
  • 数学公式正确渲染
  • 列表样式与网页一致
  • 表格、链接等元素完美还原

📁 文件结构

MarkDown/
├── index.html          # 主页面
├── script.js           # 核心功能脚本
├── style.css           # 样式文件
├── sw.js              # Service Worker
├── manifest.json      # PWA配置文件
├── browserconfig.xml  # 浏览器配置
├── favicon.svg        # 网站图标
├── favicon-16.svg     # 16px图标
├── icon-preview.html  # 图标预览页面
├── icons/             # PWA图标目录
└── README.md          # 说明文档

🌟 特色亮点

  1. 零配置使用:打开即用,无需安装
  2. PWA支持:可安装到设备,支持离线使用
  3. 完美导出:导出内容与网页显示完全一致
  4. 响应式设计:支持移动端使用
  5. 优雅界面:现代化设计,支持暗黑模式
  6. 高性能:纯前端实现,响应迅速

📝 更新日志

v4.0 (最新)

  • ✅ 新增PWA支持,可安装到设备
  • ✅ 新增离线编辑功能
  • ✅ 新增Service Worker缓存优化
  • ✅ 新增应用自动更新功能
  • ✅ 新增安装提示和引导

v3.0

  • ✅ 新增撤销/重做功能 (Ctrl+Z/Y)
  • ✅ 新增搜索替换功能 (Ctrl+F)
  • ✅ 新增全屏模式 (F11)
  • ✅ 新增字数统计显示
  • ✅ 新增文件导入功能 (.md/.txt)
  • ✅ 新增HTML导出功能
  • ✅ 新增水平分割线快捷按钮
  • ✅ 优化用户体验和界面交互

v2.0

  • ✅ 新增PNG图片导出功能
  • ✅ 新增PDF文档导出功能
  • ✅ 优化导出样式,确保与网页显示一致
  • ✅ 添加导出进度提示
  • ✅ 改进代码块和列表样式

v1.0

  • ✅ 基础Markdown编辑和预览
  • ✅ 工具栏快捷操作
  • ✅ 主题切换功能
  • ✅ 自动保存功能
  • ✅ Markdown文件下载

MarkDo - 让Markdown编辑更加优雅简单!

About

基于Html的优雅的Markdown编辑器

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors