# easyMD

**Repository Path**: laoguaige/easy-md

## Basic Information

- **Project Name**: easyMD
- **Description**: 立志于制作一个简单易用的在线 Markdown 编辑工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-28
- **Last Updated**: 2026-01-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# easyMD

#### 介绍
立志于制作一个简单易用的在线 Markdown 编辑工具，支持实时预览、多种导出格式、主题切换等功能。

#### 软件架构
- **前端框架**：纯 HTML5 + CSS3 + JavaScript
- **构建工具**：Vite
- **Markdown 解析**：markdown-it
- **代码高亮**：highlight.js
- **导出功能**：jsPDF + html2canvas
- **图片处理**：Canvas API + Base64 编码

#### 功能特性
1. **实时预览**：编辑 Markdown 时实时显示渲染效果
2. **多种导出**：支持导出为 PDF 和图片
3. **主题切换**：内置默认、绿色、蓝色、紫色四种主题
4. **滚动同步**：编辑区和预览区滚动位置自动同步
5. **图片支持**：支持粘贴图片、设置图片大小和添加图片描述
6. **高亮块**：支持 info、tip、warning、danger、details 五种高亮块
7. **代码块**：支持代码高亮和复制功能
8. **表格支持**：支持 Markdown 表格语法
9. **响应式布局**：适配不同屏幕尺寸

#### 安装教程

1. **克隆仓库**
   ```bash
   git clone https://gitee.com/yourusername/easyMD.git
   cd easyMD
   ```

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

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

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

5. **预览生产版本**
   ```bash
   npm run preview
   ```

#### 使用说明

1. **基本编辑**：在左侧编辑区输入 Markdown 语法
2. **实时预览**：右侧预览区会实时显示渲染效果
3. **主题切换**：在顶部工具栏选择主题颜色
4. **导出功能**：点击顶部工具栏的导出按钮导出为 PDF 或图片
5. **图片处理**：
   - 直接粘贴图片到编辑区
   - 使用 `![描述{width=300 height=200}](图片链接)` 设置图片大小
   - 使用 `::: image 图片标题` 创建带背景块的图片
6. **高亮块**：使用 `::: info 标题` 等语法创建不同类型的高亮块
7. **代码块**：使用 ``` 包裹代码，并指定语言获取语法高亮

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request

#### 技术栈
- Vite 4.4.5
- markdown-it 13.0.2
- highlight.js 11.9.0
- jsPDF 2.5.1
- html2canvas 1.4.1
- github-markdown-css

#### 许可证
MIT License