docs(readme): 优化文档

This commit is contained in:
rbetree
2025-05-16 16:49:12 +08:00
committed by Zuoling Rong
parent 2c2dfbd8a2
commit b7edd1dcbf

View File

@@ -50,8 +50,7 @@
- [配置详解](#配置详解)
- [书签导入](#书签导入功能)
- [常见问题](#常见问题)
- [贡献指南](#贡献指南)
- [许可证](#许可证)
- [Star-History](#Star-History)
## 快速预览
@@ -637,6 +636,14 @@ MeNav支持从浏览器导入书签快速批量添加网站链接无需手
### 导入步骤详解
#### 使用 MarksVault 浏览器扩展(推荐)
- 安装 [MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展
- 在浏览器中登录并授权
- 使用扩展任务页中新建任务,将书签推送到您的 MeNav 项目
- 系统将自动处理并部署更新后的导航站
#### 手动导入
<details>
<summary>点击展开</summary>
@@ -661,12 +668,6 @@ MeNav支持从浏览器导入书签快速批量添加网站链接无需手
- 保存为HTML文件
2. **导入书签到MeNav**
**使用 MarksVault 浏览器扩展(推荐)**:
- 安装 [MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展
- 在浏览器中登录并授权
- 使用扩展任务页中新建任务,将书签推送到您的 MeNav 项目
- 系统将自动处理并部署更新后的导航站
**GitHub Pages方式**:
- Fork本仓库后在您的仓库中创建`bookmarks`目录
@@ -679,14 +680,6 @@ MeNav支持从浏览器导入书签快速批量添加网站链接无需手
- 运行`npm run import-bookmarks`命令处理书签文件
- 系统生成配置文件后即可使用`npm run dev`预览
3. **处理结果**
处理完成后:
- 书签分类会变成网站分类
- 书签文件夹结构会被保留
- 系统自动尝试匹配网站图标
- 生成的配置可在`config/user/pages/bookmarks.yml`中查看和编辑
### 书签导入注意事项
- 仅支持标准HTML格式的书签文件大多数浏览器导出格式
@@ -695,6 +688,8 @@ MeNav支持从浏览器导入书签快速批量添加网站链接无需手
- 处理完成后,原始书签文件会被自动删除,以防止重复处理
</details>
> 生成的配置可在`config/user/pages/bookmarks.yml`中查看和编辑
## 常见问题
<details>
@@ -766,21 +761,8 @@ MarksVault浏览器扩展与MeNav的集成相当简单
- 配置目标仓库填写您的用户名和fork的MeNav仓库名
- 确认bookmarks文件夹路径默认即可
3. 使用扩展的任务功能,自动推送书签到项目
</details>
## 贡献指南
## Star-History
欢迎通过 Issues 或 Pull Requests 的形式做出贡献。如果您有好的想法或发现了问题,请随时提出。
## 许可证
[![AGPL-3.0 License](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.html)
MeNav 基于 GNU Affero General Public License v3.0 (AGPL-3.0) 开源许可证发布。
主要条款:
- 允许商业使用、修改、分发、专利使用和私人使用
- 不提供任何担保
- 修改后的代码必须使用相同许可证
- 网络使用也视为分发,必须开源
在使用本项目时请确保遵守AGPL-3.0协议的所有条款。完整许可证文本可在[LICENSE](LICENSE)文件中查看。
[![Star History Chart](https://api.star-history.com/svg?repos=rbetree/menav&type=Date)](https://www.star-history.com/#rbetree/menav&Date)