littlebot
Published on 2025-04-16 / 0 Visits
0

【源码】基于Node.js框架的Rbook在线阅读系统

项目简介

Rbook是基于Node.js框架构建的在线阅读系统,具备目录功能、文章列表展示、侧边栏导航等特性。该系统支持多种文件格式下载,还提供模板生成、评论功能(Gitalk)、D3文章关系展示等扩展功能,用户可借助此系统轻松发布和管理文章,实现内容的在线浏览与下载。

项目的主要特性和功能

  1. 目录功能:支持展示文章层次结构,便于用户快速导航。
  2. 文章列表:展示文章列表,支持按标签筛选文章。
  3. 侧边栏导航:提供灵活的侧边栏导航,支持自定义导航项。
  4. 文件下载:支持py、zip、txt等多种文件格式下载。
  5. 单页面渲染:支持单页面渲染,方便开发者预览页面效果。
  6. 模板生成:通过特定标记截取内容生成代码模板。
  7. 评论功能:集成Gitalk评论系统,支持在线评论。
  8. D3文章关系展示:通过D3生成文章间的力导图,展示文章关系。
  9. 额外Markdown语法:支持路径转URL、自定义语法等功能。
  10. Web Components:提供丰富的Web Components支持,便于扩展功能。

安装使用步骤

环境准备

确保已安装Node.js(版本 >= 10)、Git、Yarn和Redis。

复制项目

bash cd rbook git submodule init && git submodule update

安装依赖

bash yarn add cd markdown-r && yarn add

配置文件

根据需求编辑config.yaml文件,配置相关参数(如导航栏、Gitalk等)。

启动项目

使用pm2启动: bash yarn global add pm2 pm2 start tools/pm2.demo.yml

访问系统

启动后,访问浏览器中的项目地址,即可开始使用Rbook系统。

额外功能说明

  • 模板生成:在Markdown文件中使用<!-- template start --><!-- template end -->标记,系统会自动截取内容生成模板。
  • Gitalk评论:在config.yaml中配置Gitalk的相关信息(如clientID、clientSecret等),即可启用评论功能。
  • D3文章关系展示:通过在Markdown中定义pre_articlenext_article,系统会使用D3生成文章之间的力导图。

API说明

/utils/exists/<article-id>:判断指定文章是否存在。

注意事项

  • 确保Node.js版本符合要求(>= 10)。
  • 配置文件config.yaml中的参数需根据实际需求进行调整。
  • 使用pm2启动项目时,确保pm2已全局安装。

下载地址

点击下载 【提取码: 4003】【解压密码: www.makuang.net】