From 43986640abf0d4e8dfa9a07eb91a15c07c37e1f1 Mon Sep 17 00:00:00 2001 From: Zuoling Rong Date: Fri, 9 May 2025 12:16:45 +0800 Subject: [PATCH] =?UTF-8?q?docs(readme):=20=E5=AE=8C=E5=96=84=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 15 +++++++++++++-- bookmarks/README.md | 2 ++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7a330c..4413284 100644 --- a/README.md +++ b/README.md @@ -204,13 +204,22 @@ npm install - 可以参考`config/_default/`目录结构和内容 - 自定义站点标题、描述、导航链接和网站分类等 -4. 本地预览 +4. 导入书签(可选) + - 将浏览器导出的HTML格式书签文件放入`bookmarks`目录 + - 运行书签处理命令: + ```bash + npm run import-bookmarks + ``` + - 系统会自动将书签转换为配置文件保存到`config/user/pages/bookmarks.yml` + - **注意**:`npm run dev`命令不会自动处理书签文件,必须先手动运行上述命令 + +5. 本地预览 ```bash # 启动开发服务器 npm run dev ``` -5. 构建静态网站 +6. 构建静态网站 ```bash # 生成静态HTML文件 npm run build @@ -585,6 +594,8 @@ MeNav支持从浏览器导入书签,快速批量添加网站链接,无需手 > **🔔 重要提示**:系统只会处理位于文件夹内的书签,直接放在收藏夹根目录中的书签不会被导入。请确保您要导入的书签都放在文件夹中,每个文件夹将成为导航中的一个分类。 +> **⚠️ 开发模式说明**:在本地开发中,`npm run dev` 命令**不会**自动处理书签文件。您必须先手动运行 `npm run import-bookmarks` 命令处理书签,然后再运行 `npm run dev` 或 `npm run build` 查看效果。这与 GitHub Actions 中的自动处理流程不同,请务必注意。 + ### 配置加载优先级 书签配置按以下优先级加载(从高到低): diff --git a/bookmarks/README.md b/bookmarks/README.md index cabeb83..2e1ced3 100644 --- a/bookmarks/README.md +++ b/bookmarks/README.md @@ -42,6 +42,8 @@ npm run build ``` +> **重要说明**:在本地开发中,`npm run dev` 命令**不会**自动处理书签文件。您必须先手动运行 `npm run import-bookmarks` 命令处理书签,然后再运行 `npm run dev` 查看效果。这与 GitHub Actions 中的自动处理流程不同,请务必注意。 + ## 支持的浏览器 MeNav 书签导入功能支持从以下浏览器导出的书签文件: