Frontmatter Cheatsheet 📜
本页详细整理了文档中常用的 Frontmatter配置项 和 自定义配置项，提供详细的解释说明以及使用方法，帮助在实际应用中灵活配置
常规Frontmatter配置项
| 配置项 | 说明 |
|---|---|
title | 页面标题 |
description | 页面描述 |
lastUpdated | 最后更新时间 |
meta | 自定义数据，可包含多种数据内容组合 |
示例:
yaml
---
title: 我的文档标题
description: 这是页面的简要描述
lastUpdated: 2025-02-20
meta:
- name: 文档名称
content: 关于内容简介
---自定义配置项
requiredRoles
若需限制特定页面的访问权限，可使用requiredRoles配置项对不同用户群体进行权限管理。添加该配置项后，只有具备指定角色的用户才能访问对应页面，未满足条件的用户将无法查看页面内容。
角色说明
| 角色名称 | 说明 |
|---|---|
MANAGER | 管理员，拥有网站最高权限 |
BASIC | 普通用户，仅可访问基础内容 |
使用示例
yaml
---
title: 管理员文档
requiredRoles: ["MANAGER"]
---在requiredRoles配置项中列出所有允许访问该文档的用户角色，系统将根据当前用户的角色进行匹配，用户仅需满足其中任意一个角色要求，即可访问该页面。
passwordKey
在文档需要密码保护时，可使用passwordKey配置项设置当前markdown文章的密码密钥，以保护文档内容。用户访问受保护页面时，需输入正确的密码密钥才能查看文档内容。
使用示例
在frontmatter中添加passwordKey配置项，设置当前文档的密码密钥，如下所示：
yaml
---
title: 文件名字
passwordKey: passwordKey
lastUpdated: 2025-02-23
---在文件中配合PasswordReveal组件使用，包围住需要密码保护的范围，如下所示：
markdown
<PasswordReveal>
<!-- 此处为受保护内容 -->
密码保护内容
</PasswordReveal>