问题描述
我正在尝试创建一个类似于mkdocs-material的doc网站(https://squidfunk.github.io/mkdocs-material/)的登录页面。我在我的文档站点上使用了mkdocs-material。
解决方法
那么您可以在其存储库中找到该站点的源代码/设置。 https://github.com/squidfunk/mkdocs-material 这应该是一个很好的例子。
,怎么样?
您需要为特定页面(例如主页)使用自定义模板并提供此模板的实现。因此,对于主页,您要查找此文件:overrides/home.html。您需要将其复制到您自己的覆盖目录或采用 my example as reference。确保您已设置 custom_dir
in mkdocs.yml
:
theme:
custom_dir: material
...
在 index.md
的前面,您需要指定要使用的模板:
---
title: Title
template: home.html
---
重要注意事项
您需要在您的 md 文件末尾换行。如果您没有,则不会显示内容。如果不包含换行符,我想它会被处理为具有空内容。