|
@@ -12,19 +12,32 @@ CJYDocs 是一个基于 Node.js + Express 的轻量级 Markdown 文档管理和
|
|
|
|
|
|
|
|
## 开发命令
|
|
## 开发命令
|
|
|
|
|
|
|
|
-### 启动服务器
|
|
|
|
|
|
|
+### 本地开发
|
|
|
```bash
|
|
```bash
|
|
|
|
|
+npm install # 安装依赖
|
|
|
npm start # 生产模式启动
|
|
npm start # 生产模式启动
|
|
|
npm run dev # 开发模式启动(使用 nodemon 自动重启)
|
|
npm run dev # 开发模式启动(使用 nodemon 自动重启)
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
服务器默认运行在 `http://localhost:3000`
|
|
服务器默认运行在 `http://localhost:3000`
|
|
|
|
|
|
|
|
-### 安装依赖
|
|
|
|
|
|
|
+### Docker 部署
|
|
|
```bash
|
|
```bash
|
|
|
-npm install
|
|
|
|
|
|
|
+# 构建镜像
|
|
|
|
|
+docker build -t cjydocs:latest .
|
|
|
|
|
+
|
|
|
|
|
+# 运行容器(必须挂载 docs 和 index.md)
|
|
|
|
|
+docker run -d \
|
|
|
|
|
+ --name cjydocs \
|
|
|
|
|
+ -p 3000:3000 \
|
|
|
|
|
+ -v $(pwd)/docs:/app/docs \
|
|
|
|
|
+ -v $(pwd)/index.md:/app/index.md \
|
|
|
|
|
+ --restart unless-stopped \
|
|
|
|
|
+ cjydocs:latest
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
|
|
+**重要**: Docker 镜像不包含文档数据,必须挂载 `docs/` 和 `index.md`,否则容器无法正常工作。
|
|
|
|
|
+
|
|
|
## 核心架构
|
|
## 核心架构
|
|
|
|
|
|
|
|
### 三层架构
|
|
### 三层架构
|
|
@@ -180,16 +193,20 @@ cjydocs/
|
|
|
├── docs/
|
|
├── docs/
|
|
|
│ └── 分类名/
|
|
│ └── 分类名/
|
|
|
│ └── 文档.md # 实际文档内容(可通过在线编辑修改)
|
|
│ └── 文档.md # 实际文档内容(可通过在线编辑修改)
|
|
|
-└── public/
|
|
|
|
|
- ├── index.html # 首页(显示分类列表)35行
|
|
|
|
|
- ├── reader.html # 阅读器页面(三栏布局+编辑器)129行
|
|
|
|
|
- ├── css/style.css # 统一样式
|
|
|
|
|
- └── js/
|
|
|
|
|
- ├── index.js # 首页逻辑(70行)
|
|
|
|
|
- └── reader.js # 阅读器核心逻辑(1113行)
|
|
|
|
|
- # - DOM缓存、事件委托
|
|
|
|
|
- # - 搜索、TOC、侧边栏交互
|
|
|
|
|
- # - 在线编辑器(智能光标定位)
|
|
|
|
|
|
|
+├── public/
|
|
|
|
|
+│ ├── index.html # 首页(显示分类列表)35行
|
|
|
|
|
+│ ├── reader.html # 阅读器页面(三栏布局+编辑器)129行
|
|
|
|
|
+│ ├── css/style.css # 统一样式
|
|
|
|
|
+│ └── js/
|
|
|
|
|
+│ ├── index.js # 首页逻辑(70行)
|
|
|
|
|
+│ └── reader.js # 阅读器核心逻辑(1113行)
|
|
|
|
|
+│ # - DOM缓存、事件委托
|
|
|
|
|
+│ # - 搜索、TOC、侧边栏交互
|
|
|
|
|
+│ # - 在线编辑器(智能光标定位)
|
|
|
|
|
+├── Dockerfile # Docker 镜像构建文件
|
|
|
|
|
+├── DOCKER.md # Docker 部署详细文档
|
|
|
|
|
+├── CLAUDE.md # Claude Code 项目指南
|
|
|
|
|
+└── README.md # 项目说明文档
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
## 代码修改指南
|
|
## 代码修改指南
|