一、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的一种典型形式。它也为教师和学生的知识共享提供了高效的平台,实现了快速广泛的信息整合。