# MDE

**Repository Path**: feilang864/mde

## Basic Information

- **Project Name**: MDE
- **Description**: MDE 是一个基于 Tauri + TypeScript 开发的开源 Markdown 编辑器，旨在完全复刻 Typora 的所有核心功能（授权码、收费及服务器功能除外），为用户提供免费、高性能、跨平台的 Markdown 编辑体验。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-04-17
- **Last Updated**: 2026-04-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MDE - Markdown Editor

MDE 是一个基于 Tauri + TypeScript 开发的开源 Markdown 编辑器，旨在完全复刻 Typora 的所有核心功能（授权码、收费及服务器功能除外），为用户提供免费、高性能、跨平台的 Markdown 编辑体验。

## 🎯 项目目标

- **功能完整**：复刻 Typora 的所有核心功能
- **跨平台兼容**：支持 Windows、macOS、Linux
- **高性能**：基于 Tauri 框架，利用 Rust 后端和 Web 前端的优势
- **开源免费**：完全开源，免费供用户使用
- **可扩展性**：支持主题定制和功能扩展

## ✨ 核心功能

### 基础功能
- **所见即所得编辑**：实时预览渲染效果，无需切换视图
- **Markdown 语法支持**：完整支持 CommonMark 和 GitHub Flavored Markdown
- **数学公式**：支持 LaTeX 数学公式的编辑和渲染
- **表格编辑**：可视化表格编辑，支持单元格操作
- **代码块**：支持多种编程语言的语法高亮
- **图片处理**：支持图片拖拽、粘贴和管理
- **文件管理**：支持文件的创建、打开、保存和导出
- **主题系统**：内置多种主题，支持自定义主题
- **快捷键**：丰富的快捷键支持，提高编辑效率

### 高级功能
- **目录导航**：自动生成目录，支持快速跳转
- **大纲视图**：侧边栏显示文档大纲，方便导航
- **搜索替换**：支持文本搜索和替换功能
- **自动保存**：自动保存编辑内容，防止意外丢失
- **导出功能**：支持导出为 PDF、HTML、Word 等格式

## 🛠 技术栈

- **前端**：TypeScript + React
- **桌面应用框架**：Tauri
- **构建工具**：Vite
- **Markdown 解析**：marked
- **代码高亮**：highlight.js
- **数学公式**：KaTeX

## 📦 安装

### 前提条件
- Node.js 16+
- Rust 1.60+
- Tauri 依赖（详见 [Tauri 官方文档](https://tauri.app/docs/getting-started/prerequisites)）

### 安装步骤

1. **克隆仓库**
   ```bash
   git clone https://github.com/your-username/mde.git
   cd mde
   ```

2. **安装依赖**
   ```bash
   npm install
   ```

3. **开发模式运行**
   ```bash
   npm run tauri dev
   ```

4. **构建生产版本**
   ```bash
   npm run tauri build
   ```

## 🚀 使用指南

### 基本操作
- **新建文件**：点击菜单栏「文件」→「新建」或使用快捷键 `Ctrl+N`
- **打开文件**：点击菜单栏「文件」→「打开」或使用快捷键 `Ctrl+O`
- **保存文件**：点击菜单栏「文件」→「保存」或使用快捷键 `Ctrl+S`
- **导出文件**：点击菜单栏「文件」→「导出」，选择导出格式

### 编辑功能
- **格式化文本**：使用工具栏按钮或快捷键进行文本格式化
- **插入数学公式**：使用 `$$` 包裹公式内容
- **插入代码块**：使用 ``` 包裹代码，指定语言
- **插入表格**：使用工具栏按钮或 Markdown 语法创建表格

### 主题切换
- 点击菜单栏「视图」→「主题」，选择喜欢的主题

## 🤝 贡献

我们欢迎社区贡献！如果您想参与项目开发，请：

1. Fork 本仓库
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开 Pull Request

请参考 [项目规范文档](docs/001_项目规范文档.md) 了解开发规范。

## 📄 文档

- [项目规范文档](docs/001_项目规范文档.md)：开发规范和项目结构
- [项目立项书](docs/002_项目立项书.md)：项目背景和规划
- [Typora 功能列表](docs/003_Typora功能.md)：详细的功能清单
- [需求列表](docs/004_需求列表.md)：项目需求明细

## 📞 联系方式

如有问题或建议，请通过以下方式联系我们：
- GitHub Issues：[提交 Issue](https://github.com/your-username/mde/issues)
- 邮件：your-email@example.com

## 📄 许可证

本项目采用 MIT 许可证，详见 [LICENSE](LICENSE) 文件。

---

**MDE** - 开源、免费、功能完整的 Markdown 编辑器，让 Markdown 编辑更加简单高效！