跳转至
Follow @Wcowin on
Bilibili and
Twitter

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

Info

Material for MkDocs官方网站：MkDocs

推荐看下这个视频：
How to set up Material for MkDocs by @james-willett –
15m – Learn how to create and host a documentation site using Material for MkDocs on GitHub Pages in a step-by-step guide.

## 一、准备工作

1.下载Github Desktop

2.有一个GitHub账号​​​​​​​(有手就行)

## 二、Creating your site

参考教程：

利用mkdocs部署静态网页至GitHubpages（更新版）

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

然后打开github Desktop 克隆到本地

打开Wcowin.github.io目录进入终端依次运行:

    1
    2

    pip install mkdocs-material
    mkdocs new mkdocs-site

出现下图的几个文件

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

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

执行下面的代码添加一个GitHub Workflow

过时的PublishMySite.yml

(执行下面的代码添加一个GitHub Workflow(已经过时但是仍然能用，最新方法见下方ci.yml)

    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

    mkdir .github
    cd .github
    mkdir workflows
    cd workflows
    vim ci.yml

.github/workflows/ci.yml，然后复制并粘贴以下内容：

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29

    name: ci
    on:
      push:
        branches:
          - master
          - main
    permissions:
      contents: write
    jobs:
      deploy:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v4
          - name: Configure Git Credentials
            run: |
              git config user.name github-actions[bot]
              git config user.email 41898282+github-actions[bot]@users.noreply.github.com
          - uses: actions/setup-python@v4
            with:
              python-version: 3.x
          - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
          - uses: actions/cache@v3
            with:
              key: mkdocs-material-${{ env.cache_id }}
              path: .cache
              restore-keys: |
                mkdocs-material-
          - run: pip install mkdocs-material
          - run: mkdocs gh-deploy --force

目录树状图:

    1
    2
    3
    4
    5
    6
    7
    8
    9

    $ tree -a
    .
    ├── .github
    │   ├── .DS_Store
    │   └── workflows
    │       └── ci.yml
    ├── docs
    │   └── index.md
    └── mkdocs.yml

重点来了

仓库setings/Actions/General 勾选这两项

## 三、配置完善

打开终端运行

`pip install mkdocs-material`

打开mkdocs.yml

把以下的内容输入进去（最简单最基础的配置）

    1
    2
    3
    4
    5

    site_name: 网站名字
    site_url: 网站链接
    site_author: 你的名字
    theme:
      name: material #主题

详细mkdocs.yml配置见Changing the colors - Material for MkDocs

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

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

    1

    mkdocs serve

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

最后去github Desktop上传到github

！！！重点
去仓库的setings/pages选择下图示意的路径

等待一会网址就出来了

你的网站网址就是：​

    1
    2

    https://你github的名字.github.io/
    因为我绑定了域名所以网址是：https://wcowin.work/

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

1. 于2023.3.24重写此文 ↩

2024-07-21
GitHub
此页面有帮助吗？
谢谢你的反馈！
Thanks for your feedback! Help us improve this page by using our feedback form.