ygqygq2/bookstack

BookStack 镜像文档

概述与主要用途

BookStack是一款基于Mindoc二次开发的知识管理系统，专为知识分享与文档运营设计。它专注于Markdown格式文档的管理，提供丰富的文档组织与分享功能，因数据表结构、字段及索引差异，不兼容原Mindoc系统。该系统适用于个人知识整理、企业内部文档管理、开源项目文档托管等场景，支持通过微信小程序BookChat（开源地址：Gitee [***] https://github.com/TruthHun/BookChat%EF%BC%89%E8%AE%BF%E9%97%AE%E3%80%82

核心功能与特性

书籍分类（V1.2+）

支持对书籍进行分类管理，帮助用户快速筛选所需内容。

用户主页（V1.2+）

展示用户分享的书籍、粉丝、关注及手册信息，增强用户间互动。

一键导入Markdown项目

仅管理员可用，支持导入各类Markdown项目，自动处理文档间链接及图片链接。

一键拉取Markdown项目

仅管理员可用，支持从GitHub、Gitee等平台拉取Markdown项目（通过URL拉取zip包或Git Clone），自动处理链接与图片，并可将图片更新至OSS。

生成与导出离线文档

支持生成并导出PDF、epub、mobi等格式离线文档，需安装配置calibre，系统已集成相关工具（源码：https://github.com/TruthHun/converter%EF%BC%89%E3%80%82

文档排序与批量创建

通过创建标识为summary.md的文档，使用特定格式的无序列表（需包含<bookstack-summary></bookstack-summary>标签），可批量创建文档并按指定结构排序。示例格式：

markdown
<bookstack-summary></bookstack-summary>
* [第0章. 前言]($ch0.md)
* [第1章. 修订记录]($ch1.md)
* [第2章. 如何贡献]($ch2.md)

文档间跳转

支持通过文档标识快速跳转，格式为[链接文本]($文档标识.md)，跳转到锚点使用[链接文本]($文档标识.md#锚点)。

采集功能

支持采集网页内容（含代码段、图片），通过编辑器中的瓢虫图标触发，自动保留格式。

SEO优化

支持在后台管理中定制SEO关键字，可手动更新站点sitemap。

版本控制

可在管理后台开启版本控制功能，文档历史版本以文件形式存储（本地或云存储），避免数据库膨胀。

美观布局与移动端兼容

提供简洁美观的页面设计（首页、介绍页、内容阅读页、个人项目页等），并优化移动端显示效果。

使用场景与适用范围

• 个人知识管理：整理学习笔记、技术文档，支持离线导出与多设备访问。
• 企业内部文档：用于团队协作、产品手册、技术文档的集中管理与分享。
• 开源项目文档：托管开源项目文档，支持从代码仓库拉取更新，方便开发者查阅。
• 内容运营平台：构建知识分享站点，支持用户互动与内容传播。

安装与使用方法

环境要求

• 操作系统：Ubuntu（官方提供Ubuntu安装教程，Windows暂未提供）
• 依赖：需安装calibre（用于离线文档生成）、Git等工具

安装步骤

1. 获取源码：

   bash
   # 从GitHub克隆
   git clone https://github.com/TruthHun/BookStack.git
   # 或从Gitee克隆
   git clone https://gitee.com/truthhun/BookStack.git
   

2. 修改配置文件：

   • 模板文件修改：/views/widgets/pdf_footer.html（PDF页脚内容）、/views/document/tpl_statement.html（自定义文案，需包含h1标签用于目录生成）。

3. 启动服务： 参考官方安装教程（[***]

Docker部署示例（参考）

docker-compose.yml示例：

yaml
version: '3'
services:
  bookstack:
    image: truthhun/bookstack:latest
    ports:
      - "80:80"
    volumes:
      - ./data:/app/data  # 数据持久化
      - ./config:/app/conf  # 配置文件挂载
    environment:
      - DB_HOST=mysql
      - DB_USER=bookstack
      - DB_PASSWORD=your_password
      - DB_NAME=bookstack
    depends_on:
      - mysql
  mysql:
    image: mysql:5.7
    environment:
      - MYSQL_ROOT_PASSWORD=root_password
      - MYSQL_DATABASE=bookstack
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=your_password
    volumes:
      - mysql_data:/var/lib/mysql

volumes:
  mysql_data:

初始访问

• 默认管理员账号：admin，密码：admin
• 登录后建议立即修改密码，并根据需求配置SEO、版本控制等功能。

开源与社区

• 源码托管：
  • GitHub：https://github.com/TruthHun/BookStack
  • Gitee：[***]
• QQ交流群：457803862（猿军团，***请备注“来自BookStack”）
• 正式站点：书栈网（[***]

更新与维护

• 程序更新日志：查看GitHub/Gitee的Release页面（/truthhun/BookStack/releases）
• 升级说明：v1.0升级至v1.1可直接下载发行版本，修改配置文件后覆盖升级（无数据库改动）