BookStack(在線文檔管理系統(tǒng))是一個基于MinDoc、使用Beego開發(fā)的在線文檔管理系統(tǒng),在開發(fā)的過程中,增加和移除了一些東西,目前已經(jīng)不兼容MinDoc了,同時只支持markdown編輯器。
軟件特色
1、書籍分類(V1.2 +)
用戶就像你的老板,他不知道自己需要什么,但是他知道自己不需要什么...
2、用戶主頁(V1.2 +)
在用戶主頁,展示用戶分享的書籍、粉絲、關(guān)注和手冊,增加用戶間的互動
3、一鍵導入markdown項目
這個功能,相信是很多人的最愛了。目前這個功能僅對管理員開放。
經(jīng)實測,目前已完美支持各種姿勢寫作的markdown項目的文檔導入,能很好地處理文檔間的鏈接以及文檔中的圖片鏈接
4、一鍵拉取markdown項目
看到GitHub、Gitee等有很多開源文檔的項目,但是一個一個去拷貝粘貼里面的markdown內(nèi)容不現(xiàn)實。于是,做了這個一鍵拉取的功能。 目前只有管理員才有權(quán)限拉取,并沒有對普通用戶開放。要體驗這個功能,請用管理員賬號登錄演示站點體驗。 用法很簡單,比如我們拉取beego的文檔項目,在創(chuàng)建項目后,直接點擊"拉取項目",粘貼如" https://github.com/beego/beedoc/archive/master.zip ",然后就會自動幫你拉取上面的所有markdown文檔并錄入數(shù)據(jù)庫,同時圖片也會自動幫你更新到OSS。 拉取項目
經(jīng)實測,目前已完美支持各種姿勢寫作的markdown項目的拉取,能很好地處理文檔間的鏈接以及文檔中的圖片鏈接
目前已支持Git Clone導入項目
5、生成和導出PDF、epub、mobi等離線文檔
這個需要安裝和配置calibre。 我將calibre的使用專門封裝成了一個工具,并編譯成了二進制,源碼、程序和使用說地址:https://github.com/TruthHun/converter 在BookStack中,已經(jīng)引入這個包了。使用的時候,點擊"生成下載文檔"即可
6、文檔排序和批量創(chuàng)建文檔
很多時候,我們在寫作文檔項目的時候,會習慣地先把文檔項目的章節(jié)目錄結(jié)構(gòu)創(chuàng)建出來,然后再慢慢寫內(nèi)容。 但是,文檔項目中的文檔少的時候,一個個去創(chuàng)建倒沒什么,但是文檔數(shù)量多了之后,簡直就是虐待自己,排序的時候還要一個一個去拖拽進行排序,很麻煩?,F(xiàn)在,這個問題已經(jīng)解決了。
7、文檔間的跳轉(zhuǎn)
你在一個文檔項目中會有很多文檔,其中一個文檔的文檔標識叫readme.md,另外一個文檔的文檔標識叫quickstart.md,兩個文檔間如何跳轉(zhuǎn)呢? 如果你知道站點的路由規(guī)則,倒是可以輕松鏈過去,但是,每次都要這樣寫,真的很麻煩。自己也經(jīng)常寫文檔,簡直受夠了,然后想到了一個辦法。如下: 我從readme.md跳轉(zhuǎn)到quickstart.md,在readme.md中的內(nèi)容這樣寫:
[快速開始]($quickstart.md)
如果跳轉(zhuǎn)到quickstart.md的某個錨點呢?那就像下面這樣寫:
[快速開始-步驟三]($quickstart.md#step3)
好了,在發(fā)布文檔的時候,文檔就會根據(jù)路由規(guī)則以及你的文檔標識去生成鏈接了(由于是后端去處理,所以在編輯文檔的時候,前端展示的預覽內(nèi)容,暫時是無法跳轉(zhuǎn)的)。 那么,問題就來了,我文檔項目里面的文檔越來越多,我怎么知道我要鏈接的那個文檔的文檔標識呢?不用擔心,在markdown編輯器的左側(cè),括號里面的紅色文字顯示的就是你的文檔標識。
8、采集功能
看到一篇很好的文章,但是文章里面有代碼段、有圖片,手工復制過來,格式全亂了,所以,相信采集功能,會是你需要的。采集功能,在markdown編輯器的功能欄上面,對,就是那個瓢蟲圖標,就是那個Bug,因為我找不到蜘蛛的圖標...
9、SEO
后臺管理,個性化定制你的SEO關(guān)鍵字;并且在SEO管理這里,可以更新站點sitemap(暫時沒做程序定時自動更新sitemap)
10、版本控制
MinDoc之前本身就有版本控制的,但是版本控制的文檔內(nèi)容全都存在數(shù)據(jù)庫中,如果修改頻繁而導致修改歷史過多的話,數(shù)據(jù)庫可能會被撐爆。當時沒有好的解決辦法,所以將該功能移除了。
目前加上該功能,是因為這個功能呼聲很高,所以加回來了。但是版本控制的內(nèi)容不再存儲到數(shù)據(jù)庫中,而是以文件的形式存儲到本地或者是云存儲上。
功能在管理后臺->配置管理中進行開啟
11、更美觀、簡潔的頁面布局和更為完善的移動端兼容
這是個看臉的時代...