# markdown-manage

**Repository Path**: pretend-work/markdown-manage

## Basic Information

- **Project Name**: markdown-manage
- **Description**: 这是一个基于Flask开发的Markdown知识库应用，支持Markdown文件的上传、查看、编辑和管理，并提供标签功能方便分类整理。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-11-06
- **Last Updated**: 2025-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown知识库应用

这是一个基于Flask开发的Markdown知识库应用，支持Markdown文件的上传、查看、编辑和管理，并提供标签功能方便分类整理。

## 功能特点

- **Markdown文件管理**：上传、查看、编辑和删除Markdown文件
- **标签系统**：为Markdown文件添加标签，支持按标签筛选和管理
- **语法高亮**：支持Markdown内容的语法高亮显示
- **响应式设计**：适配不同屏幕尺寸的设备
- **Docker部署**：支持使用Docker快速部署

## 技术栈

- **后端**：Python 3.9, Flask, SQLAlchemy
- **数据库**：SQLite
- **前端**：HTML, CSS, JavaScript, Bootstrap
- **容器化**：Docker, Docker Compose

## 快速开始

### 使用Docker部署

1. 确保已安装Docker和Docker Compose

2. 克隆项目代码

```bash
git clone <repository-url>
cd markdown-manage
```

3. 启动应用

```bash
docker-compose up -d --build
```

4. 访问应用

打开浏览器，访问 http://localhost:8080

### 本地开发

1. 创建虚拟环境

```bash
python -m venv venv
```

2. 激活虚拟环境

Windows:
```bash
venv\Scripts\activate
```

Linux/Mac:
```bash
source venv/bin/activate
```

3. 安装依赖

```bash
pip install -r requirements.txt
```

4. 创建环境变量文件

复制`.env.example`为`.env`，并根据需要修改配置

5. 启动应用

```bash
python run.py
```

## 项目结构

```
markdown-manage/
├── app/                  # 应用主目录
│   ├── templates/        # HTML模板文件
│   ├── uploads/          # 上传的Markdown文件存储目录
│   ├── __init__.py       # 应用初始化
│   ├── forms.py          # 表单定义
│   ├── models.py         # 数据模型
│   └── routes.py         # 路由定义
├── instance/             # 实例相关文件（如SQLite数据库）
├── .env                  # 环境变量配置
├── Dockerfile            # Docker构建文件
├── docker-compose.yml    # Docker Compose配置
├── requirements.txt      # Python依赖列表
└── run.py                # 应用入口文件
```

## 使用说明

### 上传Markdown文件

1. 点击导航栏的"上传文件"按钮
2. 选择本地的Markdown文件
3. 点击"上传"按钮
4. 可选：为文件添加标签

### 查看文件

1. 在首页点击文件名即可查看文件内容
2. 文件内容会以Markdown格式渲染显示

### 编辑文件

1. 查看文件时，点击"编辑"按钮
2. 在编辑器中修改内容
3. 点击"保存"按钮提交更改

### 标签管理

1. 点击导航栏的"标签"按钮查看所有标签
2. 点击标签名称可以筛选带有该标签的文件
3. 在上传或编辑文件时可以添加或删除标签

## Docker相关命令

### 启动应用

```bash
docker-compose up -d
```

### 停止应用

```bash
docker-compose down
```

### 查看日志

```bash
docker-compose logs -f
```

### 检查容器状态

```bash
docker-compose ps
```

## 环境变量配置

主要环境变量：

- `FLASK_ENV`: 运行环境（development/production）
- `FLASK_RUN_PORT`: 运行端口
- `FLASK_RUN_HOST`: 运行主机
- `DATABASE_URL`: 数据库连接URL

## 注意事项

- 上传的文件大小有限制
- 支持的文件格式为.md
- 数据库文件存储在instance目录下

## License

MIT License