feat: 更新readme

This commit is contained in:
rbetree
2025-12-23 03:03:12 +08:00
parent ed435b3381
commit 7fb4db06b9

200
README.md
View File

@@ -1,10 +1,8 @@
<div align="center">
<img src="assets/menav.svg" alt="MeNav" width="120">
<h1>MeNav - 个人导航站</h1>
<h1>MeNav</h1>
<p>
一个轻量级、高度可定制的个人导航网站
<br />
<i>⚡ 一键部署 自动化构建</i>
一个轻量的个人导航网站
</p>
</div>
@@ -18,68 +16,74 @@
> MeNav 是一个轻量级、高度可定制的个人导航网站生成器,让您轻松创建属于自己的导航主页。无需数据库和后端服务,完全静态部署,支持一键 Fork 部署到 GitHub Pages还可以从浏览器书签一键导入网站。配合 [MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展,更支持书签自动同步和导航站自动更新。
如果觉得项目有用,欢迎Star/Fork支持谢谢
如果觉得项目有用,欢迎 Star/Fork 支持,谢谢!
[直接开始部署>>](#部署方式)
## 预览
<table>
<tr>
<td><b>明亮主题</b></td>
<td><b>黑暗主题</b></td>
</tr>
<tr>
<td><img src="assets/preview_light.png" alt="明亮主题预览" /></td>
<td><img src="assets/preview_dark.png" alt="黑暗主题预览" /></td>
</tr>
</table>
## 目录
- [预览](#预览)
- [功能特点](#功能特点)
- [近期更新](#近期更新)
- [技术栈](#技术栈)
- [项目结构](#项目结构)
- [文档导航](#文档导航)
- [快速开始](#快速开始)
- [部署方式](#部署方式)
- [部署到GitHub Pages](#快速部署到github-pages)
- [部署到自己的服务器](#部署到服务器)
- [其他CI/CD服务部署](#其他cicd托管选项)
- [配置指南](#设置配置文件)
- [书签导入](#书签导入功能)
- [常见问题](#常见问题)
- [Star-History](#star-history)
## 快速预览
[在线访问](https://rbetree.github.io/menav/)
## 功能特点
<p align="center">
<img src="assets/preview_light.png" alt="明亮主题预览" width="48%">
<img src="assets/preview_dark.png" alt="黑暗主题预览" width="48%">
</p>
<p align="center">左:明亮 右:黑暗</p>
- 🎨 简洁美观的界面设计
- 📱 响应式布局,支持移动端
- 🌐 集成Google、Bing、百度等外部搜索引擎
- 🎯 分类展示网站链接
- 👥 展示社交媒体链接
- 🧩 模块化配置
- 📝 支持多个内容页面
- 📌 支持从浏览器导入书签
- 📚 支持2-4层级的多层级嵌套书签结构更好地组织内容
- 🔄 与 [MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展集成,支持自动推送书签
- 🔄 可部署到GitHub Pages或任何类似的CI/CD服务及任何服务器
## 特点
## 近期更新
- 简洁美观的响应式布局设计
- 集成外部搜索引擎
- 分类展示网站链接
- 模块化配置
- 支持从浏览器导入书签
- 支持2-4层级的多层级嵌套结构
- 与 [MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展集成,支持自动推送书签
- 可部署到GitHub Pages或任何类似的CI/CD服务
## 更新记录
<details>
<summary>点击查看/隐藏更新日志</summary>
### 2025/12/23
**1. 侧边栏与导航交互优化**
- 高亮项有子菜单时会自动展开
- 侧边栏 `logo_text` 左侧展示站点 Logo复用 `site.favicon`
**2. 卡片层级折叠规则调整**
- 仅 1 层分类:一级分类支持下拉/收起
- 2/3 层分类:仅二级标题支持下拉/收起(一级/三级不提供折叠按钮与交互)
**3.页面细节**
- 主题蓝调整为 `#7694B9`,统一应用到高亮/渐变/阴影
- 搜索无结果红色状态图标对齐修复(避免图标位置偏移)
- `menav.svg` 优化暗色背景可读性(字母颜色加深)
### 2025/11/09
**1. 默认配置与文档**
- 更新默认配置与项目 Logo并同步完善 README
### 2025/10/31
**1. 书签导入与嵌套结构**
- 优化书签转换逻辑与分类嵌套结构
- 修复书签转换脚本问题,提升稳定性
### 2025/10/24 - 2025/10/27
**1. 分类/卡片交互与细节修复**
- 为各结构补齐下拉指示与交互,并新增“分类展开/收起”按钮
- 修复侧边栏切换图标错位、站点卡片悬浮层级遮挡问题
- 调整卡片间距与 category/group 栏样式效果,移除废弃的 `restructure` 命令
### 2025/10/18
**1. 图标模式默认行为变更**
- 默认启用 `icons.mode: favicon`,自动根据站点 URL 加载 favicon失败回退为 Font Awesome 图标)
- 如需关闭外部请求并完全使用手动图标,请在 `config/user/site.yml` 中设置:
- 默认启用 `icons.mode: favicon`,自动根据站点 URL 加载 favicon失败回退为 Font Awesome 图标)
- 如需关闭外部请求并完全使用手动图标,请在 `config/user/site.yml` 中设置:
```yaml
# config/user/site.yml
@@ -87,106 +91,101 @@ icons:
mode: manual # 关闭 favicon 请求,纯手动图标
```
** 隐私说明Favicon API**
- 使用 `https://t3.gstatic.com/faviconV2` 服务会将站点 `URL` 发送至第三方Google以获取 favicon 图片
- 若不希望产生外部网络请求或在内网/离线环境中部署,请设置 `icons.mode: manual`
### 2025/10/14
**1. 拼音搜索支持**
- 支持中文拼音与首字母匹配检索(基于 `pinyin-match`
- 支持中文拼音与首字母匹配检索(基于 `pinyin-match`
### 2025/07/30
**1. 链接打开行为一致性**
- 统一站点/导航外链为新标签页打开,改善导航体验
- 统一站点/导航外链为新标签页打开,改善导航体验
### 2025/07/07
**1. UI 细节优化**
- 侧边栏显示与布局细节优化
- 明暗主题切换按钮样式改进
- 欢迎文本与布局对齐优化
- 侧边栏显示与布局细节优化
- 明暗主题切换按钮样式改进
- 欢迎文本与布局对齐优化
### 2025/05/22
**1. MeNav 浏览器扩展支持接口**
- 注入序列化的配置数据供扩展读取(`configJSON`
- 暴露 `window.MeNav` 基础能力与 DOM 数据属性,支持元素精准定位与更新
- 为扩展推送与页面联动打通基础能力
- 注入序列化的配置数据供扩展读取(`configJSON`
- 暴露 `window.MeNav` 基础能力与 DOM 数据属性,支持元素精准定位与更新
- 为扩展推送与页面联动打通基础能力
### 2025/05/16
**1. MarksVault 浏览器扩展集成**
- 支持与 [MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展集成
- 使用扩展自动推送书签文件到 MeNav
- 自动处理推送的书签文件并更新网站
- 支持与 [MarksVault](https://github.com/rbetree/MarksVault) 浏览器扩展集成
- 使用扩展自动推送书签文件到 MeNav
- 自动处理推送的书签文件并更新网站
### 2025/05/09
**1. 搜索引擎集成功能**
- 集成Google、Bing、百度搜索引擎
- 通过搜索框图标一键切换不同搜索引擎
- 用户选择保存在本地,下次访问自动应用
- 集成Google、Bing、百度搜索引擎
- 通过搜索框图标一键切换不同搜索引擎
- 用户选择保存在本地,下次访问自动应用
### 2025/05/08
**1. Handlebars模板系统重构**
- 使用Handlebars模板引擎重构整个前端生成系统
- 实现模块化、组件化的模板结构包含layouts、pages和components
- 改进代码复用,提高可维护性和扩展性
- 优化HTML生成逻辑提升性能和代码质量
- 使用Handlebars模板引擎重构整个前端生成系统
- 实现模块化、组件化的模板结构包含layouts、pages和components
- 改进代码复用,提高可维护性和扩展性
- 优化HTML生成逻辑提升性能和代码质量
### 2025/05/04
**1. 移除双文件配置支持**
- 完全移除了对双文件配置方法的支持
- 简化了配置加载逻辑,现在仅支持模块化配置
- 完全移除了对双文件配置方法的支持
- 简化了配置加载逻辑,现在仅支持模块化配置
### 2025/05/03
**1. 侧边栏收回功能**
- 添加侧边栏折叠/展开按钮位于Logo文本右侧
- 侧边栏平滑折叠/展开过渡
- 添加侧边栏折叠/展开按钮位于Logo文本右侧
- 侧边栏平滑折叠/展开过渡
**2. 移动端UI优化**
- 修复搜索按钮和侧边栏按钮遮挡问题
- 点击侧边栏导航项后自动收起侧边栏
- 修复搜索按钮和侧边栏按钮遮挡问题
- 点击侧边栏导航项后自动收起侧边栏
### 2025/05/02
**1. 模块化配置**
- 支持将配置拆分为多个文件,便于管理和维护
- 引入配置目录结构,分离页面配置
- 保持向后兼容性,同时支持传统配置文件
- 支持将配置拆分为多个文件,便于管理和维护
- 引入配置目录结构,分离页面配置
- 保持向后兼容性,同时支持传统配置文件
### 2025/05/01
**1. 页面布局优化**
- 优化了内容区域和侧边栏的间距,确保各种分辨率下内容不会贴近边缘
- 卡片与边框始终保持合理间距,避免在窄屏设备上与滚动条贴边
- 调整了搜索结果区域的边距,与常规分类保持样式一致性
- 优化了内容区域和侧边栏的间距,确保各种分辨率下内容不会贴近边缘
- 卡片与边框始终保持合理间距,避免在窄屏设备上与滚动条贴边
- 调整了搜索结果区域的边距,与常规分类保持样式一致性
**2. 网站卡片文本优化**
- 为站点卡片标题添加单行文本截断,过长标题显示省略号
- 为站点描述添加两行限制和省略号,保持卡片布局整洁
- 添加卡片悬停提示,方便查看完整信息
- 为站点卡片标题添加单行文本截断,过长标题显示省略号
- 为站点描述添加两行限制和省略号,保持卡片布局整洁
- 添加卡片悬停提示,方便查看完整信息
**3. 移动端显示增强**
- 优化了移动端卡片尺寸,一屏可显示更多网址
- 图标大小自适应,在小屏幕上更加紧凑
- 为不同尺寸移动设备768px、480px、400px提供递进式UI优化
- 减小卡片内边距和元素间距,增加屏幕利用率
- 优化了移动端卡片尺寸,一屏可显示更多网址
- 图标大小自适应,在小屏幕上更加紧凑
- 为不同尺寸移动设备768px、480px、400px提供递进式UI优化
- 减小卡片内边距和元素间距,增加屏幕利用率
**4. 书签导入功能**
- 支持从Chrome、Firefox和Edge浏览器导入HTML格式书签
- 自动处理书签文件,解析文件夹结构和链接
- 图标处理:默认加载站点 favicon在 manual 模式下保留 Font Awesome 匹配
- 生成配置文件,无需手动录入即可批量导入网站链接
- 与GitHub Actions集成全自动化的导入和部署流程
- 支持从Chrome、Firefox和Edge浏览器导入HTML格式书签
- 自动处理书签文件,解析文件夹结构和链接
- 图标处理:默认加载站点 favicon在 manual 模式下保留 Font Awesome 匹配
- 生成配置文件,无需手动录入即可批量导入网站链接
- 与GitHub Actions集成全自动化的导入和部署流程
</details>
@@ -196,7 +195,6 @@ icons:
- JavaScript (原生)
- Handlebars 模板引擎
- Google Favicon API + Font Awesome 图标
- GitHub Pages托管/其他各种CI/CD服务托管
## 项目结构
@@ -248,6 +246,8 @@ menav/
## 快速开始
用于本地开发预览与构建静态站点;在线部署见 [部署方式](#部署方式)。
<details>
<summary>点击展开</summary>
@@ -310,6 +310,8 @@ npm run format
## 部署方式
用于将生成的静态站点发布到 服务器 or CI/CD本地构建见 [快速开始](#快速开始)。
### 快速部署到GitHub Pages
<details>