一些此网站搭建时的笔记ヾ(•ω•`)o

MkDocs 部署到Githubヾ(•ω•`)o

参考：

• Publishing your site - Material for MkDocs
• Mkdocs+Material+GithubPage+Github Action自动化搭建你自己的博客！_mkdocs material-CSDN博客

核心是 gh-deploy 文件必须在GitHub page 的指向根（/root）目录

简单来说，直接使用 mkdocs gh-deploy 命令将站点部署到 GitHub 上，并不能直接通过 https://<用户名>.github.io 访问你的页面。原因如下：

1. GitHub Pages 的默认规则 ：

GitHub Pages 通常从仓库的 master 或 main 分支（或特定分支的 /docs 文件夹）构建网站内容。 2. mkdocs gh-deploy 的行为 ：

当你使用 mkdocs gh-deploy 命令时，MkDocs 会自动把生成的静态文件上传到线上仓库的 gh-pages 分支，而不是 master 或 main 分支。

但是 GitHub Pages 默认不会从 gh-pages 分支构建，除非你手动指定。

因此，如果你想通过 https://<用户名>.github.io 直接访问部署的页面，你还需要额外步骤：

• 手动同步本地仓库到 GitHub 的默认分支 （比如 master 或 main）。
• 或者在 GitHub 仓库的设置中，指定 gh-pages 分支作为 GitHub Pages 的发布分支，在本地命令窗口使用 <mkdocsgh-deploy命令自动构建并上传 gh-deploy 分支。

GitHub Page 部署 - Actionsヾ(•ω•`)o

Publishing your site - Material for MkDocs

需要在run:pip 中增加命令行以满足自己的依赖需求

关于 GitHub Pages 每次推送到 gh-pages 时都会重置自定义域进行部署ヾ(•ω•`)o

1. 创建 CNAME 文件 :在项目根目录下，找到或创建一个名为 CNAME 的文件（没有扩展名）。
2. 编辑 CNAME 文件 :打开 CNAME 文件，并在其中输入你希望绑定的自定义域名，例如 www.yourdomain.com。
3. 移动 CNAME 文件 :将 CNAME 文件移动到你的静态文件夹中，通常是 docs 或 static 文件夹，具体取决于你的项目结构。

重写覆盖页面：ヾ(•ω•`)o

Customization - Material for MkDocs

原生内置图标ヾ(•ω•`)o

如果要在文章list链接里显示图标，可以在开头增加：

---
icon: material/microphone-message
---

详情请参考：Icons, Emojis - Material for MkDocs 或在“maertial/“替换其它图标名：Material Design Icons - Icon Library - Pictogrammers

路径通常可以改为：octicons/logo-github-16的形式，第一个分隔符前为icon的提供平台

常用 Admonitions 类型ヾ(•ω•`)o

mkdocs.yml中加入：

markdown_extensions:

• admonition #提供!!!标记支持
• pymdownx.details #提供???展开功能支持

以下是 Material for MkDocs 主题中默认支持的标记类型及用途：

评论