如何在mkdocs.yml文件中设置mkdocs的访问控制,比如需要登录才可以查看内容
时间: 2023-06-09 22:08:37 浏览: 216
SpringBoot .yml
您可以使用mkdocs的第三方插件- mkdocs-simple-plugin。该插件允许您设置基于用户的访问控制权限。您可以按照以下步骤配置该插件:
1. 安装mkdocs-simple-plugin: 在命令行输入 pip install mkdocs-simple-plugin。
2. 在mkdocs.yml文件中添加该插件: 在plugins字段中添加simple。
plugins:
- simple
3. 在插件的配置文件中定义访问控制: 创建一个名为simple_auth的YAML文件,在其中定义您的用户列表和密码。示例:
users:
username1: password1
username2: password2
4. 在需要保护的页面或目录中添加simple_auth关键字。示例:
pages:
- Home: index.md
- About: about.md
- Restricted Page: restricted.md
simple_auth: true
或者对于整个网站:
site_navigation:
- Home: index.md
- About: about.md
- Restricted Folder:
simple_auth: true
- Subpage: subpage.md
这将使访问被保护的页面或目录需要输入用户名和密码。
注意:为了保障用户资料安全,请将simple_auth文件放在您的mkdocs目录之外。
阅读全文