Releases: TruthHun/BookStack
BookStack v2.1 发布,常规升级
程序介绍
BookStack,分享知识,共享智慧!知识,因分享,传承久远!
BookStack 是基于 Mindoc、使用Go语言的Beego框架开发的功能类似GitBook和看云的在线文档管理系统,实现了文档采集、导入、电子书生成以及版本控制等强大的文档功能,并推出了配套的开源微信小程序 BookChat。
升级日志
- 解决 2.0 版本,初始化管理员失败(密码长度修改导致)的问题
- html转json实现,以兼容各种小程序和uni-app的富文本组件
rich-text
对内容的渲染 - markdown导入功能获取标题优化
- 内容采集持续优化,URL链接替换优化
- 支持隐藏收录入口
- 支持隐藏项目开源入口
- API接口用户注册接口,支持控制每小时和每天的用户注册数量,以避免恶意攻击
- 文档内容,SEO 标题支持获取文档的上一个文档的标题
-
puppeteer
采集优化 - 首页分类,增大块点击范围以优化体验
- 编译的时候版本变量注入
- 管理后台用户列表用户注册时间格式化
- 增加虚拟根目录
程序升级
本次升级,数据库表结构有新增和调整,不管还是升级或是新部署时,务必先执行如下命令升级数据库表
./BookStack install
默认管理员账号密码调整为:
admin
admin888
详细 安装部署文档
相关地址
BookStack 官网
BookStack 开源地址
- Gitee(码云)开源: https://gitee.com/truthhun/BookStack
- GitHub 开源: https://github.com/TruthHun/BookStack
BookStack 配套微信小程序 BookChat 开源地址
- Gitee(码云)开源:https://gitee.com/truthhun/BookChat
- GitHub 开源:https://github.com/truthhun/BookChat
BookStack 配套手机APP BookChatApp 开源地址
- Gitee(码云)开源:https://gitee.com/truthhun/BookChatApp
- GitHub 开源:https://github.com/truthhun/BookChatApp
配套微信小程序 BookChat 小程序码
BookStack v2.0 发布,大版本升级
程序介绍
BookStack,分享知识,共享智慧!知识,因分享,传承久远!
BookStack 是基于 Mindoc、使用Go语言的Beego框架开发的功能类似GitBook和看云的在线文档管理系统,实现了文档采集、导入、电子书生成以及版本控制等强大的文档功能,并推出了配套的开源微信小程序 BookChat。
升级日志
BookStack
配套微信小程序BookChat
接口实现,累计20+
个API接口- 修复删除项目时误删默认封面的bug
- HTML内容处理,以兼容微信小程序
rich-text
组件对HTML内容的渲染 - 增加开源书籍和文档收录提交入口,以及收录管理
- 内容采集增强和优化
- 书籍在发布的时候,自动把非站内图片自动采集下来
- 书籍页增加小程序码,提供小程序阅读入口,打通PC端与移动端一体化阅读浏览
- 增加评论审核与管理功能
- 横幅管理
- 支持
epub
导入(感谢 @wenfengand的PR) - 隐藏附件管理入口(因为不依赖于此管理附件)
- 管理后台增加根据用户名、昵称、邮箱和角色对用户进行检索和管理的功能
- 增加
作者
角色,用于控制普通用户创建项目权限,有效控制不良项目对网站资源的占用 - 增加微信小程序配置项(在
app.conf
文件中)
新增微信小程序配置项如下:
# 微信小程序 appid
appId=""
# 微信小程序appSecret
appSecret=""
# 是否限制API请求,也就是如果不是上述配置的微信小程序的appId请求的接口,则直接拒绝
limitReferer=false
# 是否显示小程序阅读码(需要配置了appScecret才会生效)
showWechatCode = false
# 比如你将static目录下的所有静态资源都放到了专门的服务器上,那么这个域名就行用来访问你的静态资源的域名。否则建议填写web网站的域名
# 如果您部署了微信小程序,则该值一定要填写
static_domain=
如果不喜欢现在 BookStack 的目录展现形式,可根据 @cnspray 在 Gitee issues 上的回复 进行修改
程序升级
本次升级,数据库表结构有新增和调整,部署时,务必先执行如下命令升级数据库表
./BookStack install
默认管理员账号密码调整为:
admin
admin888
详细 安装部署文档
相关地址
BookStack 官网
BookStack 开源地址
- Gitee(码云)开源: https://gitee.com/truthhun/BookStack
- GitHub 开源: https://github.com/TruthHun/BookStack
BookStack 配套微信小程序 BookChat 开源地址
- Gitee(码云)开源:https://gitee.com/truthhun/BookChat
- GitHub 开源:https://github.com/truthhun/BookChat
配套微信小程序 BookChat 小程序码
微信扫码体验一下,相信你一定会喜欢,并且想要给
BookChat
项目一个Star
BookStack v2.0 Beta 版本发布,实现BookChat微信小程序接口
BookChat
v2.0 微信小程序( https://gitee.com/truthhun/BookChat )已经发布了,需要配套 BookStack
v2.0 以上版本才能正常使用,目前BookStack
相关API已经开发完成,但是对API等的后台管理功能并未完善,快的话也需要大半个月时间这样,所以先放出Beta版本,以方便需要调试和对BookChat进行二次开发的朋友。
本次主要升级日志
-
BookStack
配套微信小程序BookChat
API接口实现,累计20+个API接口 - 修复删除项目时误删默认封面的bug
- HTML内容处理,以兼容微信小程序
rich-text
组件的内容渲染 - 增加内容收录提交入口
- 增加网站小程序码功能,打通PC端与移动端一体化阅读浏览
- 内容采集增强和优化
更多升级内容,请查看源码仓库 commit 记录
微信小程序BookChat
体验
BookStack v1.7 发布,功能增强
- 增加书籍和文档搜索精度控制(在管理后台可设置)
- 增加
钉子
功能,把想要置顶的书籍置顶在发现
列表页首位 - 文档阅读,移动端展开菜单优化(右下角增加展开菜单按钮)
- 跳转编辑指定文档
- 流程图、时序图、数学公式的支持和优化
- 移除外部引入的js、css公共资源库,实现本地化和内网部署的优化
- 文章
内容目录
显示优化 - 管理员删除书籍,需要输入管理员密码
- 增加书籍语种分类(中文、英文、其他)
- 增加首页最新推荐书籍内容
- 增加关联书籍推荐功能(需要启用elasticsearch)
- SEO 优化,如果文档内容图片缺少
alt
,自动使用文档标题填充 - 采集HTML的时候,block 里面的内容不转markdown
- 书籍分类统计不正确的问题
- 采集功能增强,自带截图功能。
- 更新MySQL驱动,支持MySQL 8.x
BookStack V1.6
- 使用
puppeteer
采集的支持(需要安装node以及在当前程序目录下安装node的puppeteer模块) - 根据邮箱找回密码
-
<bookstack-split></bookstack-split>
,文档拆分功能 - 文章二维码,扫一扫,手机阅读
- 文档采集功能优化
- 增加HTML标签排除功能:
<exclude></exclude>
,如要排除标签h5
以及class为hello
、id为"book"的HTML内容,写法是<exclude>h5,.hello,#book</exclude>
- 文档图片采集优化,支持svg等缩图图片格式和base64的图片采集
- 增加HTML标签排除功能:
- 增加全书指定字符替换功能
- 使用 elasticsearch 实现全文搜索(在
管理后台
->配置管理
进行设置)- 搜索功能,支持搜索书籍和全站文档
- elasticsearch 只返回搜索结果的id,不返回大量的数据
- 文章、搜索结果页关键字高亮
- elasticsearch分词
- 实时索引
- 删除文档,同时删除文档对应的索引
- 书籍公有和私有之间转换,同步更新索引中书籍的公有和私有状态
- 发布文档,实时更新对应的书籍对应文档的全量索引
- 更新书籍信息,同步更新书籍的索引
- 删除书籍,同步删除概述及的所有相关文档
- 管理后台控制默认搜索的是文档还是书籍
- 文档内的搜索,使用elasticsearch
- 在书籍编辑页面可以克隆或者是上传markdown
- 文章内容页顶部显示 作者、发布时间、更新时间、浏览量、分享人
- 新建和编辑项目,支持添加原作者和原作者链接
- 文档文章内容,顶部标题下显示信息
- 管理后台控制第三方登录的显示与隐藏
- HTML table 渲染问题优化(把
editormd.js
中的breaks
设置为false)
elasticsearch docker容器:
[sudo] docker pull truthhun/elasticsearch:6.2.4.ik
BookStack V1.5
V1.5 升级日志
- 修复:文档项目删除时间过长进而导致删除失败的Bug(启用了MySQL的事务,但事务中SQL语句有select子句查询造成的问题)
- 修复:项目成员列表显示不全的Bug(分页问题导致) #25
- 修复:文档项目标识正则匹配规则不正确的问题
- 优化:分类在筛选文档项目的时候,SEO优化,以文档分类作为
title
等,不再以首页的文案作为title
- 优化:一键采集文档项目,自动检测并下载图片
- 优化:恢复文档模板功能
- 优化:文档中,图片不再使用带http的URL绝对路径,以解决更换域名后写死的URL找不到图片的问题
- 新增:书籍推荐,在封面加上"推荐"图标标志。
- 新增:
Git Clone
的方式导入文档项目 - 优化:文档阅读体验优化
- 文档阅读页面左侧章节菜单,可展开和收起
- 键盘左右方向键按键切换文档上下章节
- 文档目录全部展开,所有章节一目了然
- 移除
jstree
插件(因为使用该插件,在用户网速比较慢的情况下左侧章节目录排版会出现错乱,影响体验) - 已阅读章节,
打勾
标识出来,以便知道哪些章节已读哪些章节未读 - 章节目录跟随阅读进度定位位置
- 新增:版本控制(在
管理后台
->配置管理
中开启)- 文档编辑历史,使用文件存储的方式进行记录,不存入数据库.
- 版本控制,在
<bookstack-git></bookstack-git>
标签内添加文案用以提交版本说明。如<bookstack-git>"first commit"</bookstack-git>
等同于git commit -m "first commit"
- 删除版本记录的时候要同时删除版本文件
- 删除文档项目时同时删除项目所有的相关文档章节版本记录
- 删除单个文档章节以及删除上一级文档章节,则被删除的文档章节的历史版本记录同样要删除
-
SUMMARY.md
功能扩展,输入<bookstack-auto></bookstack-auto>
,获取所有文档章节标识,获取所有文档章节标识
附:
版本升级赞助名单
BookStack V1.4
V1.4 升级日志
- 修复:由于js使用严格模式(
use strict
),导致文档目录收起之后无法展开 - 修复:采集内容,URL链接和图片链接补全不正确
- 优化:书籍离线文档生成加锁优化,移除
app.conf
中的GenerateInterval
配置项 - 优化:PDF、epub和mobi等电子书生成工具 Converter,在生成电子书时,自动生成封面。
- 优化:
<bookstack-summary>
标签的一键排序和批量创建文档的功能。 - 移除:生成PDF的时候,移除HTML中的Markdown TOC。
- 新增:提供
Dockerfile
,让部署程序更快更简单。在下载BookStack
程序的时候,请下载Docker版,压缩包内含有Dockerfile
文件。 - 新增:爬虫一键采集功能,采集整理书籍,一步到位!
本次更新,新增了数据表初始数据,旧版本用户,直接执行./BookStack install
操作,对数据库表进行升级(不会影响原有表数据和结构)。
BookStack V1.3.1
建议1.3
版本的用户升级到1.3.1
版本
- 解决由于js使用了‘严格模式(use strict)’导致的文档目录收起之后展不开的问题 [#IJZXU]
BookStack V1.3
本次更新,新增了数据表,旧版本用户,直接执行./BookStack install
操作,对数据库表进行升级(不会影响原有表数据和结构)。
升级日志
- 新增:用户阅读记录和阅读进度
- 新增:阅读书签功能,以便读者标记阅读位置
- 新增:书籍详情页和文档内容页增加分享功能(由于百度分享等现有分享代码不支持
https
,所以使用本地化百度分享源码解决方案 https://github.com/hrwhisper/baiduShare ) - 新增:使用KaTeX( https://github.com/Khan/KaTeX ),扩展对数学公式的支持
- 优化:更新HTML转markdown工具html2md,强化转化效果
- 修复:文档内URL链接大小写问题优化 issue#20
- 修复:友链唯一索引问题(默认的字段varchar类型长度(255)过长,导致部分MySQL数据库无法生成唯一索引)
- 修复:文档内容更新了,执行发布文档操作的时候,文档更新部分的内容仍然不显示的问题
BookStack V1.2
- 修复图片存储路径不正确的问题
- 正确输入文档项目标识和登录密码才能删除文档项目,以避免误删操作
- 增加移动端搜索入口
- 扩展采集功能,增加
DIY模式
,以采集提取页面的指定内容 - 增加文档分类功能(工作量最大的一项,还新增了分类数据表。用户都不知道自己需要什么,但是却知道自己不需要什么,所以必须要有个分类来引导用户查找自己需要的资料;前端隐藏暂时没有书籍的分类)
- sitemap的
changefreq
,调整为weekly
- 项目名称,SEO时,默认加上书名号
- 用户个人主页、收藏、关注、粉丝等
- 友链管理