1. 本站建站历程¶

这里记录了本站建站过程中所做的过程或修改，方便后续查阅、分享和交流

1.1 功能感受¶

1.2 本站都使用了哪些功能¶

1.3 图片显示的优化¶

1.3.1 使用 mkdocs-glightbox¶

安装 mkdocs-glightbox 插件

pip install mkdocs-glightbox

配置文件中开启 glightbox

plugins:
   - glightbox

1.3.2 控制图片显示大小¶

默认图片是按照实际尺寸进行显示，当图片比较大时，页面会比较失调，给阅读带来割裂感，所以需要对图片的显示大小进行控制，最大不超过 500px，如果需要看大图时，结合 mkdocs-glightbox 点击放大进行查看

图片显示的最大尺寸是借助 python-markdown 的 markdown.extensions.attr_list 扩展，通过 CSS 达到限定图片大小的效果

示例

![](./images/awesome_mkdocs_snapshot.png){: figcaption=1235 style="max-width:500px;" }

1.4 列表展示优化¶

• 使用 mdx-truly-sane-lists ⧉ 进行列表展示的优化

1.5 集成 Tailwind CSS¶

• https://harminder.dev/projects/websites/mkdocs/knowledge-base/adding-assets/additional-css/tailwind-css/setup-material-mkdocs-insiders-tailwind/ ⧉

1.6 TODO¶

1.7 Awesome 列表¶

这里搜集了 mkdocs 生态的一些插件和主题，可以根据自己需要进行选择

• awesome mkdocs ⧉

1.8 参考¶

• MkDocs 插件列表 ⧉ https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins ⧉
• MkDocs 多个插件作者的博文 https://www.timvink.nl/mkdocs-for-tech-doc/ ⧉
• https://chrieke.medium.com/the-best-mkdocs-plugins-and-customizations-fc820eb19759 ⧉