# knowledge-app

**Repository Path**: zwssd1980/knowledge-app

## Basic Information

- **Project Name**: knowledge-app
- **Description**: 开源的个人知识库系统。sqlite3数据库
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-07
- **Last Updated**: 2025-11-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 知识库管理系统

一个基于 Nuxt.js 的现代化知识库管理系统，支持 Markdown 编辑、笔记管理、实时预览等功能。

## 功能特性

- 📝 **Markdown 编辑器**：支持实时预览和语法高亮
- 🌳 **树形笔记结构**：支持父子笔记层级管理
- 🔍 **搜索功能**：快速搜索笔记内容
- 📱 **响应式设计**：支持桌面端和移动端
- 🎨 **现代化 UI**：使用 Font Awesome 图标和优雅的界面设计
- ⚡ **侧边栏折叠**：可折叠的侧边栏提升编辑体验
- 🖱️ **快捷操作**：编辑和返回按钮，子笔记点击打开
- 🔧 **PM2 支持**：生产级进程管理

## 技术栈

- **前端框架**：Nuxt.js 4 + Vue 3
- **样式**：TailwindCSS + 自定义 CSS
- **图标**：Font Awesome
- **Markdown**：marked + highlight.js
- **数据库**：SQLite
- **进程管理**：PM2

## 安装依赖

```bash
npm install
```

## 开发环境

### 本地开发服务器

```bash
npm run dev
```

访问：`http://localhost:3000`

### PM2 开发环境

```bash
npm run pm2:dev
```

访问：`http://localhost:8083`

## 生产部署

### 本地构建预览

```bash
# 构建项目
npm run build

# 预览生产版本
npm run preview
```

### PM2 生产部署

```bash
# 一键部署（包含构建）
npm run pm2:prod
```

访问：`http://localhost:8083`

## PM2 管理命令

### 基本操作

```bash
# 启动开发环境
npm run pm2:dev

# 启动生产环境
npm run pm2:prod

# 重启应用
npm run pm2:restart

# 停止应用
npm run pm2:stop

# 删除应用
npm run pm2:delete
```

### 监控和日志

```bash
# 查看实时日志
npm run pm2:logs

# 打开监控面板
npm run pm2:monit

# 查看应用状态
pm2 status

# 查看详细信息
pm2 show knowledge-app
```

## 配置文件

- **`ecosystem.config.js`**：开发环境 PM2 配置
- **`pm2.config.js`**：生产环境 PM2 配置
- **`logs/`**：PM2 日志文件目录

### 环境变量

- **端口**：8083
- **主机**：0.0.0.0（支持外网访问）
- **内存限制**：1GB（超过自动重启）
- **自动重启**：应用崩溃时自动重启

## 项目结构

```
knowledge-app/
├── components/          # Vue 组件
│   ├── EditorNote.vue   # 编辑器组件
│   ├── NoteDetail.vue   # 笔记详情组件
│   ├── NoteTree.vue     # 笔记树组件
│   └── NotesList.vue    # 笔记列表组件
├── server/              # 服务端 API
├── assets/              # 静态资源
├── pages/               # 页面组件
├── ecosystem.config.js  # PM2 开发配置
├── pm2.config.js        # PM2 生产配置
└── logs/                # 日志文件
```

## 使用指南

### 基本操作

1. **创建笔记**：点击"新增笔记"按钮
2. **编辑笔记**：在编辑器中使用 Markdown 语法
3. **实时预览**：开启"编辑 + 预览"模式
4. **搜索笔记**：在搜索框中输入关键词
5. **管理层级**：使用树形结构管理父子笔记

### Markdown 支持

- **标题**：`# H1` 到 `###### H6`
- **强调**：`**粗体**` 和 `*斜体*`
- **代码**：`` `行内代码` `` 和 ```代码块```
- **链接**：`[文本](url)`
- **图片**：`![alt](url)`
- **列表**：`- 项目` 和 `1. 项目`
- **表格**：`| 列1 | 列2 |`
- **任务列表**：`- [x] 已完成`

### 快捷工具栏

编辑器提供以下快捷按钮：
- 加粗、斜体、行内代码
- 代码块、链接、图片
- 无序列表、有序列表
- 引用、标题

## 部署注意事项

1. **端口配置**：确保 8083 端口未被占用
2. **防火墙设置**：开放 8083 端口（如需外网访问）
3. **权限设置**：确保应用有读写数据库和日志的权限
4. **内存监控**：使用 `pm2 monit` 监控内存使用情况

## 故障排除

### 常见问题

1. **端口被占用**：
   ```bash
   # 查看端口占用
   netstat -tulpn | grep 8083
   # 或修改配置文件中的端口
   ```

2. **应用无法启动**：
   ```bash
   # 查看详细日志
   npm run pm2:logs
   # 重启应用
   npm run pm2:restart
   ```

3. **内存过高**：
   ```bash
   # 监控内存使用
   pm2 monit
   # 应用会自动在超过 1GB 时重启
   ```

## 许可证

MIT License