Skip to content
/ mkdocs-template Public template

MKDocs模板,使用了Material for MkDocs主题,包含评论系统、博客、深色亮色模式切换、支持Jupyter笔记文件

Notifications You must be signed in to change notification settings

LogDancer/mkdocs-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs 模板

这是一个 MkDocs 模板,可以快速搭建并部署个人博客网页到 GitHub Pages。

  • Material 主题 (安装了 Material for MkDocs

  • 支持 Jupyter 笔记 (安装了 mkdocs-jupyter

  • 评论系统(根据 Material 教程搭建)

  • 博客(根据 Material 教程搭建)

  • 亮色/深色/跟随系统 模式切换(根据 Material 教程搭建)

  • 个人认为比较好看的样式添加及调整(根据 Material 教程搭建)

  • 使 Jupyter 中的输出部分支持折叠、复制、滚动

    • 折叠可以双击文字,或者单击右上角的折叠按钮
    • 展开可以单击提示文字,或者单击右上角的折叠按钮
    • 复制可以单击右上角的复制按钮

    jupyter_custom_button

评论系统

官方教程: 添加评论系统

comments.html 跳转

如果不需要为博客中的帖子添加评论系统,可以直接删除overrides/partials/comments.html文件。

如果需要为博客中的帖子添加评论系统,请将从 giscus 中复制的包含配置信息的 script 标签 粘贴到 overrides/partials/comments.html 中的提示位置

博客

官方教程: [设置博客(https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/)]

这里不再赘述,具体查看官方教程即可。

下方仅列出本模板中需要改动的部分。

1. 作者信息

跳转至 docs/blog/.authors.yml

2. 模板帖

跳转至 docs/blog/posts/hello_world.md

About

MKDocs模板,使用了Material for MkDocs主题,包含评论系统、博客、深色亮色模式切换、支持Jupyter笔记文件

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published