MkDocs - 部署WiKi站点到Github Pages#

往期回顾：

第一期：MkDocs - 初识

本期小编将带你了解如何将你的WiKi部署到Web服务器，使你的WiKi能够在互联网中被访问。

本期我们选择的Web服务器是Github Pages。

1.创建一个新的Github远程仓库#

熟悉Github使用的同学可以跳过本节，请自行创建一个Github远程仓库备用。

没有Github账号的同学，请先到Github官网申请。

点击进入Github官网

登录后选择右上角的新建仓库。

然后按照提示填写仓库名称等。仓库创建成后，你将看到如下界面：

获取远程仓库地址备用。

2.本地WiKi站点配置#

熟悉Git使用的同学可跳过本节，请自行将Wiki站点my-project文件夹初始化为本地Git仓库。

首先进入我们之前创建的WiKi项目文件夹my-project，将其初始化为一个本地Git仓库

cd my-project
git init

本地Git仓库初始化成功后，看上去就像这样：

mkdocs_site

在本地仓库中添加远程仓库链接

git add remote https://github.com/user_name/repository_name

将WiKi站点的源文件（Markdown文件）推送到远程仓库是可选的，因为部署你的WiKi网站只需要将HTML网页文件推送到远端即可。

git add .
git commit -m "first commit"
git push origin master

3. 部署到Github Pages#

将你的WiKi站点部署到GitHub

mkdocs gh-deploy

该命令执行的动作：

  1. 创建gh-pages分支，并切换到gh-pages分支；

  2. 执行mkdocs build指令，将Markdown文件转换成HTML静态网页；

  3. 将HTML静态网页推送到远端gh-pages分支；

  4. 推送完成，切换回master分支。

完成部署之后，你的WiKi网站的HTML文件都部署在了gh-pages分支；markdown文件都部署在了master分支（假如你提交了的话）

这是master分支:

git_master_branch

这是gh-pages分支:

git_gh-pages_branch

现在使用类似下面的URL，就可以在互联网中访问你的Wiki站点了。

https://user_name.github.io/repository_name/

4.在线Demo#

在线Demo地址：https://edgeai-lab.github.io/my-project

在线Demo源码：https://github.com/EdgeAI-Lab/my-project

更多精彩资讯，请扫码关注！

weixingongzhonghao