Skip to content

title: 侧边栏配置 description: 一份任务驱动的实用指南,教您如何高效地配置和管理 CrychicDoc 的侧边栏。 priority: 20 hidden: false ​

侧边栏配置实用指南 ​

本指南将通过一系列常见的任务,带您了解如何配置和管理 CrychicDoc 的侧边栏。

核心理念:Frontmatter 驱动配置 ​

CrychicDoc 的侧边栏系统通过读取您在 Markdown 文件中设置的 frontmatter 来自动生成配置。您只需要在文档中声明元数据(如 title, priority),然后运行一个脚本,侧边栏就会自动更新。

核心配置字段 ​

为了有效地管理侧边栏,您需要了解以下几个关键的 frontmatter 字段。

字段 类型 描述
root boolean 将一个目录的 index.md 标记为侧边栏的新根节点。
title string 必需。侧边栏中显示的标题。
priority number 必需。排序权重,数字越小,越靠前。
hidden boolean 如果为 true,则此页面或目录不会显示在侧边栏中。
externalLinks object[] 在 root 节点中添加指向外部网站的链接。

实践教程:配置一个新文档区 ​

高级技巧与提示 ​

在根目录 AwesomeMod/index.md 的 frontmatter 中添加 externalLinks。

yaml
---
root: true
title: "AwesomeMod 指南"
# ... 其他配置 ...
externalLinks:
  - text: "官方 Wiki"
    link: "https://awesomemod.com/wiki"
    priority: -999 # 使用负数让链接靠前显示
  - text: "GitHub 仓库"
    link: "https://github.com/user/awesomemod"
    priority: -1000
---

使用 itemOrder 隐式设置优先级 ​