如何使用 mkdocs-material 将登陆页面添加到 mkdocs 文档站点？

Question

我正在尝试创建一个类似于 mkdocs-material 的文档网站（https://squidfunk.github.io/mkdocs-material/）的登陆页面。我正在为我的文档网站使用 mkdocs-material。

Answer 1

如何？

您将需要为特定页面（例如主页）使用自定义模板并提供该模板的实现。因此，对于主页，您正在寻找此文件：.overrides/home.html。您需要将其复制到您自己的覆盖目录或将我的示例作为参考。确保您已custom_dir设置mkdocs.yml：

 theme:
   custom_dir: material
 ...

在您的前面index.md，您需要指定要使用的模板：

---
title: Title
template: home.html
---

重要考虑因素

您的 md 文件末尾需要一个换行符。如果没有，则不会显示内容。我想如果您不包含换行符，它会被处理为具有空内容。

参考链接

• https://github.com/squidfunk/mkdocs-material/issues/1996。
• https://github.com/binbahar/le-ref-architecture-doc。