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

Question

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

Answer 1

如何？

您需要为特定页面(例如主页)使用自定义模板并提供此模板的实现。因此，对于主页，您正在寻找此文件: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