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