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

Question

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

Answer 1

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

Answer 2

多么?

您需要为特定页面(例如主页)使用自定义模板，并提供此模板的实现。因此，对于主页，您需要查找以下文件：overrides/home.html。您可能希望将其复制到您自己的覆盖目录中，或者使用my example as reference。确保您已经设置了custom_dir in 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