wiki多个⽂件⼀起导⼊_搭建⾃⼰的wiki知识管理系统
repository文件夹可以删除吗
本⽂⼩编将带⼤家从零开始搭建⼀个属于你⾃⼰的wiki系统。 开源的wiki系统有很多,⽐如:
⼤名⿍⿍的MediaWiki
⼩巧易⽤的DokuWiki
国内开源的minDoc
Gitbook
Docsify
Hexo
MkDocs
⼩编选择使⽤的是MkDocs,因为它部署和使⽤都⾮常的简便,特别适合作为个⼈wiki知识管理系统。简单的说MkDocs就是将Markdown ⽂件转换成静态的HTML⽹站,然后既可以在本地直接访问,也可以托管到服务器或者GitHub。
实战开始
实战开始
1.安装MkDocs
1.1 Ubuntu系统
sudo apt-get install mkdocs
1.2 Windows系统
MkDocs⽬前⽀持Python2.7,3.4,3.6,3.7版本
安装Python(请参考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⽂件
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.
# ⼀级标题
## ⼆级标题
### 三级标题
编辑l⽂件,写⼊以下内容:
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主题
打开配置⽂件l,写⼊以下内容:
theme:
name: 'material'
6.将你的wiki站点托管到GitHub
创建⼀个新仓库。 ⽐如: github/user_name/repository_name
初始化你的本地仓库(wiki), 添加远程仓库,提交本地修改并推送到远程仓库
cd my-wiki
git init
git add remote github/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分⽀。该命令执⾏了两个动作:
1. 将Mardown⽂件转为静态HTML⽹页⽂件
2. 将所有的静态HTML⽹页⽂件都推送到远程仓库的gh-pages分⽀
GitHub会⾃动管理gh-pages分⽀的静态⽹页,就相当于⼀个静态⽹站服务器。
通过以下⽹址访问你的wiki
user_name.github.io/repository_name
扫码关注“边缘智能实验室”,获取更多精彩资讯!

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。