跳转至

博客

使用MkDocs+GithubPage 搭建个人博客

使用 MkDocs 的原因是 语雀没有会员的话,即使是(设置过的)互联网访问的文库,新创建的文档他人也无法打开链接,想来还是重新回转到博客了

1. 参考

  • ref1: https://wcowin.work/blog/Mkdocs/mkdocs1.html

  • ref2: https://www.cnblogs.com/chinjinyu/p/17610438.html

  • 配置文件
  • https://zhuanlan.zhihu.com/p/688322635

2. 具体操作

具体操作参考 ref1中的步骤,有几个坑需要注意: 1. 我之前使用过GithuaPage,我没有删除旧项目,而是保留了.git 文件夹,清除了其文件,此时,我的主要分支是 master, 因此 ci.yml 中需要对于的修改:

YAML
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
name: ci 
on: # 在什么时候触发工作流
  push: # 在从本地master分支被push到GitHub仓库时
    branches:
      - master
      - main
  pull_request: # 在master分支合并别人提的pr时
    branches:
      - master
      - main
jobs: # 工作流的具体内容
  deploy:
    runs-on: ubuntu-latest # 创建一个新的云端虚拟机 使用最新Ubuntu系统
    steps:
      - uses: actions/checkout@v4 # 先checkout到main分支
      - uses: actions/setup-python@v4 # 再安装Python3和相关环境
        with:
          python-version: 3.x
      - run: pip install mkdocs-material # 使用pip包管理工具安装mkdocs-material
      - run: mkdocs gh-deploy --force # 使用mkdocs-material部署gh-pages分支
  1. 使用 blog 插件,配置 authors 信息时,自23-08之后,.authors.yml 文件路径修改了,默认路径是在 docs 文件夹下:
YAML
1
2
3
4
5
authors:
  biolxy:
    name: biolxy    # Author name
    description: 生物信息工程师 # Author description
    avatar: https://gravatar.com/avatar/d63d3425433de59d2c3e901977a581c7?size=256&cache=1715411947733

搭建记录

  1. 在github账号下创建 biolxy.github.io
  2. git clone 该项目到本地
  3. git clone 作者博客到本地,填补博客必要的样式文件,删除_post文件夹下文件,保留一个做模板,命名最好为全英文字符
    Bash
    1
    2
    git clone https://github.com/Gaohaoyang/gaohaoyang.github.io.git 
    mv gaohaoyang.github.io/* biolxy.github.io
    
  4. 修改如下等文件替换为自己的信息
    CNAME _config.yml favicon.ico index.html page/3collections.md age/4about.md
  5. 该主题更详细的信息需要去该主题作者的github查看地址
  6. push到github,打开 https://biolxy.github.io/ 即可看到效果
  7. 当然你也可以
  8. 先参考主题作者的博客地址,先 安装 ruby 和 jekyll 环境 ,博客里讲的都有,我就不赘述了
  9. 切换到biolxy.github.io 文件夹下,注意不是_post 文件夹
  10. 执行 jekyll s
  11. 此时打开浏览器,输入http://127.0.0.1:4000/ ,你就可以在本地预览到上传github后的效果了
  12. 为了上传图片, 你需要注册七牛云,建立空间,做图床(我写的简单,你操作的时候不懂的就百度)
  13. 七牛云账户可以绑定MPic软件,绑定后可以方便的上传图片及插入图片链接。

更新

  • 七牛云不能用了,原来部分图床可能挂掉了 解决办法:
  • blog可以先发布在CSDN上,github上的图片直接连接CSDN的博客中的图片地址(为了扩大影响,都是一文多平台发布)