跳转至

利用mkdocs部署静态网页至GitHub pages

Info

官方网站：MkDocs

我的个人网站成果：http://wcowin.work/

一、准备工作

1.下载Github Desktop

2.有一个GitHub账号​​​​​​​

二、Creating your site

参考教程：

网站制作 - Wcowin的个人网站

与其他教程不同，我首先建议先在Github创建一个名为你的名字+github.io的仓库 img img

然后打开github Desktop 克隆到本地 img img img img 打开Wcowin.github.io目录进入终端运行: 

1
mkdocs new mkdocs-site
出现下图的几个文件 img

docs文件下是以后网站的内容，mkdocs.yml是配置文件（配置主题，目录，插件等）

你在这个目录下写的任何东西都可以通过github Desktop 上传到github上

以VScode为例我们打开具体看看里面的东西

(建议先执行下面的代码添加一个GitHub Workflow) 

1
2
3
4
5
$ mkdir .github
$ cd .github
$ mkdir workflows
$ cd workflows
$ vim PublishMySite.yml

在PublishMySite.yml里面输入以下内容 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
name: publish site
on: # 在什么时候触发工作流
  push: # 在从本地main分支被push到GitHub仓库时
    branches:
      - main
  pull_request: # 在main分支合并别人提的pr时
    branches:
      - main
jobs: # 工作流的具体内容
  deploy:
    runs-on: ubuntu-latest # 创建一个新的云端虚拟机 使用最新Ubuntu系统
    steps:
      - uses: actions/checkout@v2 # 先checkout到main分支
      - uses: actions/setup-python@v2 # 再安装Python3和相关环境
        with:
          python-version: 3.x
      - run: pip install mkdocs-material # 使用pip包管理工具安装mkdocs-material
      - run: mkdocs gh-deploy --force # 使用mkdocs-material部署gh-pages分支

目录树状图: 

1
2
3
4
5
6
7
8
9
$ tree -a
.
├── .github
│   ├── .DS_Store
│   └── workflows
│       └── PublishMySite.yml
├── docs
│   └── index.md
└── mkdocs.yml

三、配置完善

打开mkdocs.yml

把以下的内容输入进去（最简单配置） site_name: 网站名字 site_url: site_author: 你的名字 theme: name: material #主题 详细mkdocs.yml配置见Changing the colors - Material for MkDocs

下次我会具体谈谈这个问题

在下方终端运行可以在浏览器看到实时网站 

1
mkdocs serve
img img

这个网站就算是初步建好了

最后去github Desktop上传到github img

你的网站网址就是：​

1
https://你github的名字.github.io/
img

下次谈谈网站的mkdocs.yml具体配置

  1. 于2023.3.24重写此文 ↩