維基是Web協(xié)同著作平臺,可以讓任何瀏覽網(wǎng)頁的人都能夠方便地參與網(wǎng)頁的編輯和創(chuàng)建。這源自于維基如下魔力:
- 快速更改。修改網(wǎng)頁無需復(fù)雜的后臺修改和網(wǎng)頁部署流程,瀏覽的網(wǎng)頁直接提供編輯按鈕,任何查看網(wǎng)頁的用戶均可在線編輯網(wǎng)頁。
- 簡潔語法。編寫網(wǎng)頁不需要學(xué)習(xí)復(fù)雜的HTML,取而代之的是易學(xué)易用的格式化文本(維基語法),有的維基還提供圖形化編輯界面。
- 版本控制。熟悉Git的人,可以把維基看作是Web的版本控制。歷次修改都記錄在案,歷史修訂可進(jìn)行比較,可恢復(fù)到歷史版本等。
- 維基鏈接。頁面鏈接使用[[頁面名稱]]語法,可以非常方便地創(chuàng)建新頁面,并實現(xiàn)頁面間的互聯(lián)。
GitHub提供了維基模塊,方便項目團(tuán)隊創(chuàng)建社區(qū)驅(qū)動和維護(hù)的項目文檔。
GitHub的維基模塊可以通過項目管理頁面控制開啟或關(guān)閉,默認(rèn)開啟。因為GitHub提供了項目展示的多種途徑,一些小項目如果覺得用README文件構(gòu)建項目說明,或者用gh-pages分支維護(hù)項目主頁就足夠了,大可關(guān)閉維基模塊。
維基頁面并沒有自動創(chuàng)建,還需要進(jìn)行初始化。自動創(chuàng)建的維基首頁只有非常簡單的信息,點擊編輯按鈕,修改維基首頁。首頁的頁面名稱為“Home”,不能隨意更改,否則無法找到首頁,或者頁面之間的跳轉(zhuǎn)會失效。無論怎樣更改維基頁面都不怕內(nèi)容丟失,因為維基記錄了每一次修訂歷史,并可以回退任意一次修改。
在維基中創(chuàng)建新頁面有多種方法,可以點擊頁面中的“New Page”按鈕,也可以先在頁面中用[[頁面名稱]]格式嵌入維基鏈接,然后在生成的頁面中可以看到指向新頁面的鏈接,當(dāng)然這些鏈接所指向的頁面并不存在。
對于項目gotgithub/helloworld來說,用Git克隆其維基,用如下命令:
$ git clone git@github.com:gotgithub/helloworld.wiki.git
GitHub維基背后的引擎名為Gollum,GitHub已將其開源,項目網(wǎng)址:https://github.com/github/gollum 。安裝Gollum,在克隆的維基版本庫中運(yùn)行g(shù)ollum就可以在本地啟動維基服務(wù)。