使用Mkdocs for material搭建Note型博客

备料

计划搭建一个使用个人域名的note型博客,托管在Github Page上,因此只需要准备

  • Github仓库
  • 个人域名

部署步骤

1. 创建新的Github仓库

一个用于存放博客和自动部署的Github仓库,命名为<username>.github.io

2. 本地安装mkdocs for material

使用pip包管理器安装mkdocs-material,如果没有安装python则需要先安装python

1
pip install mkdocs-material

然后将刚才创建的github仓库clone到本地,新建站点,仓库里原有的多余文件可以删掉

1
mkdocs new .

然后打开mkdocs.yml,加入thmem的配置

1
2
theme:
  name: material

最后在本地启动预览,可以查看效果

1
mkdocs serve

3. 配置github actions工作流

在刚才的仓库中,新建文件.github/workflows/ci.yml,内容为mkdocs material官网提供的CI配置,抄上去之后commit并push
来到github仓库页面,Action处发现ci已经在执行了

ci执行结束后可以看到code中出现了新的分支gh-pages,这就是生成好的页面,可以进行发布
![[../../../../attachments/Pasted image 20231007143950.png|../../../../attachments/Pasted image 20231007143950.png]]

4. 配置github pages和DNS解析

在仓库上方的Setting中可以找到Pages的配置选项,这里选择从分支部署,然后选择gh-pages分支即可
![[../../../../attachments/Pasted image 20231007145016.png|../../../../attachments/Pasted image 20231007145016.png]]
如果需要配置自定义域名,就在下面输入一下自定义域名
![[../../../../attachments/Pasted image 20231007145028.png|../../../../attachments/Pasted image 20231007145028.png]]
然后按照官方文档提示,去DNS服务商,添加一条指向<username>.github.ioCNAME记录。等待DNS扩散后,就可以通过配置的域名访问了
![[../../../../attachments/Pasted image 20231007145343.png|../../../../attachments/Pasted image 20231007145343.png]]

Licensed under CC BY-NC-SA 4.0
最后更新于 2024.10.28 07:19 UTC+8
多看 多学 多做
Built with Hugo
主题 StackJimmy 设计