# 果汁Markdown（JuiceMarkdown）

**Repository Path**: guoy35/juiceMarkdown

## Basic Information

- **Project Name**: 果汁Markdown（JuiceMarkdown）
- **Description**: 果汁Markdown - 现代化Markdown编辑器
类似Typora的所见即所得Markdown编辑器
支持实时预览、语法高亮、主题切换等功能
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-09-26
- **Last Updated**: 2025-12-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 果汁Markdown 📝

> 一款类似Typora的现代化、专业级Markdown编辑器 代码全部由AI生成

[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://python.org)
[![PyQt5](https://img.shields.io/badge/PyQt5-5.15+-green.svg)](https://riverbankcomputing.com/software/pyqt/)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Version](https://img.shields.io/badge/Version-1.0.0-orange.svg)](RELEASE_NOTES.md)

## 🌟 项目简介

果汁Markdown是一款基于Python和PyQt5开发的专业Markdown编辑器，致敬Typora的所见即所得编辑体验。它提供了实时预览、语法高亮、多主题支持等丰富功能，旨在为用户提供高效、美观的Markdown写作环境。

### ✨ 核心特性

- 🎨 **现代化界面** - 简洁美观的用户界面，类似Typora的设计风格
- ⚡ **实时预览** - 所见即所得的编辑体验，支持分屏预览
- 🎯 **语法高亮** - 完整的Markdown语法高亮支持
- 🌈 **多主题切换** - 内置亮色、暗色、Solarized等多种主题
- 🚀 **快速启动** - 优化的启动速度，提升77%性能
- 📁 **文件管理** - 支持新建、打开、保存、导出等完整文件操作
- 🔧 **专注模式** - F11全屏专注写作，ESC退出
- 📊 **实时统计** - 字数统计、字符计数等写作辅助功能

## 🏗️ 项目架构

### 📂 目录结构

```
markdown_editor/
├── 📁 app.py                    # 应用程序主类
├── 📁 main.py                   # 程序入口点
├── 📁 main_window.py             # 主窗口实现
├── 📁 start_clean.py             # 优化启动器（生产版）
├── 📁 start.py                  # 调试启动器
├── 📁 requirements.txt          # 依赖包列表
├── 📁 图标.png                  # 应用程序图标
├── 📁 图标_小.png               # 小尺寸图标
│
├── 📂 editor/                   # 编辑器核心模块
│   ├── 📄 __init__.py           # 模块初始化
│   ├── 📄 markdown_editor.py    # Markdown文本编辑器
│   ├── 📄 markdown_preview.py   # 实时预览组件
│   └── 📄 highlighter.py        # 语法高亮器
│
├── 📂 themes/                   # 主题系统
│   ├── 📄 __init__.py           # 模块初始化
│   ├── 📄 theme_manager.py      # 主题管理器
│   └── 📄 themes.py             # 主题定义文件
│
├── 📂 ui/                       # 用户界面组件
│   └── 📄 dialogs.py            # 对话框组件
│
├── 📂 utils/                    # 工具模块
│   └── 📄 file_operations.py    # 文件操作工具
│
├── 📂 dist/                     # 打包输出目录
│   └── 📄 果汁Markdown.exe      # 可执行文件
│
├── 📂 build/                    # 构建临时文件
├── 📂 __pycache__/              # Python缓存文件
│
├── 📄 build_clean.bat           # 纯净版打包脚本
├── 📄 create_icon.py            # 图标生成脚本
└── 📄 果汁Markdown.spec         # PyInstaller配置

```

### 🧩 模块说明

#### 核心应用层
- **app.py** - 应用程序主类，负责初始化PyQt5应用，设置样式和图标
- **main_window.py** - 主窗口类，实现菜单栏、状态栏、布局管理
- **start_clean.py** - 生产环境启动器，无调试输出，静默启动

#### 编辑器模块 (`editor/`)
- **markdown_editor.py** - 继承QPlainTextEdit的Markdown编辑器
- **markdown_preview.py** - 基于QWebEngineView的实时预览组件
- **highlighter.py** - Markdown语法高亮实现

#### 主题系统 (`themes/`)
- **theme_manager.py** - 主题管理器，负责主题切换和配置
- **themes.py** - 主题定义，包含亮色、暗色、Solarized等主题配色

#### 用户界面 (`ui/`)
- **dialogs.py** - 各种对话框组件（链接、图片、表格、关于等）

#### 工具模块 (`utils/`)
- **file_operations.py** - 文件操作工具（打开、保存、导出等）

## 🚀 技术栈

### 核心技术
- **Python 3.10+** - 主要开发语言
- **PyQt5 5.15+** - GUI框架，提供原生桌面应用体验
- **QWebEngineView** - 实时预览渲染引擎
- **markdown** - Markdown解析库

### 开发工具
- **PyInstaller** - 应用打包工具
- **Pillow** - 图像处理库
- **Pygments** - 代码语法高亮

### 设计理念
- **模块化架构** - 清晰的模块分离，便于维护和扩展
- **组件化设计** - 可复用的UI组件，提高开发效率
- **主题系统** - 支持多主题切换，满足不同用户喜好
- **性能优化** - 启动速度优化77%，流畅的用户体验

## ⚡ 性能优化

### 启动速度优化
- **延迟加载** - 非关键组件按需加载
- **模块拆分** - 将大型文件重构为模块化结构
- **智能缓存** - 缓存常用配置和主题
- **启动器优化** - 专用的生产环境启动器

### 内存优化
- **WebEngine配置** - 优化WebEngine内存使用
- **图像处理** - 高效的图标加载和缓存
- **资源管理** - 智能的资源释放机制

## 🎨 主题系统

### 内置主题
1. **Light Theme** - 经典亮色主题
2. **Dark Theme** - 护眼暗色主题
3. **Solarized Light** - Solarized亮色配色
4. **Solarized Dark** - Solarized暗色配色
5. **Monokai** - 经典编程主题

### 主题特性
- **实时切换** - 无需重启即可切换主题
- **完整覆盖** - 编辑器、预览、UI组件全面主题化
- **优雅滚动条** - 主题感知的滚动条样式
- **可扩展性** - 易于添加新主题

## 🛠️ 开发与构建

### 环境要求
```bash
Python 3.10+
PyQt5 5.15+
markdown 3.3+
Pillow 8.0+
pyinstaller 4.0+
```

### 快速开始
```bash
# 克隆项目
git clone <project-url>
cd markdown_editor

# 安装依赖
pip install -r requirements.txt

# 运行开发版本
python start.py

# 运行生产版本
python start_clean.py
```

### 构建可执行文件
```bash
# 构建纯净版（推荐）
.\build_clean.bat
```

## 📦 发布版本

### 当前版本：v1.0.0
下载地址：https://pan.baidu.com/s/1GHLfUv5z4VgaAPcgiags-Q?pwd=8888
- ✅ 完整的Markdown编辑功能
- ✅ 实时预览和语法高亮
- ✅ 多主题支持
- ✅ 文件管理功能
- ✅ 启动性能优化
- ✅ 独立可执行文件

### 版本特性
- **单文件部署** - 无需安装Python环境
- **完整功能** - 包含所有编辑和预览功能

## 🎯 使用指南

### 基本操作
1. **新建文档** - Ctrl+N 或 文件 → 新建
2. **打开文档** - Ctrl+O 或 文件 → 打开
3. **保存文档** - Ctrl+S 或 文件 → 保存
4. **导出文档** - 文件 → 导出 → HTML/PDF

### 编辑功能
- **粗体** - Ctrl+B 或 **文本**
- **斜体** - Ctrl+I 或 *文本*
- **插入链接** - Ctrl+K
- **插入图片** - Ctrl+G（本地）/ Ctrl+Shift+G（网络）
- **插入表格** - 格式 → 插入表格

### 视图功能
- **主题切换** - 视图 → 主题
- **专注模式** - F11进入，ESC退出
- **实时预览** - 自动分屏显示

## 🔧 高级功能

### 专注模式
- **全屏写作** - 隐藏菜单栏和状态栏
- **快捷退出** - ESC或F11快速退出
- **沉浸体验** - 专注于内容创作

### 文件导出
- **HTML导出** - 保持样式的网页格式
- **PDF导出** - 打印友好的文档格式
- **主题支持** - 导出内容遵循当前主题

### 图片处理
- **本地图片** - 支持相对路径和绝对路径
- **网络图片** - 在线图片预览
- **图片描述** - Alt文本支持

## 🚨 已知问题与解决方案

### 常见问题与故障排除
- **启动失败** - 检查Python环境和依赖包
- **预览异常** - 确认网络连接（WebEngine需要）
- **主题不生效** - 重启应用或重新选择主题
- **文件保存失败** - 检查目标目录权限

## 🌈 未来规划

### 短期目标
- [ ] 插件系统支持
- [ ] 更多主题选项
- [ ] 表格编辑增强
- [ ] 代码块高亮优化

### 长期愿景
- [ ] 多标签页支持


## 📞 技术支持

### 反馈渠道
- **项目地址**: [Gitee Repository](https://gitee.com/guoy35/juiceMarkdown)
- **问题报告**: 通过Issue提交bug报告
- **功能建议**: 通过Issue提交功能请求

### 贡献指南
1. Fork项目到个人仓库
2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交更改 (`git commit -m 'Add amazing feature'`)
4. 推送分支 (`git push origin feature/amazing-feature`)
5. 创建Pull Request

## 📄 许可证

本项目采用MIT许可证 - 查看 [LICENSE](LICENSE) 文件获取详细信息

---

## 🎉 致谢

- 感谢 [Typora](https://typora.io) 提供的设计灵感
- 感谢 [PyQt5](https://riverbankcomputing.com/software/pyqt/) 提供的强大GUI框架
- 感谢所有贡献者的支持和反馈

---

**果汁Markdown** - 让Markdown写作更加流畅和愉悦 ✨

*最后更新: 2025-09-27*