# Markdown editor

**Repository Path**: yushunliee/markdown-editor

## Basic Information

- **Project Name**: Markdown editor
- **Description**: Markdown editor 编辑器 
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-02-19
- **Last Updated**: 2025-04-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown文档编辑器

一个功能强大的在线Markdown编辑器，支持实时预览、数学公式、代码高亮和快捷键操作。

## 主要特性

- 📝 实时预览Markdown渲染效果
- ⚡ 丰富的快捷键支持
- 📊 自定义表格创建
- 🔢 LaTeX数学公式支持
- 📑 文档大纲导航
- 💾 导入/导出Markdown文件
- 🎨 代码块语法高亮
- 📱 响应式设计

## 快捷键

### 文档结构
- Ctrl + 1~6：创建对应级别的标题
- Alt + O：显示/隐藏大纲（也可点击工具栏按钮）

### 格式化
- Ctrl + B：粗体
- Ctrl + I：斜体
- Ctrl + Shift + K：代码块

### 列表
- Ctrl + Shift + ]：无序列表
- Ctrl + Shift + [：有序列表

### 其他功能
- Ctrl + T：插入表格（可自定义行列数）
- Ctrl + S：保存文档
- F11：全屏模式

## 开发技术

- React 19
- TypeScript
- Vite
- @uiw/react-md-editor
- KaTeX
- File Saver

## 本地开发

1. 克隆项目

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

3. 启动开发服务器
```bash
npm run dev
```

4. 构建项目
```bash
npm run build
```

## 使用说明

1. 在编辑器中输入Markdown文本
2. 使用快捷键快速插入常用格式
3. 右侧实时预览渲染效果
4. 使用Ctrl+L显示/隐藏文档大纲
5. 可随时导入/导出Markdown文件

## 浏览器支持

- Chrome
- Firefox
- Safari
- Edge

## 贡献指南

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

## 许可证

MIT License - 详见 [LICENSE](LICENSE) 文件

## 特色功能

- 📝 实时预览Markdown渲染效果
- 📊 自定义表格创建（行列数可调）
- 🔢 LaTeX数学公式支持
- 📑 文档大纲导航（Alt+L快速开关）
- 💾 导入/导出Markdown文件
- 🎨 代码块语法高亮
- 🖥️ 支持全屏模式
- 📱 响应式设计