基于Mkdocs搭建个人wiki
1.关于环境
基于python3.10 创建的虚拟环境,升级最新版本的pip工具
2.关于mkdocs
mkdocs的部署以及使用非常方便,mkdocs将markdown文档全部转换成HTML网站
可以部署到服务器或者github
3.安装Mkdocs
pip install mkdocs
安装 & 配置主题
pip install mkdocs-material
theme:
name: 'material'
4.创建项目
mkdocs new my-wiki
cd my-wiki
预览项目,首先进入my-wiki文件夹下,运行mkdocs serve 命令
cd my-wiki
mkdocs serve
5. 页面布局
导航栏支持多级布局
https://mkdocs-like-code.readthedocs.io/zh_CN/latest/MkDocs-advanced-operations/files-layout/
nav:
- Home: index.md
- User Guide:
- num_1: 1.md
- num_2: 2.md
- About:
- xx: 3.md
- xxx: 4.md
nav:
- Home: index.md
- Dev_documents:
- Dev_documents/about_git/git.md
- Dev_documents/request_process/网络请求流程.md
6. 部署wiki到github
-
在github创建自己的仓库
-
在本地做完相应的git操作之后push到远程仓库
git push origin master -
进入
my-wiki文件夹,进行部署mkdocs gh-deploy

浙公网安备 33010602011771号