Skip to content

Commit 0e0f7da

Browse files
committed
文案修改
1 parent f6af5ed commit 0e0f7da

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+363
-361
lines changed

API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ BookStack 配套微信小程序 BookChat API。
4343
## 本次主要升级日志
4444

4545
- [x] `BookStack` 配套微信小程序 `BookChat` API接口实现,累计20+个API接口
46-
- [x] 修复删除项目时误删默认封面的bug
46+
- [x] 修复删除书籍时误删默认封面的bug
4747
- [x] HTML内容处理,以兼容微信小程序`rich-text`组件实现微信小程序文档内容渲染
4848
- [ ] 开源书籍和文档收录提交入口以及收录管理
4949
- [x] 增加网站小程序码功能,打通PC端与移动端一体化阅读浏览
@@ -54,7 +54,7 @@ BookStack 配套微信小程序 BookChat API。
5454
- [x] 支持 `epub` 导入
5555
- [x] 隐藏附件管理入口(因为不依赖于此管理附件)
5656
- [x] 管理后台可根据用户名、昵称、邮箱和角色对用户进行检索和管理
57-
- [x] 增加`作者`角色,用于控制普通用户创建项目权限
57+
- [x] 增加`作者`角色,用于控制普通用户创建书籍权限
5858

5959
> 更多升级内容,请查看源码仓库 commit 记录
6060

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
- [功能与亮点](#func)
2020
- [书籍分类](#cate)
2121
- [用户主页](#homepage)
22-
- [一键导入markdown项目](#import)
23-
- [一键拉取markdown项目](#pull)
22+
- [一键导入markdown书籍](#import)
23+
- [一键拉取markdown书籍](#pull)
2424
- [生成和导出PDF、epub、mobi等离线文档](#generate)
2525
- [文档排序和批量创建文档](#sort)
2626
- [文档间的跳转](#redirect)
@@ -52,7 +52,7 @@ BookStack是基于[Mindoc](https://github.com/lifei6671/mindoc)开发的,为
5252

5353
后来学了Go语言,又在无意间遇到了[Mindoc](https://github.com/lifei6671/mindoc),然后我们公司([掘金量化](https://www.myquant.cn) )也恰巧让我开发公司官网和文档系统,然后我就对[Mindoc](https://github.com/lifei6671/mindoc)做了二次开发。
5454

55-
本来是不想开源的,因为自己写代码的时候,写着写着,代码改来改去,然后代码就乱七八糟了,怕开源出来丢人现眼。但是踏入IT行业三年多时间以来,自身也受益于各种开源项目和开源组件,所以最终还是决定将BookStack开源出来。
55+
本来是不想开源的,因为自己写代码的时候,写着写着,代码改来改去,然后代码就乱七八糟了,怕开源出来丢人现眼。但是踏入IT行业三年多时间以来,自身也受益于各种开源书籍和开源组件,所以最终还是决定将BookStack开源出来。
5656

5757
其中肯定还是有不足的地方,大家在使用的过程中,遇到问题,欢迎反馈。
5858

@@ -103,21 +103,21 @@ BookStack 安装使用手册:[https://www.bookstack.cn/books/help](https://www
103103
在用户主页,展示用户分享的书籍、粉丝、关注和手册,增加用户间的互动
104104

105105
<a name="import"></a>
106-
### 一键导入markdown项目
106+
### 一键导入markdown书籍
107107
这个功能,相信是很多人的最爱了。目前这个功能仅对管理员开放。
108-
> 经实测,目前已完美支持各种姿势写作的markdown项目的文档导入,能很好地处理文档间的链接以及文档中的图片链接
108+
> 经实测,目前已完美支持各种姿势写作的markdown书籍的文档导入,能很好地处理文档间的链接以及文档中的图片链接
109109
110-
![一键导入项目](static/openstatic/import.png)
110+
![一键导入书籍](static/openstatic/import.png)
111111

112112
<a name="pull"></a>
113-
### 一键拉取markdown项目
114-
看到GitHub、Gitee等有很多开源文档的项目,但是一个一个去拷贝粘贴里面的markdown内容不现实。于是,做了这个一键拉取的功能。
113+
### 一键拉取markdown书籍
114+
看到GitHub、Gitee等有很多开源文档的书籍,但是一个一个去拷贝粘贴里面的markdown内容不现实。于是,做了这个一键拉取的功能。
115115
目前只有管理员才有权限拉取,并没有对普通用户开放。要体验这个功能,请用管理员账号登录演示站点体验。
116-
用法很简单,比如我们拉取beego的文档项目,在创建项目后,直接点击"拉取项目",粘贴如" https://github.com/beego/beedoc/archive/master.zip ",然后就会自动帮你拉取上面的所有markdown文档并录入数据库,同时图片也会自动帮你更新到OSS。
117-
![拉取项目](static/openstatic/pull.png)
118-
> 经实测,目前已完美支持各种姿势写作的markdown项目的拉取,能很好地处理文档间的链接以及文档中的图片链接
116+
用法很简单,比如我们拉取beego的书籍,在创建书籍后,直接点击"拉取书籍",粘贴如" https://github.com/beego/beedoc/archive/master.zip ",然后就会自动帮你拉取上面的所有markdown文档并录入数据库,同时图片也会自动帮你更新到OSS。
117+
![拉取书籍](static/openstatic/pull.png)
118+
> 经实测,目前已完美支持各种姿势写作的markdown书籍的拉取,能很好地处理文档间的链接以及文档中的图片链接
119119
120-
> 目前已支持Git Clone导入项目
120+
> 目前已支持Git Clone导入书籍
121121
122122
<a name="generate"></a>
123123
### 生成和导出PDF、epub、mobi等离线文档
@@ -127,9 +127,9 @@ BookStack 安装使用手册:[https://www.bookstack.cn/books/help](https://www
127127

128128
<a name="sort"></a>
129129
### 文档排序和批量创建文档
130-
很多时候,我们在写作文档项目的时候,会习惯地先把文档项目的章节目录结构创建出来,然后再慢慢写内容。
131-
但是,文档项目中的文档少的时候,一个个去创建倒没什么,但是文档数量多了之后,简直就是虐待自己,排序的时候还要一个一个去拖拽进行排序,很麻烦。现在,这个问题已经解决了。如下:
132-
- 在文档项目中,创建一个文档标识为`summary.md`的文档(大小写不敏感)
130+
很多时候,我们在写作书籍的时候,会习惯地先把书籍的章节目录结构创建出来,然后再慢慢写内容。
131+
但是,书籍中的文档少的时候,一个个去创建倒没什么,但是文档数量多了之后,简直就是虐待自己,排序的时候还要一个一个去拖拽进行排序,很麻烦。现在,这个问题已经解决了。如下:
132+
- 在书籍中,创建一个文档标识为`summary.md`的文档(大小写不敏感)
133133
- 在文档中,填充无序列表的markdown内容,如:
134134

135135
```markdown
@@ -154,7 +154,7 @@ BookStack 安装使用手册:[https://www.bookstack.cn/books/help](https://www
154154

155155
<a name="redirect"></a>
156156
### 文档间的跳转
157-
你在一个文档项目中会有很多文档,其中一个文档的文档标识叫`readme.md`,另外一个文档的文档标识叫`quickstart.md`,两个文档间如何跳转呢?
157+
你在一个书籍中会有很多文档,其中一个文档的文档标识叫`readme.md`,另外一个文档的文档标识叫`quickstart.md`,两个文档间如何跳转呢?
158158
如果你知道站点的路由规则,倒是可以轻松链过去,但是,每次都要这样写,真的很麻烦。自己也经常写文档,简直受够了,然后想到了一个办法。如下:
159159
我从`readme.md`跳转到`quickstart.md`,在`readme.md`中的内容这样写:
160160
```
@@ -165,7 +165,7 @@ BookStack 安装使用手册:[https://www.bookstack.cn/books/help](https://www
165165
[快速开始-步骤三]($quickstart.md#step3)
166166
```
167167
好了,在发布文档的时候,文档就会根据路由规则以及你的文档标识去生成链接了(由于是后端去处理,所以在编辑文档的时候,前端展示的预览内容,暂时是无法跳转的)。
168-
那么,问题就来了,我文档项目里面的文档越来越多,我怎么知道我要链接的那个文档的文档标识呢?不用担心,在markdown编辑器的左侧,括号里面的红色文字显示的就是你的文档标识。
168+
那么,问题就来了,我书籍里面的文档越来越多,我怎么知道我要链接的那个文档的文档标识呢?不用担心,在markdown编辑器的左侧,括号里面的红色文字显示的就是你的文档标识。
169169

170170
![文档标识](static/openstatic/identify.png)
171171

@@ -207,13 +207,13 @@ BookStack 安装使用手册:[https://www.bookstack.cn/books/help](https://www
207207
208208
![内容阅读页](static/openstatic/page-read.png)
209209

210-
> 个人项目页
210+
> 个人书籍页
211211
212-
![个人项目页](static/openstatic/page-project.png)
212+
![个人书籍页](static/openstatic/page-project.png)
213213

214214
> 手机端首页
215215
216-
![个人项目页](static/openstatic/page-mobile.png)
216+
![个人书籍页](static/openstatic/page-mobile.png)
217217

218218

219219
<a name="todo"></a>

change.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@
3232
- [ ] 程序员网址导航
3333

3434
## v2.9 升级日志
35-
- [x] 对无权限创建书籍项目的用户,隐藏创建书籍入口
35+
- [x] 对无权限创建书籍书籍的用户,隐藏创建书籍入口
3636
- [x] 优化首页分类索引显示
37-
- [ ] 上传分类图标和上传项目优化
37+
- [ ] 上传分类图标和上传书籍优化
3838

3939
## v2.8 升级日志
4040
- [x] 优化内容阅读体验:调整文字行高、章内目录以及优化内容图片预览
@@ -78,7 +78,7 @@
7878
- [x] 增加是否允许游客访问的功能(禁止游客访问的话,只能登录)
7979
- [x] 增加首页是否显示分类索引功能,以便分类太多
8080
- [x] 内容采集转发
81-
- [x] markdown项目导入的时候`//`开头的链接或者非`.md``.markdown`结尾的链接,不转成`$`开头的相对链接
81+
- [x] markdown书籍导入的时候`//`开头的链接或者非`.md``.markdown`结尾的链接,不转成`$`开头的相对链接
8282
- [x] 删除用户的时候,提示并确认删除,避免误删
8383
- [x] Github oauth登录调整(Please use the Authorization HTTP header instead as using the `access_token` query parameter is deprecated.)
8484

@@ -120,14 +120,14 @@
120120
- [x] 书籍信息设置页,支持增加文字广告功能,并增加 APP 跳转页
121121
- [x] 电子书是否登录才能下载
122122
- [x] 移动端横幅尺寸控制(由于移动端横幅展示,为了不使横幅变形,以及能够灵活控制移动端横幅宽高比例显示)
123-
- [x] 支持`项目设置`给项目内容增加全局文字小广告功能,比如添加原作者赞助二维码链接或者是原作者实体书购买地址等,以便支持开源作者
124-
- [x] 私有项目,增加访问密码(项目成员可以免密码访问
123+
- [x] 支持`书籍设置`给书籍内容增加全局文字小广告功能,比如添加原作者赞助二维码链接或者是原作者实体书购买地址等,以便支持开源作者
124+
- [x] 私有书籍,增加访问密码(书籍成员可以免密码访问
125125
- [x] 小分辨率电脑,内容阅读时,不悬浮显示内容菜单,避免影响阅读体验
126126
- [x] 配置管理,增加图片链接由`http://`自动替换为`https://`开关,因为 --> [Chrome 将不再允许 https:// 页面加载 HTTP 资源](https://www.oschina.net/news/110345/chrome-to-block-http-in-https)
127-
- [x] 如果只有作者才能写作,则如果项目创建者不是作者,已创建了项目的,不允许私有转公有、不允许私密分享
128-
- [x] 项目成员PC端无法访问和编辑项目的问题处理
127+
- [x] 如果只有作者才能写作,则如果书籍创建者不是作者,已创建了书籍的,不允许私有转公有、不允许私密分享
128+
- [x] 书籍成员PC端无法访问和编辑书籍的问题处理
129129
- [x] 管理员和创始人可以设置书籍信息以及生成电子书
130-
- [x] 编辑者以上权限可以克隆、上传等对项目进行编辑操作
130+
- [x] 编辑者以上权限可以克隆、上传等对书籍进行编辑操作
131131

132132

133133
## V2.1 升级日志
@@ -137,7 +137,7 @@
137137
- [x] markdown导入功能获取标题优化
138138
- [x] 内容采集持续优化,URL链接替换优化
139139
- [x] 支持隐藏收录入口
140-
- [x] 支持隐藏项目开源入口
140+
- [x] 支持隐藏书籍开源入口
141141
- [x] API接口用户注册接口,支持控制每小时和每天的用户注册数量,以避免恶意攻击
142142
- [x] 文档内容,SEO 标题支持获取文档的上一个文档的标题
143143
- [x] `puppeteer`采集优化
@@ -154,7 +154,7 @@
154154
- [x] 微信小程序API接口开发
155155
- [x] 书籍在发布的时候,把非站内图片自动采集下来
156156
- [x] `BookStack` 配套微信小程序 `BookChat` API接口实现,累计20+个API接口
157-
- [x] 修复删除项目时误删默认封面的bug
157+
- [x] 修复删除书籍时误删默认封面的bug
158158
- [x] HTML内容处理,以兼容微信小程序`rich-text`组件实现微信小程序文档内容渲染
159159
- [x] 开源书籍和文档收录提交入口以及收录管理
160160
- [x] 增加网站小程序码功能,打通PC端与移动端一体化阅读浏览
@@ -165,7 +165,7 @@
165165
- [x] 支持 `epub` 导入
166166
- [x] 隐藏附件管理入口(因为不依赖于此管理附件)
167167
- [x] 管理后台可根据用户名、昵称、邮箱和角色对用户进行检索和管理
168-
- [x] 增加`作者`角色,用于控制普通用户创建项目权限
168+
- [x] 增加`作者`角色,用于控制普通用户创建书籍权限
169169

170170
## v1.7 升级日志
171171
- [x] 增加书籍和文档搜索精度控制(在管理后台可设置)
@@ -212,7 +212,7 @@
212212
- [x] 文档内的搜索,使用elasticsearch
213213
- [x] 在书籍编辑页面可以克隆或者是上传markdown
214214
- [x] 文章内容页顶部显示 作者、发布时间、更新时间、浏览量、分享人
215-
- [x] 新建和编辑项目,支持添加原作者和原作者链接
215+
- [x] 新建和编辑书籍,支持添加原作者和原作者链接
216216
- [x] 文档文章内容,顶部标题下显示信息
217217
- [x] 管理后台控制第三方登录的显示与隐藏
218218
- [x] HTML table 渲染问题优化(把`editormd.js`中的`breaks`设置为false)
@@ -223,19 +223,19 @@ sudo docker run -it -p 9300:9300 -p 9200:9200 -v /Users/TruthHun/elasticsearch/d
223223
```
224224

225225
## V1.5 升级日志
226-
- [x] 修复:文档项目删除时间过长进而导致删除失败的Bug(启用了MySQL的事务,但事务中SQL语句有select字句查询造成的问题)
227-
- [x] 修复:项目成员列表显示不全的Bug(分页问题导致) [#25](https://github.com/TruthHun/BookStack/issues/25)
228-
- [x] 修复:文档项目标识正则匹配规则不正确的问题
229-
- [x] 优化:分类在筛选文档项目的时候,SEO优化,以文档分类作为`title`等,不再以首页的文案作为`title`
230-
- [x] 优化:一键采集文档项目,自动检测并下载图片
226+
- [x] 修复:书籍删除时间过长进而导致删除失败的Bug(启用了MySQL的事务,但事务中SQL语句有select字句查询造成的问题)
227+
- [x] 修复:书籍成员列表显示不全的Bug(分页问题导致) [#25](https://github.com/TruthHun/BookStack/issues/25)
228+
- [x] 修复:书籍标识正则匹配规则不正确的问题
229+
- [x] 优化:分类在筛选书籍的时候,SEO优化,以文档分类作为`title`等,不再以首页的文案作为`title`
230+
- [x] 优化:一键采集书籍,自动检测并下载图片
231231
- [x] 优化:恢复文档模板功能
232232
- [x] 优化:文档中,图片不再使用带http的URL绝对路径,以解决更换域名后写死的URL找不到图片
233233
- [x] 新增:书籍推荐,在封面加上"推荐"图标标志。
234-
- [x] 新增:`Git Clone` 的方式导入项目
234+
- [x] 新增:`Git Clone` 的方式导入书籍
235235
- [x] 编辑文档图片需要处理
236236
- [x] 阅读页面图片需要处理
237237
- [x] 导出文档图片需要处理
238-
- [x] 项目导入的图片需要处理
238+
- [x] 书籍导入的图片需要处理
239239
- [x] 优化:文档阅读体验优化
240240
- [x] 文档阅读页面左侧章节菜单,可展开和收起
241241
- [x] 键盘左右方向键按键切换文档上下章节
@@ -247,7 +247,7 @@ sudo docker run -it -p 9300:9300 -p 9200:9200 -v /Users/TruthHun/elasticsearch/d
247247
- [x] 文档编辑历史,使用文件存储的方式进行记录,不存入数据库.
248248
- [x] 版本控制,在`<bookstack-git></bookstack-git>`标签内添加文案用以提交版本说明。如`<bookstack-git>first commit</bookstack-git>`等同于`git commit -m "first commit"`
249249
- [x] 删除版本记录的时候要同时删除版本文件
250-
- [x] 删除文档项目时同时删除项目所有的相关文档章节版本记录
250+
- [x] 删除书籍时同时删除书籍所有的相关文档章节版本记录
251251
- [x] 删除单个文档章节以及删除上一级文档章节,则被删除的文档章节的历史版本记录同样要删除
252252
- [x] `SUMMARY.md`功能扩展,输入`<bookstack-auto></bookstack-auto>`,获取所有文档章节标识
253253

@@ -288,12 +288,12 @@ sudo docker run -it -p 9300:9300 -p 9200:9200 -v /Users/TruthHun/elasticsearch/d
288288
<a name="v1.2"></a>
289289
## V1.2 升级日志(功能增强,已于2018-04-07完成)
290290
- [x] 修复图片存储路径不正确的问题
291-
- [x] 正确输入文档项目标识和登录密码才能删除文档项目,以避免误删操作
291+
- [x] 正确输入书籍标识和登录密码才能删除书籍,以避免误删操作
292292
- [x] 增加移动端搜索入口
293293
- [x] 扩展采集功能,增加`DIY模式`,以采集提取页面的指定内容
294294
- [x] 增加文档分类功能(工作量最大的一项,还新增了分类数据表。用户都不知道自己需要什么,但是却知道自己不需要什么,所以必须要有个分类来引导用户查找自己需要的资料;前端隐藏暂时没有书籍的分类)
295295
- [x] sitemap的`changefreq`,调整为`weekly`
296-
- [x] 项目名称,SEO时,默认加上书名号
296+
- [x] 书籍名称,SEO时,默认加上书名号
297297
- [x] 用户个人主页、收藏、关注、粉丝等
298298
- [x] 友链管理
299299

@@ -308,13 +308,13 @@ FIX:
308308
- [x] 增加备案链接链到工信部。
309309
- [x] 文档阅读页面缺少了统计代码,已加上。
310310
- [x] 解决给文档打分时分值错误的问题。
311-
- [x] 一键导入和一键拉取markdown项目时,如果出现相同identity的文档,则执行更新,否则为新录入
312-
- [x] 一键拉取项目,支持任何来源的zip压缩的markdown项目的拉取
311+
- [x] 一键导入和一键拉取markdown书籍时,如果出现相同identity的文档,则执行更新,否则为新录入
312+
- [x] 一键拉取书籍,支持任何来源的zip压缩的markdown书籍的拉取
313313
- [x] 无刷新加载上下篇阅读文档,优化阅读体验
314314
- [x] 移除SEO等Go文件中硬编码的"bookstack.cn"的域名(因为BookStack,一开始是打算自用的,所以当时写死了)
315315
- [x] 登录和注册验证码优化(使用Beego自带的验证码体系:<https://github.com/astaxie/beego/tree/master/utils/captcha)>
316316
- [x] 支持本地化存储(改动了很多地方,具体改动,请`git log`查看)。在app.conf中增加了`store_type`配置项,以扩展存储类型,目前扩展的存储类型有本地存储(`local`)和阿里云OSS存储(`oss`),更多存储类型(`七牛云存储(qiniu)、腾讯云存储(cos)、百度云存储(bos)、又拍云存储(upyun)`)持续开发中.
317317
- [x] 分页优化
318318
- [x] 解决角色名称有时不显示的问题
319-
- [x] 解决`导入项目``拉取项目`,项目中的图片、文档间的链接不正确的问题,目前兼容绝大多数各种姿势的markdown项目导入和拉取
319+
- [x] 解决`导入书籍``拉取书籍`,书籍中的图片、文档间的链接不正确的问题,目前兼容绝大多数各种姿势的markdown书籍导入和拉取
320320

0 commit comments

Comments
 (0)