开源！搭配 VitePress 使用的 Markdown 回顾系统

项目地址

https://github.com/muzig/markdown-review-web

引言

Markdown 回顾系统是一个定制的工具，旨在帮助用户通过基于艾宾浩斯记忆曲线的定期复习来保留 Markdown 文档中的重要知识点。该系统的设计结合了文档管理和间隔重复学习法，旨在优化学习效率。以下是系统的详细功能、安装步骤、使用说明以及相关背景信息。

系统功能与特点

Markdown 回顾系统提供了一系列功能，以支持高效的文档管理和复习计划：

• 自动扫描与索引：系统会自动扫描项目根目录下的docs目录，索引所有 Markdown 文件，便于组织和管理。
• 文件夹结构浏览：文档按文件夹结构显示，支持点击文件夹图标进入子目录，或使用向上箭头和面包屑导航返回上级目录。
• 基于艾宾浩斯记忆曲线的复习计划：系统根据记忆曲线安排复习时间，具体间隔如下：

• 搜索与排序：支持通过关键词搜索文档标题、文件名和路径，并提供按名称、修改日期、复习次数等多种排序方式。
• 用户体验优化：包括暗黑模式保护眼睛，支持 Markdown 语法高亮显示。
• 个性化功能：用户可以为文档添加笔记，标记收藏，系统会跟踪每个文档的复习次数和下次复习日期。

安装与运行

要使用 Markdown 回顾系统，用户需要确保已安装 Node.js （推荐版本 v14 或更高）。安装步骤如下：

1. 安装依赖：运行命令npm install

2. 配置环境变量：复制.env.example文件为.env并根据需要修改配置

   # 服务器端口
   PORT=3030
   
   # Markdown 文档目录（相对于项目根目录）
   MARKDOWN_DIR=../docs
   

3. 启动应用：运行npm start

4. 在浏览器中访问：http://localhost:3030

应用启动后，会自动扫描配置的 Markdown 目录中的文件。用户可以通过左侧边栏的搜索框查找文档，或在浏览区域按文件夹结构查看。点击文档名称可查看内容，文档头部显示元数据如修改日期和复习次数。用户可点击"标记为已复习"按钮安排下次复习，或使用"重新扫描"按钮更新索引。