同步操作将从 进击的皇虫/BookStack 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
BookStack,分享知识,共享智慧!知识,因分享,传承久远!
BookStack是基于Mindoc开发的,为运营而生。
在开发的过程中,我增加和移除了一些东西,目前已经不兼容MinDoc了(毕竟数据表结构、字段、索引都有了一些不同),同时只支持markdown编辑器。
如果您要部署使用BookStack,需要有阿里云的ECS服务器和OSS(因为文件存储,我只开发了OSS的,毕竟我自己用的是阿里云的ECS,通过内网,能将文件快速同步到OSS)。
其它云服务器商,我手头上没有服务器资源,所以开发的时候没有考虑(毕竟总不能让我做一个开源项目,都跑到各大服务器商那里买台服务器吧)。
两年前还在做PHP开发的时候,无意间遇到了Gitbook,以及看云,还有readthedoc。
当时想着自己也开发一套,但是后来没时间,当时也没那个技术积累。
后来学了Go语言,又在无意间遇到了Mindoc,然后我们公司(掘金量化)也恰巧让我开发公司官网和文档系统,然后我就对Mindoc做了二次开发。
本来是不想开源的,因为自己写代码的时候,写着写着,代码改来改去,然后代码就乱七八糟了,怕开源出来丢人现眼。但是踏入IT行业三年多时间以来,自身也受益于各种开源项目和开源组件,所以最终还是决定将BookStack开源出来。
其中肯定还是有不足的地方,大家在使用的过程中,遇到问题,欢迎反馈。
有些功能,只有拥有管理员权限的用户才能使用,所以放出演示站点,欢迎大家随便玩。 管理员账号和密码如下(请大家不要更改密码,以方便大家体验,谢谢):
账号:bookstack
密码:bookstack.cn
Tips:
因为演示站点上的内容,大家在测试的时候,肯定是各种乱七八糟的什么内容都有,所以放出正式站点,给大家看下真正的效果。 还望大家不要在这个站点发一些乱七八糟的内容,毕竟这是正式站点,谢谢。
这个功能,相信是很多人的最爱了。目前这个功能仅对管理员开放。 这个功能可以使用了,但是有时候因为每个人的markdown写作习惯不一样,导入的时候,可能还是会有一些小问题,比如图片路径不正确的问题。 大家在使用的时候,遇到问题,请随时到论坛反馈。我会接受大家的各种意见和建议,并把这个功能做完善和完美!
看到GitHub、Gitee等有很多开源文档的项目,但是一个一个去拷贝粘贴里面的markdown内容不现实。于是,做了这个一键拉取的功能。 目前只有管理员才有权限拉取,并没有对普通用户开发。要体验这个功能,请用管理员账号登录演示站点体验。 用法很简单,比如我们拉取beego的文档项目,在创建项目后,直接点击"拉取项目",粘贴如" https://github.com/beego/beedoc/archive/master.zip ",然后就会自动帮你拉取上面的所有markdown文档并录入数据库,同时图片也会自动帮你更新到OSS。 Tips:
projects/你的项目的identify/你导入的项目的图片路径
这个需要安装和配置calibre。 我将calibre的使用专门封装成了一个工具,并编译成了二进制,源码、程序和使用说地址:https://github.com/TruthHun/converter 在BookStack中,已经引入这个包了。使用的时候,点击"生成下载文档"即可
很多时候,我们在写作文档项目的时候,会习惯地先把文档项目的章节目录结构创建出来,然后再慢慢写内容。 但是,文档项目中的文档少的时候,一个个去创建倒没什么,但是文档数量多了之后,简直就是虐待自己,排序的时候还要一个一个去拖拽进行排序,很麻烦。现在,这个问题已经解决了。如下:
summary.md
的文档(大小写不敏感)<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)
注意:
必须要有
<bookstack-summary></bookstack-summary>
,这样是为了告诉程序,我这个summary.md
的文档,是用来创建文档和对文档进行排序的。当然,排序完成之后,当前页面会刷新一遍,并且把<bookstack-summary></bookstack-summary>
移除了。有时候,第一次排序并没有排序成功,再添加一次这个标签,程序会自动帮你再排序一次。 我自己也常用这种方式批量创建文档以及批量修改文档的标题
你在一个文档项目中会有很多文档,其中一个文档的文档标识叫readme.md
,另外一个文档的文档标识叫quickstart.md
,两个文档间如何跳转呢?
如果你知道站点的路由规则,倒是可以轻松链过去,但是,每次都要这样写,真的很麻烦。自己也经常写文档,简直受够了,然后想到了一个办法。如下:
我从readme.md
跳转到quickstart.md
,在readme.md
中的内容这样写:
[快速开始]($quickstart.md)
如果跳转到quickstart.md
的某个锚点呢?那就像下面这样写:
[快速开始-步骤三]($quickstart.md#step3)
好了,在发布文档的时候,文档就会根据路由规则以及你的文档标识去生成链接了(由于是后端去处理,所以在编辑文档的时候,前端展示的预览内容,暂时是无法跳转的)。 那么,问题就来了,我文档项目里面的文档越来越多,我怎么知道我要链接的那个文档的文档标识呢?不用担心,在markdown编辑器的左侧,括号里面的红色文字显示的就是你的文档标识。
看到一篇很好的文章,但是文章里面有代码段、有图片,手工复制过来,格式全乱了,所以,相信采集功能,会是你需要的。采集功能,在markdown编辑器的功能栏上面,对,就是那个瓢虫图标,就是那个Bug,因为我找不到蜘蛛的图标...
功能见下图,具体体验,请到演示站点体验。
后台管理,个性化定制你的SEO关键字;并且在SEO管理这里,可以更新站点sitemap(暂时没做程序定时自动更新sitemap)
用户闲的蛋疼才会来你这里进行文档写作并给你生产内容...所以,要给用户画个饼——你来我这里进行文档写作,不但可以展示你的才华,还可以收到别人的打赏,而且,别人给你的打赏全都是直达你那里,没有中奸商
赚差价。。。
这是个看脸的时代...
首页
介绍页
内容阅读页
个人项目页
手机端首页
更多功能,期待您的想象力,然后向我提出来,请到HC-CMS发帖提交:http://www.hc-cms.com
为了方便,安装和使用教程,请移步到这里:http://www.bookstack.cn/read/help/Ubuntu.md
目前只写了Ubuntu下的安装教程,Windows下的安装和使用教程,暂时没时间
2014年7月本科"毕业"踏入IT行业;Web全栈工程师;什么都懂一点,什么都不精通。
如果我的努力值得你的肯定,请赞助我,让我在开源的路上,做更好,走更远。
赞助我的方式包括:支付宝打赏
、微信打赏
、给BookStack一个star
、向我反馈意见和建议
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。