Skip to content

dothinking/dothinking.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

格致:基于MkDocs搭建的个人博客

  • 采用Markdown语法编辑文章

  • 支持Latex公式(MathJex)

  • 按分类/年份归档文章

  • 自动部署到Github Page

使用

  • 修改mkdocs.ymlabout.md定义博客信息

  • 修改extra.css自定义样式(可选,覆盖mkdocs主题默认样式)

  • docs文件夹下创建文章

    • 为便于自动按年份归档,文件名格式yyyy-mm-dd-title.md

    • 为便于自动分类文章,提供元信息categories

    • 文章基本结构(元信息、标题为可选项)

        ---
        categories: [foo, bar, ...]
        tags: [this, that, ...]
        ---
      
        # title
      
        ---
      
        markdown-content
      
        ...
      
  • 提交更新到远程master分支,触发Github Action自动构建和部署

    • 创建主页(如果docs下不存在index.md
    • 根据docs下文件名生成按年份归档页面
    • 根据文章元信息categories生成分类页面
    • 构建博客内容并上传到远程gh-pages分支

本地调试

安装Python及以下第三方库

$ pip install mkdocs
$ pip install pymdown-extensions

执行make命令:

  • 调试模式(等效为创建归档/分类页面后执行mkdocs serve

      $ make serve
    

    通过浏览器访问127.0.0.1:8000

  • 构建静态页面(等效为创建归档/分类页面后执行mkdocs build

      $ make build