docs: 更新重构各readme文件

This commit is contained in:
rbetree
2025-12-22 01:45:58 +08:00
parent 47e4369b09
commit 2daba411ba
4 changed files with 150 additions and 359 deletions

View File

@@ -3,8 +3,11 @@
## 目录
- [目录概述](#目录概述)
- [功能说明](#功能说明)
- [书签导入功能](#书签导入功能)
- [配置加载优先级(完全替换)](#配置加载优先级完全替换)
- [MarksVault 扩展集成](#marksvault-扩展集成)
- [书签导入流程](#书签导入流程)
- [确定性输出](#确定性输出)
- [支持的浏览器](#支持的浏览器)
- [书签格式要求](#书签格式要求)
- [文件处理机制](#文件处理机制)
@@ -13,7 +16,7 @@
`bookmarks` 目录是 MeNav 项目中用于存放浏览器导出的书签文件的专用目录。该目录与书签导入功能直接关联,用于自动将浏览器书签转换为 MeNav 配置文件,从而快速生成个人导航站点。
## 功能说明
## 书签导入功能
书签导入功能允许用户:
@@ -24,6 +27,23 @@
这一功能极大简化了网站内容的初始设置过程,特别适合需要迁移大量书签的用户。
## 配置加载优先级(完全替换)
书签页配置遵循项目的“完全替换”策略:系统只会使用找到的最高优先级配置,不会把默认配置与用户配置合并。
优先级(高 → 低):
1. `config/user/pages/bookmarks.yml`(用户配置,通常由导入脚本生成)
2. `config/_default/pages/bookmarks.yml`(默认配置)
## MarksVault 扩展集成
[MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展可与 MeNav 集成,实现书签自动同步:
- **一键推送书签**:扩展将书签 HTML 文件推送到仓库的 `bookmarks/` 目录
- **自动化处理**GitHub Actions 检测到书签文件后自动运行导入脚本生成配置
- **自动清理**:处理完成后会删除已导入的 HTML 文件,避免重复处理
## 书签导入流程
完整的书签导入流程如下:
@@ -34,6 +54,10 @@
```bash
npm run import-bookmarks
```
(可选)若希望生成结果保持确定性(便于版本管理,减少时间戳导致的无意义 diff
```bash
MENAV_BOOKMARKS_DETERMINISTIC=1 npm run import-bookmarks
```
4. 系统自动解析书签文件内容
5. 根据书签文件夹结构生成分类
6. 生成配置文件保存到 `config/user/pages/bookmarks.yml`
@@ -44,6 +68,16 @@
> **重要说明**:在本地开发中,`npm run dev` 命令**不会**自动处理书签文件。您必须先手动运行 `npm run import-bookmarks` 命令处理书签,然后再运行 `npm run dev` 查看效果。这与 GitHub Actions 中的自动处理流程不同,请务必注意。
## 确定性输出
默认情况下,导入脚本会在生成的 `bookmarks.yml` 顶部写入时间戳注释,导致每次导入都会产生 diff。
若你希望生成结果尽量稳定(只有书签内容变化才产生 diff可使用环境变量开启确定性输出
```bash
MENAV_BOOKMARKS_DETERMINISTIC=1 npm run import-bookmarks
```
## 支持的浏览器
MeNav 书签导入功能支持从以下浏览器导出的书签文件:
@@ -89,10 +123,11 @@ MeNav 书签导入功能支持从以下浏览器导出的书签文件:
4. **图标分配**
- 根据URL自动匹配合适的 Font Awesome 图标
- 为每个链接和分类分配图标
- 当 `icons.mode: favicon` 时,页面通常会优先显示站点 favicon配置里的 `icon` 主要用于回退显示或在 `icons.mode: manual` 时使用(详见 `config/README.md`
5. **配置生成**
- 创建符合 MeNav 配置格式的 YAML 文件
- 按层级组织分类和链接
- 应用自动生成的元数据
将书签放入此目录后,您可以立即利用 MeNav 的书签处理功能,快速将书签转化为个性化导航站点。
将书签放入此目录后,您可以立即利用 MeNav 的书签处理功能,快速将书签转化为个性化导航站点。