docs: 更新readme文档

This commit is contained in:
rbetree
2025-11-09 18:36:53 +08:00
parent 3ae40b23d5
commit c27464c452
4 changed files with 123 additions and 227 deletions

View File

@@ -7,7 +7,6 @@
- [配置加载机制](#配置加载机制)
- [模块化配置文件](#模块化配置文件)
- [网站基础配置](#网站基础配置)
- [导航配置](#导航配置)
- [页面配置](#页面配置)
- [配置优先级](#配置优先级)
- [配置示例](#配置示例)
@@ -24,8 +23,7 @@
```
config/
├── _default/ # 默认配置目录
│ ├── site.yml # 默认网站基础配置
│ ├── navigation.yml # 默认导航配置
│ ├── site.yml # 默认网站基础配置(含导航配置)
│ └── pages/ # 默认页面配置
│ ├── home.yml # 首页默认配置
│ ├── projects.yml
@@ -33,8 +31,7 @@ config/
│ ├── friends.yml
│ └── bookmarks.yml
└── user/ # 用户配置目录(覆盖默认配置)
├── site.yml # 用户自定义网站配置
├── navigation.yml # 用户自定义导航配置
├── site.yml # 用户自定义网站配置(含导航配置)
└── pages/ # 用户自定义页面配置
├── home.yml # 首页用户配置
└── ...
@@ -62,15 +59,9 @@ MeNav 配置系统使用深度合并机制,按以下顺序加载和合并配
- 字体配置和主题设置
- 全局元数据和站点参数
- 个人资料和社交媒体链接
- 导航菜单配置(侧边栏导航项、页面标题和图标、页面顺序和可见性)
### 导航配置
`navigation.yml` 定义网站的导航结构:
- 侧边栏导航项
- 页面标题和图标
- 页面顺序和可见性
- 外部链接配置
> **注意**:从 v1.x 版本开始,导航配置已合并到 `site.yml` 文件中,不再使用独立的 `navigation.yml` 文件。如果您从旧版本迁移,请将原 `navigation.yml` 的内容移至 `site.yml` 的 `navigation` 字段下。
### 页面配置
@@ -88,11 +79,9 @@ MeNav 配置系统使用深度合并机制,按以下顺序加载和合并配
配置项的优先级从高到低为:
1. 用户页面配置 (`user/pages/*.yml`)
2. 用户导航配置 (`user/navigation.yml`)
3. 用户网站配置 (`user/site.yml`)
4. 默认页面配置 (`_default/pages/*.yml`)
5. 默认导航配置 (`_default/navigation.yml`)
6. 默认网站配置 (`_default/site.yml`)
2. 用户网站配置 (`user/site.yml`)
3. 默认页面配置 (`_default/pages/*.yml`)
4. 默认网站配置 (`_default/site.yml`)
## 配置示例
@@ -128,6 +117,19 @@ social:
- name: "Twitter"
url: "https://twitter.com/username"
icon: "fab fa-twitter"
# 导航配置
navigation:
- name: "首页"
icon: "fas fa-home"
id: "home"
active: true
- name: "项目"
icon: "fas fa-project-diagram"
id: "projects"
- name: "文章"
icon: "fas fa-book"
id: "articles"
```
### 首页配置示例 (home.yml)