管理系统系列--BookStack，基于MinDoc，使用Beego开发的在线文档管理系统，功能类似Gitbook和.zip

**BookStack 配套手机APP `BookChatApp` 开源地址** - Gitee: https://gitee.com/truthhun/BookChatApp - GitHub: https://github.com/TruthHun/BookChatApp **BookChatApp下载体验地址** - https://www.bookstack.cn/app 目录： - [BookStack简介](#intro) - [开源](#open) - [QQ交流群](#qqgroup) - [站点](#site) - [演示站点](#demo) - [正式站点](#normal) - [更新、维护和升级](#upgrade) - [功能与亮点](#func) - [书籍分类](#cate) - [用户主页](#homepage) - [一键导入markdown书籍](#import) - [一键拉取markdown书籍](#pull) - [生成和导出PDF、epub、mobi等离线文档](#generate) - [文档排序和批量创建文档](#sort) - [文档间的跳转](#redirect) - [采集功能](#crawl) - [SEO](#seo) - [赞助二维码](#qrcode) - [更美观、简洁的页面布局和更为完善的移动端兼容](#beauty) - [TODO](#todo) - [安装与使用](#install) - [关于本人](#aboutme) - [赞助我](#support) <a name="intro"></a> # BookStack 简介 BookStack，分享知识，共享智慧！知识，因分享，传承久远！ BookStack是基于[Mindoc](https://github.com/lifei6671/mindoc)开发的，为运营而生。 在开发的过程中，增加和移除了一些东西，目前已经不兼容MinDoc了（毕竟数据表结构、字段、索引都有了一些不同），同时只支持markdown编辑器。 <a name="open"></a> ## 开源 两年前还在做PHP开发的时候，无意间遇到了Gitbook，以及看云，还有readthedoc。 当时想着自己也开发一套，但是后来没时间，当时也没那个技术积累。 后来学了Go语言，又在无意间遇到了[Mindoc](https://github.com/lifei6671/mindoc)，然后我们公司([掘金量化](https://www.myquant.cn) )也恰巧让我开发公司官网和文档系统，然后我就对[Mindoc](https://github.com/lifei6671/mindoc)做了二次开发。 本来是不想开源的，因为自己写代码的时候，写着写着，代码改来改去，然后代码就乱七八糟了，怕开源出来丢人现眼。但是踏入IT行业三年多时间以来，自身也受益于各种开源书籍和开源组件，所以最终还是决定将BookStack开源出来。 其中肯定还是有不足的地方，大家在使用的过程中，遇到问题，欢迎反馈。 源码托管： - Github: https://github.com/TruthHun/BookStack - Gitee: https://gitee.com/truthhun/BookStack <a name="qqgroup"></a> ## QQ交流群 为方便相互学习和交流，建了个QQ群，加群请备注`来自BookStack` > QQ交流群：457803862(猿军团) 同时要说明的是，该群是一个学习交流群，如果是程序相关问题，请直接提交issues，不接受邮件求助、微信求助和QQ私信求助 BookStack 安装使用手册：[https://www.bookstack.cn/books/help](https://www.bookstack.cn/books/help) <a name="site"></a> ## 站点 <a name="demo"></a> ### 演示站点 > 服务器资源有限，不再提供演示站点 <a name="normal"></a> ### 正式站点 **书栈网**：[https://www.bookstack.cn](https://www.bookstack.cn) <a name="upgrade"></a> ## 更新、维护和升级 - 程序下载与升级日志，看这里--> [Release](/truthhun/BookStack/releases) <a name="func"></a> ## 功能与亮点 <a name="cate"></a> ### 书籍分类(V1.2 +) 用户就像你的老板，他不知道自己需要什么，但是他知道自己不需要什么... <a name="homepage"></a> ### 用户主页(V1.2 +) 在用户主页，展示用户分享的书籍、粉丝、关注和手册，增加用户间的互动 <a name="import"></a> ### 一键导入markdown书籍 这个功能，相信是很多人的最爱了。目前这个功能仅对管理员开放。 > 经实测，目前已完美支持各种姿势写作的markdown书籍的文档导入，能很好地处理文档间的链接以及文档中的图片链接  <a name="pull"></a> ### 一键拉取markdown书籍 看到GitHub、Gitee等有很多开源文档的书籍，但是一个一个去拷贝粘贴里面的markdown内容不现实。于是，做了这个一键拉取的功能。 目前只有管理员才有权限拉取，并没有对普通用户开放。要体验这个功能，请用管理员账号登录演示站点体验。 用法很简单，比如我们拉取beego的书籍，在创建书籍后，直接点击"拉取书籍"，粘贴如" https://github.com/beego/beedoc/archive/master.zip "，然后就会自动帮你拉取上面的所有markdown文档并录入数据库，同时图片也会自动帮你更新到OSS。  > 经实测，目前已完美支持各种姿势写作的markdown书籍的拉取，能很好地处理文档间的链接以及文档中的图片链接 > 目前已支持Git Clone导入书籍 <a name="generate"></a> ### 生成和导出PDF、epub、mobi等离线文档 这个需要安装和配置calibre。 我将calibre的使用专门封装成了一个工具，并编译成了二进制，源码、程序和使用说地址：[https://github.com/TruthHun/converter](https://github.com/TruthHun/converter) 在BookStack中，已经引入这个包了。使用的时候，点击"生成下载文档"即可 <a name="sort"></a> ### 文档排序和批量创建文档 很多时候，我们在写作书籍的时候，会习惯地先把书籍的章节目录结构创建出来，然后再慢慢写内容。 但是，书籍中的文档少的时候，一个个去创建倒没什么，但是文档数量多了之后，简直就是虐待自己，排序的时候还要一个一个去拖拽进行排序，很麻烦。现在，这个问题已经解决了。如下： - 在书籍中，创建一个文档标识为`summary.md`的文档(大小写不敏感) - 在文档中，填充无序列表的markdown内容，如： ```markdown <bookstack-summary></bookstack-summary> * [第0章. 前言]($ch0.md) * [第1章. 修订记录]($ch1.md) * [第2章. 如何贡献]($ch2.md) * [第3章. Docker 简介]($ch3.md) * [什么是 Docker]($ch3.1.md) * [为什么要用 Docker]($ch3.2.md) * [第4章. 基本概念]($ch4.md) * [镜像]($ch4.1.md) * [容器]($ch4.2.md) * [仓库]($ch4.3.md) ``` - 然后保存。保存成功之后，程序会帮你创建如"第0章. 前言"，并把文档标识设置为"ch0.md"，同时目录结构还按照你的这个来调整和排序。 注意： > 必须要有`<bookstack-summary></bookstack-summary>`，这样是为了告诉程序，我这个`summary.md`的文档，是用来创建文档和对文档进行排序的。当然，排序完成之后，当前页面会刷新一遍，并且把`<bookstack-summary></bookstack-summary>`移除了。有时候，第一次排序并没有排序成功，再添加一次这个标签，程序会自动帮你再排序一次。 > 我自己也常用这种方式批量创建文档以及批量修改文档的标题 <a name="redirect"></a> ### 文档间的跳转 你在一个书籍中会有很多文档，其中一个文档的文档标识叫`readme.md`,另外一个文档的文档标识叫`quickstart.md`，两个文档间如何跳转呢？ 如果你知道站点的路由规则，倒是可以轻松链过去，但是，每次都要这样写，真的很麻烦。自己也经常写文档，简直受够了，然后想到了一个办法。如下： 我从`readme.md`跳转到`quickstart.md`，在`readme.md`中的内容这样写: ``` [快速开始]($quickstart.md) ``` 如果跳转到`quickstart.md`的某个锚点呢？那就像下面这样写： ``` [快速开始-步骤三]($quickstart.md#step3) ``` 好了，在发布文档的时候，文档就会根据路由规则以及你的文档标识去生成链接了(由于是后端去处理，所以在编辑文档的时候，前端展示的预览内容，暂时是无法跳转的)。 那么，问题就来了，我书籍里面的文档越来越多，我怎么知道我要链接的那个文档的文档标识呢？不用担心�