Files
mmkk/START_GUIDE.md
guo liwei 9b3f959c3d Initial commit: Markdown editor with file management and regex tools
项目特性:
- 完整的Markdown编辑器,支持实时预览
- 文件管理功能,支持保存/加载/删除文件
- 正则表达式工具,支持批量文本替换
- 前后端分离架构
- 响应式设计

技术栈:
- 前端:React + TypeScript + Vite
- 后端:Python Flask
- Markdown解析:Python-Markdown

包含组件:
- WorkingMarkdownEditor: 基础功能版本
- FullMarkdownEditor: 完整功能版本
- SimpleMarkdownEditor: 简化版本
2025-08-03 06:21:02 +08:00

149 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Markdown编辑器启动指南
## 🚀 快速启动
### 方法1使用一键启动脚本推荐
```bash
chmod +x start-fixed.sh
./start-fixed.sh
```
### 方法2手动分步启动
#### 1. 启动后端服务
```bash
cd backend
# 创建虚拟环境(首次运行)
python3 -m venv venv
source venv/bin/activate
# 安装依赖
pip install -r requirements.txt
# 启动服务
python app.py
```
#### 2. 启动前端服务(新终端)
```bash
cd frontend
# 安装依赖(首次运行)
npm install --legacy-peer-deps
# 启动开发服务器
npm run dev
```
## 🔧 故障排除
### 常见问题及解决方案
#### 1. 端口占用问题
如果端口被占用,可以修改端口:
```bash
# 后端端口
PORT=5001 python app.py
# 前端端口在frontend/vite.config.ts中修改
```
#### 2. Python依赖问题
```bash
# 如果安装失败尝试更新pip
python3 -m pip install --upgrade pip
# 重新安装依赖
pip install -r requirements.txt --force-reinstall
```
#### 3. Node.js依赖问题
```bash
# 清理node_modules和package-lock.json
rm -rf node_modules package-lock.json
# 重新安装
npm install --legacy-peer-deps
```
#### 4. 跨域问题
确保前端vite.config.ts中的代理配置正确
```typescript
proxy: {
'/api': {
target: 'http://localhost:5000',
changeOrigin: true,
}
}
```
## 📋 功能验证
启动后,请测试以下功能:
### ✅ 基础功能检查
- [ ] 访问 http://localhost:3000
- [ ] 左侧文件浏览器正常显示
- [ ] 中间编辑器可输入文本
- [ ] 右侧预览实时更新
### ✅ Markdown功能测试
- [ ] 输入 `# 标题` 查看标题渲染
- [ ] 输入 `**粗体**` 查看粗体显示
- [ ] 输入代码块 ```` ```python print("hello") ``` ````
- [ ] 输入数学公式 `$E = mc^2$`
### ✅ 文件操作测试
- [ ] 创建新文件(点击📄图标)
- [ ] 保存文件Ctrl+S
- [ ] 在文件浏览器中导航目录
### ✅ 正则表达式测试
- [ ] 按 Ctrl+Shift+F 打开正则工具
- [ ] 选择"Markdown标题"模式
- [ ] 点击测试查看匹配结果
## 🐛 调试信息
### 检查后端服务
```bash
curl http://localhost:5000/api/health
# 应返回 {"status":"healthy","service":"markdown-editor-api"}
```
### 检查文件系统
```bash
ls -la backend/workspace/
```
### 检查日志
- 后端日志:查看终端输出
- 前端日志:查看浏览器开发者工具
## 📱 浏览器支持
支持以下浏览器:
- Chrome 90+
- Firefox 88+
- Safari 14+
- Edge 90+
## 🎯 快捷键
| 快捷键 | 功能 |
|--------|------|
| Ctrl+N | 新建文件 |
| Ctrl+S | 保存文件 |
| Ctrl+Shift+F | 打开正则工具 |
| Ctrl+B | 粗体 |
| Ctrl+I | 斜体 |
| Ctrl+K | 插入链接 |
## 📞 技术支持
如果遇到问题,请:
1. 检查终端输出中的错误信息
2. 确认端口未被占用
3. 验证依赖是否正确安装
4. 查看浏览器开发者工具中的网络请求