一、wiki建設(shè)
1.安裝MkDocs
1.1 Ubuntu系統(tǒng)
sudo apt-get install mkdocs
1.2 Windows系統(tǒng)
MkDocs目前支持Python2.7,3.4,3.6,3.7版本
安裝Python
安裝pip
pip install –upgrade pip
安裝MkDocs
pip install mkdocs
1.3 確認(rèn)是否安裝正確
mkdocs –version
2.創(chuàng)建一個(gè)Wiki
mkdocs new my-wiki
cd my-wiki
docs文件夾下存放的就是自己寫的Markdown文章,系統(tǒng)默認(rèn)會(huì)生成一個(gè)index.md文件
mkdocs.yml是wiki網(wǎng)站的配置文件(主題、目錄、語(yǔ)言等)
3.預(yù)覽wiki
首先啟動(dòng)mkdocs服務(wù)
mkdocs serve
然后打開瀏覽器輸入127.0.0.1:8000訪問wiki
如果以上步驟都執(zhí)行成功,你將看到如下界面:
至此,一個(gè)wiki系統(tǒng)已經(jīng)搭建完成,下面我們來(lái)學(xué)習(xí)一下如何向wiki系統(tǒng)中添加新的內(nèi)容吧!
4.添加新內(nèi)容
4.1 添加新的文字內(nèi)容
首先在docs文件夾下面創(chuàng)建test.md文件,并使用你喜歡的markdown編輯器寫入內(nèi)容。
This is a new page.
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
編輯mkdocs.yml文件,寫入以下內(nèi)容:
nav:
??? – Home: index.md
??? – First: first.md
4.2 插入圖片
在docs文件夾下創(chuàng)建images文件夾,并將圖片放入此文件夾,然后在markdown文件中引用:
![mkdocs](images/mkdocs.png)
5.更換主題
mkdocs有多個(gè)主題可供選擇,以滿足不用用戶的喜好,在此小編向大家推薦Material主題。
5.1 安裝Material主題
pip install mkdocs-material
5.2 配置wiki使用Material主題
打開配置文件mkdocs.yml,寫入以下內(nèi)容:
theme:
name: ‘material’
6.將你的wiki站點(diǎn)托管到GitHub
創(chuàng)建一個(gè)新倉(cāng)庫(kù)。 比如: https://github.com/user_name/repository_name
初始化你的本地倉(cāng)庫(kù)(wiki), 添加遠(yuǎn)程倉(cāng)庫(kù),提交本地修改并推送到遠(yuǎn)程倉(cāng)庫(kù)
cd my-wiki
git init
git add remote https://github.com/user_name/repository_name
git add .
git commit -m “first commit”
git push origin master
部署你的wiki站點(diǎn)
mkdocs gh-deploy
現(xiàn)在你的wiki站點(diǎn)(HTML文件)在gh-pages分支,你的wiki站點(diǎn)(markdown文件)在master分支。
該命令執(zhí)行了兩個(gè)動(dòng)作:
將Mardown文件轉(zhuǎn)為靜態(tài)HTML網(wǎng)頁(yè)文件
將所有的靜態(tài)HTML網(wǎng)頁(yè)文件都推送到遠(yuǎn)程倉(cāng)庫(kù)的gh-pages分支
GitHub會(huì)自動(dòng)管理gh-pages分支的靜態(tài)網(wǎng)頁(yè),就相當(dāng)于一個(gè)靜態(tài)網(wǎng)站服務(wù)器。
通過以下網(wǎng)址訪問你的wiki
https://user_name.github.io/repository_name
延伸閱讀:
二、wiki是什么
有人認(rèn)為,Wiki系統(tǒng)屬于一種人類知識(shí)網(wǎng)格系統(tǒng),可以在Web的基礎(chǔ)上對(duì)Wiki文本進(jìn)行瀏覽、創(chuàng)建、更改,而且創(chuàng)建、更改、發(fā)布的代價(jià)遠(yuǎn)比HTML文本?。煌瑫r(shí)Wiki系統(tǒng)還支持面向社群的協(xié)作式寫作,為協(xié)作式寫作提供必要幫助;最后,Wiki的寫作者自然構(gòu)成了一個(gè)社群,Wiki系統(tǒng)為這個(gè)社群提供簡(jiǎn)單的交流工具。與其它超文本系統(tǒng)相比,Wiki有使用方便及開放的特點(diǎn),所以Wiki系統(tǒng)可以幫助我們?cè)谝粋€(gè)社群內(nèi)共享某領(lǐng)域的知識(shí)。
WiKi可以調(diào)動(dòng)廣大網(wǎng)民的群體智慧參與網(wǎng)絡(luò)創(chuàng)造和互動(dòng),它是web2.0的一種典型應(yīng)用,是知識(shí)社會(huì)條件下創(chuàng)新2.0的一種典型形式。它也為教師和學(xué)生的知識(shí)共享提供了高效的平臺(tái),實(shí)現(xiàn)了快速?gòu)V泛的信息整合。