快速構建文件知識庫站點

jeanron100發表於2017-11-30

今天中午花了點時間嘗試構建了一個文件知識庫小站點,作為一個知識庫方案落地的備選。使用的是開源專案Raneto,全面支援markdown的格式。

快速構建文件知識庫站點

有些同學可能對markdown的格式有些陌生,如果熟悉GitHub會發現裡面大量的檔案都是.md結尾的,比如readme.md檔案。

markdown支援的格式還是很豐富的,而且語法相當簡潔。相比於html的標籤更加輕量級。GitHub上有個專案就做RADME,就是示例怎麼去寫markdown格式的檔案。

快速構建文件知識庫站點

這個過程可以邊實現邊改進,就跟我這幾天和一個業內朋友討論SQL稽核時我說,功能優先,介面醜點沒關係,我們能忍。這是一個0-1,1-90的問題,你得現有,然後再在這個基礎上談優化。

構建Raneto專案的步驟很簡單,大概得花個十多分鐘。

首先需要從GitHub上下載整個專案。

git clone https://github.com/gilbitron/Raneto

因為Raneto是基於NodeJS的專案,所以你得包裝安裝了NodeJS,可以參考連結:

https://nodejs.org/zh-cn/download/

比如我下載了一個略舊的版本,最新的是8.9.1

node-v7.6.0-linux-x64.tar

使用node -v來檢視版本,如果沒有問題,證明這個基礎的安裝就可以了。

接下來需要的就是npm了,這是管理JS包的工具。

有了node,就會自帶。使用npm -v也可以檢視npm的版本。

然後我們到Raneto的目錄下,使用npm install來完成基本的安裝,這個過程會持續一些時間,因為要下載一些相關的包,在根目錄所在路徑的目錄.npm下,會下載大概50M左右的相關包。

這個部分完成之後,就可以使用npm start來啟動了。

快速構建文件知識庫站點

開啟頁面http://localhost:3000即可看到內容。整體看起來還不錯。

快速構建文件知識庫站點

當然這個是一個樣例目錄,我們需要在這個基礎上來定製修改,完成自己的基本需求。

可以在Raneto目錄下建立一個新的目錄,可以理解是一個新的專案,比如jeanron100

可以把同級目錄example下的*.js和*.json檔案都拷貝過來複用

然後建立一個content目錄,作為顯示的內容主體,這個目錄和web專案裡面的webroot,webapp等差不多。然後我們可以建立一個測試檔案index.md

輸入一句話作為測試:

# cat index.md

this is a test

修改jeanron100目錄下的config.default.js檔案,新增檔案的標題和語言(預設是英文)

site_title: 'DBA文件庫',

locale: 'zh',

然後在Raneto的目錄下修改入口的配置檔案package.json

修改下面的這一句為專案jeanron100

"s": {

"start": "DEBUG=raneto node jeanron100/server.js",

重新啟動,就可以看到新的頁面了。

快速構建文件知識庫站點

稍後比如我們繼續補充,可以新增很多的目錄,比如在content下面新增多個目錄,一個根目錄是a,然後下面有一系列的目錄和檔案。

重新整理一下就能看到效果了。

快速構建文件知識庫站點

按照這個套路繼續補充即可。

來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/23718752/viewspace-2148050/,如需轉載,請註明出處,否則將追究法律責任。

相關文章