# MerinDocs

**Repository Path**: tinsur/MerinDocs

## Basic Information

- **Project Name**: MerinDocs
- **Description**: 基于Vue3使用Markdown文档的简单易用的知识库文档系统
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2026-08-12
- **Last Updated**: 2026-08-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 文档系统, MerinDocs, 数字花园, Vue, JavaScript

## README


# 📚 MerinDocs

一个轻量、开箱即用的 **Markdown 文档站系统**：把本地 `note/` 文件夹里的 Markdown 笔记变成带分类导航、目录大纲、代码高亮、全文搜索、深色模式的在线文档站。

前端 Vue 3 + Vite，后端 Node.js + Express，生产环境**单端口部署**，五分钟即可上线。

**部署及软件各自扩展功能请移步至项目文档查看。**

项目文档：https://merin.tinsur.cn

项目主页：https://www.tinsur.cn/merindocs

---

## 特性

- 📝 **纯 Markdown 驱动**：无需数据库，把 `.md` 文件丢进 `note/` 就是一篇文档
- 🗂️ **分类导航侧边栏**：按文件夹自动生成目录树，当前文档高亮，支持折叠 / 展开
- 🔍 **全文搜索**：侧边栏搜索框检索全部笔记，标题命中优先，支持多关键词
- 🎨 **代码高亮 + 一键复制**：highlight.js 预渲染常见语言，代码块带语言标识、行号、一键复制
- 📑 **目录大纲（TOC）**：正文右侧按标题层级生成树，可展开 / 收起，滚动自动定位当前章节
- 🖼️ **图片灯箱**：点击正文图片放大，滚轮缩放，Esc / 点击空白关闭
- 🌙 **深色 / 浅色模式**：一键切换，记忆选择，首次访问跟随系统偏好
- ⚙️ **站点配置**：标题 / 导航按钮 / 页脚备案等一个 JSON 文件搞定，改完刷新即生效，无需重新构建
- 🌐 **SPA 单端口部署**：后端直接托管前端构建产物，一个端口搞定页面 / 接口 / 图片，五分钟上线

---

## 更新日志

### 1.1.0

【新增】

1. 浅色和深色模式切换
2. 对于横屏设备导航栏新增支持收缩和拖拽调整大小，移动端保持原有导航样式
3. 点击外链式文档时进行弹窗外链提醒
4. 新增支持文章目录展开和收起，默认一二三级展开，其他收起
5. 新增消息提示框
6. 新增支持多级目录，最多嵌套三层
7. 新增支持复制提醒标注来源
8. 搜索增强，支持搜索条目高亮

【修复】

1. 首页切换其他页面时显示异常
2. 修复移动端文档页自适应异常
3. 修复按住鼠标左键拖动外链偶现页面卡死的BUG

【优化】

1. 优化导航栏展开的动画效果
2. 优化文章目录的展示效果
3. 优化代码块展示效果
4. 优化页面的加载效果
5. 优化默认状态下的视觉效果
6. 优化进度条的展示效果
7. 取消扁平化布局，增加页面质感
8. 优化页脚显示效果
9. 优化页面之间的切换逻辑，提升切换页面的体验感
10. 使用文档缓存，大幅提升加载速度
11. 优化布局显示
12. 优化主色调

### 1.0.0-Alpha

初代预览版

---

## 技术栈

| 层 | 技术 |
| --- | --- |
| 前端 | Vue 3 · Vite · Vue Router · Axios |
| 后端 | Node.js · Express |
| Markdown | markdown-it（图片路径重写、标题 TOC、加粗兼容处理） |
| 代码高亮 | highlight.js（后端预渲染） |

---

## 目录结构

```
merin-docs/
├── note/                     # ⚠️ 笔记数据源（Markdown + 图片）
│   ├── README.md             # 站点首页内容
│   ├── 分类A/
│   ├── 分类B/
│   └── assets/               # 笔记用到的图片
├── server/                   # Node.js 后端（Express）
│   ├── site.config.json      # ⚙️ 站点自定义配置（标题 / 导航按钮 / 页脚备案）
│   └── src/
│       ├── index.js          # 入口：API + 托管前端 + SPA 回退
│       ├── config.js         # 端口 / 笔记路径 / 分类排序
│       ├── routes/doc.js     # /api/tree · /api/doc · /api/home · /api/search · /api/site-config · /api/refresh
│       └── services/         # 目录扫描 + Markdown 解析 + 搜索 + 站点配置
├── web/                      # Vue 3 前端
│   ├── src/
│   │   ├── components/       # 顶栏 / 侧边栏 / 内容区 / 目录 / 主题 / 通知
│   │   ├── views/            # 首页 / 文档页 / 404
│   │   └── styles/           # 全局样式 + Markdown 排版
│   └── vite.config.js        # ⚙️ 开发端口与代理
├── ecosystem.config.js       # ⚙️ pm2 生产守护配置
├── package.json              # 根脚本入口
└── deploy.md                 # 宝塔 + 域名 + 笔记自动同步完整部署教程
```

---

## License

本项目采用 [GPL-3.0](LICENSE) 协议开源：你可以自由使用、修改、分发，但基于本项目的衍生作品必须同样以 GPL-3.0 开源。