BookStack官方版是一款優(yōu)秀的在線文檔管理系統(tǒng)。BookStack官方版是一個(gè)基于MinDoc、使用Beego開發(fā)的在線文檔管理系統(tǒng),BookStack官方版還為用戶們提供了非常多實(shí)用的文檔在線編輯功能,在用戶主頁,展示用戶分享的書籍、粉絲、關(guān)注和手冊(cè)。它能夠生成和導(dǎo)出PDF、epub、mobi等離線文檔。
軟件介紹
BookStack官方版(在線文檔管理系統(tǒng))是一個(gè)基于MinDoc、使用Beego開發(fā)的在線文檔管理系統(tǒng),在開發(fā)的過程中,增加和移除了一些東西,目前已經(jīng)不兼容MinDoc了,同時(shí)只支持markdown編輯器。
軟件特色
1、書籍分類(V1.2 +)
用戶就像你的老板,他不知道自己需要什么,但是他知道自己不需要什么...
2、用戶主頁(V1.2 +)
在用戶主頁,展示用戶分享的書籍、粉絲、關(guān)注和手冊(cè),增加用戶間的互動(dòng)
3、一鍵導(dǎo)入markdown項(xiàng)目
這個(gè)功能,相信是很多人的最愛了。目前這個(gè)功能僅對(duì)管理員開放。
經(jīng)實(shí)測,目前已完美支持各種姿勢寫作的markdown項(xiàng)目的文檔導(dǎo)入,能很好地處理文檔間的鏈接以及文檔中的圖片鏈接
4、一鍵拉取markdown項(xiàng)目
看到GitHub、Gitee等有很多開源文檔的項(xiàng)目,但是一個(gè)一個(gè)去拷貝粘貼里面的markdown內(nèi)容不現(xiàn)實(shí)。于是,做了這個(gè)一鍵拉取的功能。
目前只有管理員才有權(quán)限拉取,并沒有對(duì)普通用戶開放。要體驗(yàn)這個(gè)功能,請(qǐng)用管理員賬號(hào)登錄演示站點(diǎn)體驗(yàn)。
用法很簡單,比如我們拉取beego的文檔項(xiàng)目,在創(chuàng)建項(xiàng)目后,直接點(diǎn)擊"拉取項(xiàng)目",粘貼如"
https://github.com/beego/beedoc/archive/master.zip
",然后就會(huì)自動(dòng)幫你拉取上面的所有markdown文檔并錄入數(shù)據(jù)庫,同時(shí)圖片也會(huì)自動(dòng)幫你更新到OSS。 拉取項(xiàng)目
經(jīng)實(shí)測,目前已完美支持各種姿勢寫作的markdown項(xiàng)目的拉取,能很好地處理文檔間的鏈接以及文檔中的圖片鏈接
目前已支持Git Clone導(dǎo)入項(xiàng)目
5、生成和導(dǎo)出PDF、epub、mobi等離線文檔
這個(gè)需要安裝和配置calibre。
我將calibre的使用專門封裝成了一個(gè)工具,并編譯成了二進(jìn)制,源碼、程序和使用說地址:https://github.com/TruthHun/converter
在BookStack中,已經(jīng)引入這個(gè)包了。使用的時(shí)候,點(diǎn)擊"生成下載文檔"即可
6、文檔排序和批量創(chuàng)建文檔
很多時(shí)候,我們?cè)趯懽魑臋n項(xiàng)目的時(shí)候,會(huì)習(xí)慣地先把文檔項(xiàng)目的章節(jié)目錄結(jié)構(gòu)創(chuàng)建出來,然后再慢慢寫內(nèi)容。
但是,文檔項(xiàng)目中的文檔少的時(shí)候,一個(gè)個(gè)去創(chuàng)建倒沒什么,但是文檔數(shù)量多了之后,簡直就是虐待自己,排序的時(shí)候還要一個(gè)一個(gè)去拖拽進(jìn)行排序,很麻煩。現(xiàn)在,這個(gè)問題已經(jīng)解決了。
7、文檔間的跳轉(zhuǎn)
你在一個(gè)文檔項(xiàng)目中會(huì)有很多文檔,其中一個(gè)文檔的文檔標(biāo)識(shí)叫readme.md,另外一個(gè)文檔的文檔標(biāo)識(shí)叫quickstart.md,兩個(gè)文檔間如何跳轉(zhuǎn)呢?
如果你知道站點(diǎn)的路由規(guī)則,倒是可以輕松鏈過去,但是,每次都要這樣寫,真的很麻煩。自己也經(jīng)常寫文檔,簡直受夠了,然后想到了一個(gè)辦法。如下:
我從readme.md跳轉(zhuǎn)到quickstart.md,在readme.md中的內(nèi)容這樣寫:
[快速開始]($quickstart.md)
如果跳轉(zhuǎn)到quickstart.md的某個(gè)錨點(diǎn)呢?那就像下面這樣寫:
[快速開始-步驟三]($quickstart.md#step3)
好了,在發(fā)布文檔的時(shí)候,文檔就會(huì)根據(jù)路由規(guī)則以及你的文檔標(biāo)識(shí)去生成鏈接了(由于是后端去處理,所以在編輯文檔的時(shí)候,前端展示的預(yù)覽內(nèi)容,暫時(shí)是無法跳轉(zhuǎn)的)。
那么,問題就來了,我文檔項(xiàng)目里面的文檔越來越多,我怎么知道我要鏈接的那個(gè)文檔的文檔標(biāo)識(shí)呢?不用擔(dān)心,在markdown編輯器的左側(cè),括號(hào)里面的紅色文字顯示的就是你的文檔標(biāo)識(shí)。
8、采集功能
看到一篇很好的文章,但是文章里面有代碼段、有圖片,手工復(fù)制過來,格式全亂了,所以,相信采集功能,會(huì)是你需要的。采集功能,在markdown編輯器的功能欄上面,對(duì),就是那個(gè)瓢蟲圖標(biāo),就是那個(gè)Bug,因?yàn)槲艺也坏街┲氲膱D標(biāo)...
9、SEO
后臺(tái)管理,個(gè)性化定制你的SEO關(guān)鍵字;并且在SEO管理這里,可以更新站點(diǎn)sitemap(暫時(shí)沒做程序定時(shí)自動(dòng)更新sitemap)
10、版本控制
MinDoc之前本身就有版本控制的,但是版本控制的文檔內(nèi)容全都存在數(shù)據(jù)庫中,如果修改頻繁而導(dǎo)致修改歷史過多的話,數(shù)據(jù)庫可能會(huì)被撐爆。當(dāng)時(shí)沒有好的解決辦法,所以將該功能移除了。
目前加上該功能,是因?yàn)檫@個(gè)功能呼聲很高,所以加回來了。但是版本控制的內(nèi)容不再存儲(chǔ)到數(shù)據(jù)庫中,而是以文件的形式存儲(chǔ)到本地或者是云存儲(chǔ)上。
功能在管理后臺(tái)->配置管理中進(jìn)行開啟
11、更美觀、簡潔的頁面布局和更為完善的移動(dòng)端兼容
這是個(gè)看臉的時(shí)代...
開源說明
兩年前還在做PHP開發(fā)的時(shí)候,無意間遇到了Gitbook,以及看云,還有readthedoc。
當(dāng)時(shí)想著自己也開發(fā)一套,但是后來沒時(shí)間,當(dāng)時(shí)也沒那個(gè)技術(shù)積累。
后來學(xué)了Go語言,又在無意間遇到了Mindoc,然后我們公司(掘金量化
)也恰巧讓我開發(fā)公司官網(wǎng)和文檔系統(tǒng),然后我就對(duì)Mindoc做了二次開發(fā)。
本來是不想開源的,因?yàn)樽约簩懘a的時(shí)候,寫著寫著,代碼改來改去,然后代碼就亂七八糟了,怕開源出來丟人現(xiàn)眼。但是踏入IT行業(yè)三年多時(shí)間以來,自身也受益于各種開源書籍和開源組件,所以最終還是決定將BookStack開源出來。
其中肯定還是有不足的地方,大家在使用的過程中,遇到問題,歡迎反饋。
更新日志
管理后臺(tái),恢復(fù)和優(yōu)化附件管理功能,以便管理音頻和視頻
內(nèi)容編輯器支持上傳音頻和視頻(如果開啟了阿里云OSS云存儲(chǔ),則將音視頻上傳到云存儲(chǔ)的同時(shí)將音視頻設(shè)置為私有)
內(nèi)容閱讀頁面音頻視頻播放功能
視頻播放倍速控制
視頻畫中畫播放
禁止音頻和視頻直接下載
優(yōu)化html2json模塊,以及升級(jí)API,使小程序和APP支持音頻和視頻播放,以及圖片放大預(yù)覽
BookStack 依賴檢測,以便程序可以正常使用完整功能進(jìn)行工作,檢測項(xiàng):chrome、puppeteer、git、calibre




