如何使用mkdocs材料将登录页添加到mkdocs文档网站

Question

我正在尝试创建一个类似于mkdocs材料文档网站的登录页(https://squidfunk.github.io/mkdocs-material/)有。我正在为我的文档网站使用mkdocs材料。

Answer 1

如何

您需要为特定页面(例如主页(使用自定义模板，并提供此模板的实现。因此，对于您正在查找的主页文件：.overrides/home.html。您需要将其复制到自己的overrides目录中，或者以我的示例为参考。确保已将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/binbashar/le-ref-architecture-doc.

Answer 2

您可以在其存储库中找到该站点的源代码/设置。https://github.com/squidfunk/mkdocs-material这应该是一个很好的例子。