632 lines
20 KiB
Markdown
632 lines
20 KiB
Markdown
# <img src="assets/favicon.ico" width="48" style="vertical-align: middle;"> MeNav - 个人导航站
|
||
|
||
[](https://www.gnu.org/licenses/agpl-3.0.html)
|
||
[](https://github.com/rbetree/menav/stargazers)
|
||
[](https://github.com/rbetree/menav/network/members)
|
||
|
||
📋 一键部署的静态个人导航站 | ⚡ 自动化构建 | 🔖 支持书签导入
|
||
|
||
> MeNav是一个轻量级、高度可定制的个人导航网站生成器，让您轻松创建属于自己的导航主页。无需数据库和后端服务，完全静态部署，支持一键Fork部署到GitHub Pages，还可以从浏览器书签一键导入网站。MeNav is a lightweight, highly customizable personal navigation website generator. One-click deployment to GitHub Pages, automated build, bookmark import support, and more.
|
||
|
||
如果觉得项目有用，欢迎⭐Star/Fork支持，谢谢！
|
||
|
||
|
||
## 预览 | Preview
|
||
|
||
<table>
|
||
<tr>
|
||
<td><b>明亮主题 | Light Theme</b></td>
|
||
<td><b>黑暗主题 | Dark Theme</b></td>
|
||
</tr>
|
||
<tr>
|
||
<td><img src="assets/preview_light.png" alt="明亮主题预览" /></td>
|
||
<td><img src="assets/preview_dark.png" alt="黑暗主题预览" /></td>
|
||
</tr>
|
||
</table>
|
||
|
||
## 目录
|
||
|
||
- [预览](#预览--preview)
|
||
- [功能特点](#功能特点)
|
||
- [近期更新](#近期更新)
|
||
- [技术栈](#技术栈)
|
||
- [项目结构](#项目结构)
|
||
- [快速开始](#快速开始)
|
||
- [部署方式](#部署方式)
|
||
- [部署到GitHub Pages](#快速部署到github-pages)
|
||
- [部署到自己的服务器](#部署到服务器)
|
||
- [其他CI/CD服务部署](#其他cicd托管选项)
|
||
- [配置指南](#设置配置文件)
|
||
- [配置方式对比](#配置方式对比)
|
||
- [双文件配置](#使用双文件配置)
|
||
- [模块化配置（推荐）](#使用模块化配置)
|
||
- [配置详解](#配置详解)
|
||
- [书签导入](#书签导入功能)
|
||
- [常见问题](#常见问题)
|
||
- [贡献指南](#贡献指南)
|
||
- [许可证](#许可证)
|
||
|
||
## 快速预览
|
||
|
||
[在线访问](https://rbetree.github.io/menav/)
|
||
|
||
## 功能特点
|
||
|
||
- 🎨 简洁美观的界面设计
|
||
- 📱 响应式布局，支持移动端
|
||
- 🔍 实时搜索功能
|
||
- 🎯 分类展示网站链接
|
||
- 👥 支持展示社交媒体链接
|
||
- 📝 支持多个内容页面
|
||
- 📌 支持从浏览器导入书签
|
||
- 🧩 模块化配置/双文件配置
|
||
- 🔄 可部署到GitHub Pages或任何类似的CI/CD服务，及任何服务器
|
||
|
||
## 近期更新
|
||
|
||
<details>
|
||
<summary>点击查看/隐藏更新日志</summary>
|
||
|
||
### 2025/05/03
|
||
|
||
**1. 侧边栏收回功能**
|
||
- ✅ 添加侧边栏折叠/展开按钮，位于Logo文本右侧
|
||
- ✅ 侧边栏平滑折叠/展开过渡
|
||
|
||
**2. 移动端UI优化**
|
||
- ✅ 修复搜索按钮和侧边栏按钮遮挡问题
|
||
- ✅ 点击侧边栏导航项后自动收起侧边栏
|
||
|
||
**3. 配置加载优先级修复**
|
||
- ✅ 修复了模块化配置目录加载时的关键问题，确保site.yml中的fonts、profile和social配置正确应用
|
||
- ✅ 修复了home.yml中的categories配置未正确加载到导航首页的问题
|
||
- ✅ 增强了配置加载逻辑，确保按照优先级规则完整应用配置
|
||
|
||
### 2025/05/02
|
||
|
||
**1. 模块化配置**
|
||
- ✅ 支持将配置拆分为多个文件，便于管理和维护
|
||
- ✅ 引入配置目录结构，分离页面配置
|
||
- ✅ 保持向后兼容性，同时支持传统配置文件
|
||
|
||
### 2025/05/01
|
||
|
||
**1. 页面布局优化**
|
||
- ✅ 优化了内容区域和侧边栏的间距，确保各种分辨率下内容不会贴近边缘
|
||
- ✅ 卡片与边框始终保持合理间距，避免在窄屏设备上与滚动条贴边
|
||
- ✅ 调整了搜索结果区域的边距，与常规分类保持样式一致性
|
||
|
||
**2. 网站卡片文本优化**
|
||
- ✅ 为站点卡片标题添加单行文本截断，过长标题显示省略号
|
||
- ✅ 为站点描述添加两行限制和省略号，保持卡片布局整洁
|
||
- ✅ 添加卡片悬停提示，方便查看完整信息
|
||
|
||
**3. 移动端显示增强**
|
||
- ✅ 优化了移动端卡片尺寸，一屏可显示更多网址
|
||
- ✅ 图标大小自适应，在小屏幕上更加紧凑
|
||
- ✅ 为不同尺寸移动设备（768px、480px、400px）提供递进式UI优化
|
||
- ✅ 减小卡片内边距和元素间距，增加屏幕利用率
|
||
|
||
**4. 书签导入功能**
|
||
- ✅ 支持从Chrome、Firefox和Edge浏览器导入HTML格式书签
|
||
- ✅ 自动处理书签文件，解析文件夹结构和链接
|
||
- ✅ 智能匹配网站图标，根据URL自动分配合适的Font Awesome图标
|
||
- ✅ 生成配置文件，无需手动录入即可批量导入网站链接
|
||
- ✅ 与GitHub Actions集成，全自动化的导入和部署流程
|
||
|
||
</details>
|
||
|
||
## 技术栈
|
||
|
||
- HTML5 + CSS3
|
||
- JavaScript (原生)
|
||
- Font Awesome 图标
|
||
- GitHub Pages托管/其他各种CI/CD服务托管
|
||
|
||
## 项目结构
|
||
|
||
```bash
|
||
menav/
|
||
├── assets/ # 静态资源文件
|
||
│ ├── style.css # 样式表
|
||
│ └── favicon.ico # 网站图标
|
||
├── src/ # 源代码
|
||
│ ├── generator.js # 静态网站生成器
|
||
│ └── script.js # 前端JavaScript脚本
|
||
├── templates/ # HTML模板
|
||
│ └── index.html # HTML骨架模板文件
|
||
├── dist/ # 生成的静态网站（由generator.js生成）
|
||
├── bookmarks/ # 书签导入目录
|
||
├── config/ # 模块化配置目录
|
||
│ ├── _default/ # 默认配置
|
||
│ │ ├── site.yml # 网站基本配置
|
||
│ │ ├── navigation.yml # 导航配置
|
||
│ │ └── pages/ # 页面配置
|
||
│ │ ├── home.yml
|
||
│ │ ├── projects.yml
|
||
│ │ ├── articles.yml
|
||
│ │ ├── friends.yml
|
||
│ │ └── bookmarks.yml
|
||
│ └── user/ # 用户自定义配置
|
||
│ ├── site.yml # 用户网站配置
|
||
│ ├── navigation.yml # 用户导航配置
|
||
│ └── pages/ # 用户页面配置
|
||
├── config.yml # 默认配置文件（传统格式）
|
||
└── config.user.yml # 用户自定义配置文件（传统格式）
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
<details>
|
||
<summary>点击展开</summary>
|
||
|
||
通过以下步骤快速设置您的个人导航站：
|
||
|
||
1. 克隆仓库
|
||
```bash
|
||
git clone https://github.com/rbetree/menav.git
|
||
cd menav
|
||
```
|
||
|
||
2. 安装依赖
|
||
```bash
|
||
# 安装依赖
|
||
npm install
|
||
```
|
||
|
||
3. 修改配置
|
||
- 根据您的需求选择配置方式：
|
||
- 双文件配置：复制`config.yml`为`config.user.yml`并编辑
|
||
- 模块化配置：在`config/user/`目录下创建配置文件
|
||
- 自定义站点标题、描述、导航链接和网站分类等
|
||
|
||
4. 本地预览
|
||
```bash
|
||
# 启动开发服务器
|
||
npm run dev
|
||
```
|
||
|
||
5. 构建静态网站
|
||
```bash
|
||
# 生成静态HTML文件
|
||
npm run build
|
||
```
|
||
|
||
构建后的文件位于`dist`目录，可以部署到任何静态网站托管服务。
|
||
|
||
</details>
|
||
|
||
## 部署方式
|
||
|
||
### 快速部署到GitHub Pages
|
||
|
||
<details>
|
||
<summary>点击展开</summary>
|
||
|
||
#### 第一步：前置设置
|
||
|
||
1. Fork仓库:
|
||
- 点击右上角的 Fork 按钮复制此仓库到您的账号
|
||
|
||
2. 启用必要功能:
|
||
- 进入仓库的 Settings -> General
|
||
- 找到 Features 部分
|
||
- 勾选 "Issues"
|
||
|
||
3. 启用Actions:
|
||
- 进入fork后的仓库
|
||
- 点击顶部的 "Actions" 标签页
|
||
- 点击绿色按钮 "I understand my workflows, go ahead and enable them"
|
||
|
||
4. 配置Pages:
|
||
- 进入仓库的 Settings -> Pages
|
||
- 在 "Build and deployment" 部分
|
||
- Source: 选择 "GitHub Actions"
|
||
|
||
#### 第二步：自定义配置
|
||
|
||
1. 创建个人配置文件:
|
||
- **重要:** 始终创建自己的用户配置文件，不要直接修改默认配置文件
|
||
- 可以使用双文件配置或模块化配置
|
||
- 推荐使用模块化配置（见[使用模块化配置](#使用模块化配置)）
|
||
- 提交您的配置文件到仓库
|
||
|
||
2. 等待自动部署:
|
||
- GitHub Actions会自动检测您的更改
|
||
- 构建并部署您的网站
|
||
- 部署完成后，您可以在 Settings -> Pages 中找到您的网站地址
|
||
|
||
> 重要提示: 请注意不要在配置文件中包含敏感信息，因为它将被提交到公开仓库。
|
||
|
||
#### 故障排除
|
||
|
||
如果遇到部署问题:
|
||
1. 请确保完成了所有前置设置步骤
|
||
2. 检查每个设置页面是否都点击了 Save 按钮
|
||
3. 如果修改设置后部署仍然失败:
|
||
- 进入 Actions 标签页
|
||
- 找到失败的工作流
|
||
- 点击 "Re-run all jobs" 重新运行
|
||
|
||
</details>
|
||
|
||
### 部署到服务器
|
||
|
||
<details>
|
||
<summary>点击展开</summary>
|
||
|
||
如果您想部署到自己的Web服务器，只需要以下几个步骤：
|
||
|
||
1. 构建静态网站:
|
||
```bash
|
||
npm run build
|
||
```
|
||
|
||
2. 复制构建结果:
|
||
- 所有生成的静态文件都位于 `dist` 目录中
|
||
- 将 `dist` 目录中的所有文件复制到您的Web服务器根目录
|
||
|
||
3. 配置Web服务器:
|
||
- 确保服务器配置为提供静态文件
|
||
- 对于Apache: 在网站根目录中已有正确的 .htaccess 文件
|
||
- 对于Nginx: 添加以下配置到您的server块:
|
||
|
||
```nginx
|
||
server {
|
||
listen 80;
|
||
server_name your-domain.com;
|
||
root /path/to/dist;
|
||
index index.html;
|
||
|
||
location / {
|
||
try_files $uri $uri/ /index.html;
|
||
}
|
||
}
|
||
```
|
||
|
||
4. 更新配置:
|
||
- 如果您想在服务器上更新网站，只需重复上述步骤1-2
|
||
- 或者设置自动部署流程，例如使用GitLab CI/CD或Jenkins
|
||
|
||
</details>
|
||
|
||
### 其他CI/CD托管选项
|
||
|
||
<details>
|
||
<summary>点击展开</summary>
|
||
|
||
除了GitHub Pages外，您还可以使用其他各种CI/CD服务部署MeNav：
|
||
|
||
1. **Vercel**:
|
||
- 在Vercel上导入您的GitHub仓库
|
||
- 设置构建命令为`npm run build`
|
||
- 设置输出目录为`dist`
|
||
|
||
2. **Netlify**:
|
||
- 连接您的GitHub仓库
|
||
- 设置构建命令为`npm run build`
|
||
- 发布目录设置为`dist`
|
||
|
||
3. **Cloudflare Pages**:
|
||
- 连接您的Git提供商
|
||
- 设置构建命令为`npm run build`
|
||
- 构建输出目录设置为`dist`
|
||
|
||
4. **GitLab Pages**:
|
||
- 创建`.gitlab-ci.yml`文件
|
||
- 配置Pages部署流程
|
||
- 指定构建输出目录
|
||
|
||
5. **Azure Static Web Apps**:
|
||
- 在Azure门户中创建新的静态Web应用
|
||
- 关联您的代码库
|
||
- 配置构建信息
|
||
|
||
无论选择哪种部署方式，请确保创建并使用您自己的配置文件，而不是直接修改默认配置。
|
||
|
||
</details>
|
||
|
||
## 设置配置文件
|
||
|
||
MeNav支持两种配置方式：双文件配置和模块化配置（推荐）。
|
||
|
||
> **🔔 重要提示：** 请务必创建并使用您自己的配置文件（`config.user.yml`或`config/user/`目录），不要直接修改默认配置文件，以便后续更新项目时不会丢失您的个性化设置。
|
||
|
||
在加载配置时遵循以下优先级顺序：
|
||
1. `config/user/` （模块化用户配置）（优先级最高）
|
||
2. `config.user.yml`和 `bookmarks.user.yml`（双文件用户配置）
|
||
3. `config/_default/` （模块化默认配置）
|
||
4. `config.yml`和`bookmarks.yml`（双文件默认配置）（优先级最低）
|
||
|
||
**注意：** 各优先级配置间采用完全替换策略，而非合并。系统会选择存在的最高优先级配置，完全忽略其他低优先级配置。这确保了模块化配置和双文件配置都能独立使用，避免混合配置带来的意外行为。
|
||
|
||
### 配置方式对比
|
||
|
||
<table>
|
||
<tr>
|
||
<th>特性</th>
|
||
<th>双文件配置</th>
|
||
<th>模块化配置（推荐）</th>
|
||
</tr>
|
||
<tr>
|
||
<td>配置文件</td>
|
||
<td>两个主要文件：<code>config.user.yml</code> 和 <code>bookmarks.user.yml</code></td>
|
||
<td>分散到多个文件：<code>config/user/site.yml</code>, <code>navigation.yml</code>, <code>pages/*.yml</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>适用场景</td>
|
||
<td>小型网站，快速开始</td>
|
||
<td>复杂网站，长期维护</td>
|
||
</tr>
|
||
<tr>
|
||
<td>关注点分离</td>
|
||
<td>所有配置集中在一个文件</td>
|
||
<td>每个页面和功能区域有专属配置文件</td>
|
||
</tr>
|
||
<tr>
|
||
<td>兼容性</td>
|
||
<td>传统方式，简单直接</td>
|
||
<td>完全兼容传统方式，不影响旧版本</td>
|
||
</tr>
|
||
</table>
|
||
|
||
### 使用双文件配置
|
||
|
||
双文件配置由 `config.yml`/`config.user.yml` 和 `bookmarks.yml`/`bookmarks.user.yml` 两个文件组成，适合小型网站和快速开始。
|
||
|
||
* **创建配置文件**:
|
||
- 复制 `config.yml` 为 `config.user.yml`
|
||
- 对于书签配置，请勿手动创建 `bookmarks.user.yml`，它应通过[书签导入功能](#书签导入功能)自动生成
|
||
- 编辑 `config.user.yml` 添加您的配置
|
||
|
||
### 使用模块化配置
|
||
|
||
模块化配置将配置分散到多个文件中，更易于管理和维护，推荐用于复杂网站。
|
||
|
||
* **创建配置目录**:
|
||
- 在`config/user/`目录下创建您的自定义配置文件
|
||
- 可以参考项目结构中的`config/_default/`目录结构
|
||
- 至少需要创建`site.yml`和`navigation.yml`
|
||
|
||
### 配置详解
|
||
|
||
<details>
|
||
<summary>点击展开</summary>
|
||
|
||
以下是配置文件各部分的详细说明，适用于双文件配置和模块化配置两种方式。
|
||
|
||
#### 配置文件结构
|
||
|
||
配置文件使用YAML格式，包含多个关键部分：
|
||
|
||
```yaml
|
||
# 网站基本信息
|
||
site:
|
||
title: 网站标题
|
||
description: 网站描述
|
||
author: 作者名
|
||
favicon: favicon.ico # 网站图标,支持ico、png等格式
|
||
|
||
# 字体设置
|
||
fonts:
|
||
title: # 标题字体
|
||
family: 字体名称
|
||
weight: 字重值
|
||
source: 字体来源
|
||
subtitle: # 副标题字体
|
||
family: 字体名称
|
||
weight: 字重值
|
||
source: 字体来源
|
||
body: # 正文字体
|
||
family: 字体名称
|
||
weight: 字重值
|
||
source: 字体来源
|
||
|
||
# 个人信息
|
||
profile:
|
||
title: 欢迎语
|
||
subtitle: 副标题
|
||
description: 描述
|
||
|
||
# 导航菜单
|
||
navigation:
|
||
- name: 菜单名称
|
||
icon: 图标类名
|
||
id: 页面ID
|
||
active: 是否激活
|
||
|
||
# 类别
|
||
categories:
|
||
- name: 分类名称
|
||
icon: 分类图标
|
||
sites:
|
||
- name: 网站名称
|
||
url: 网站地址
|
||
icon: 网站图标
|
||
description: 网站描述
|
||
|
||
# 更多配置...
|
||
```
|
||
|
||
#### 添加网站链接
|
||
|
||
在配置文件中的 categories 部分添加新站点：
|
||
|
||
```yaml
|
||
categories:
|
||
- name: 分类名称
|
||
icon: 分类图标
|
||
sites:
|
||
- name: 网站名称
|
||
url: 网站地址
|
||
icon: 网站图标
|
||
description: 网站描述
|
||
```
|
||
|
||
#### 设置网站字体
|
||
|
||
字体配置有三个关键属性：
|
||
|
||
- `family`: 字体名称，支持Web安全字体或Google Fonts
|
||
- `weight`: 字体粗细，常用值如400(常规)、500(中等)、600(粗体)等
|
||
- `source`: 字体来源，可选"google"或"system"
|
||
|
||
例如使用Google字体:
|
||
```yaml
|
||
fonts:
|
||
body:
|
||
family: "Noto Sans SC" # Google提供的中文字体
|
||
weight: 400
|
||
source: "google"
|
||
```
|
||
|
||
#### 设置网站图标
|
||
|
||
网站图标设置提示：
|
||
|
||
- 支持.ico、.png等格式
|
||
- 建议尺寸为32x32或16x16像素
|
||
- 将图标文件放在assets目录下
|
||
- 在配置文件中设置：`favicon: favicon.ico`
|
||
|
||
#### 使用Font Awesome图标
|
||
|
||
MeNav使用Font Awesome图标库为网站分类和链接提供图标：
|
||
|
||
- **图标类名**：使用Font Awesome 5的图标类名，例如`fas fa-home`、`fab fa-github`等
|
||
- **查找图标**：可在[Font Awesome官网](https://fontawesome.com/icons)浏览和搜索图标
|
||
- **常用图标前缀**：
|
||
- `fas`：实心风格图标 (Font Awesome Solid)
|
||
- `far`：线框风格图标 (Font Awesome Regular)
|
||
- `fab`：品牌图标 (Font Awesome Brands)
|
||
|
||
示例：
|
||
```yaml
|
||
# 分类图标
|
||
categories:
|
||
- name: "常用工具"
|
||
icon: "fas fa-tools"
|
||
sites:
|
||
- name: "GitHub"
|
||
url: "https://github.com"
|
||
icon: "fab fa-github"
|
||
description: "全球最大的代码托管平台"
|
||
- name: "谷歌搜索"
|
||
url: "https://google.com"
|
||
icon: "fab fa-google"
|
||
description: "全球最大的搜索引擎"
|
||
```
|
||
|
||
**提示**：书签导入功能会根据网站URL自动匹配适合的Font Awesome图标。如需自定义，可在导入后编辑配置文件修改图标类名。
|
||
|
||
</details>
|
||
|
||
## 书签导入功能
|
||
|
||
MeNav支持从浏览器导入书签，快速批量添加网站链接，无需手动录入。
|
||
|
||
### 配置加载优先级
|
||
|
||
书签配置按以下优先级加载（从高到低）：
|
||
|
||
1. `config/user/pages/bookmarks.yml` （模块化用户配置）
|
||
2. `bookmarks.user.yml`（双文件用户配置）
|
||
3. `config/_default/pages/bookmarks.yml` （模块化默认配置）
|
||
4. `bookmarks.yml`（双文件默认配置）
|
||
|
||
**注意：** 与主配置一样，书签配置采用完全替换策略，系统只会使用找到的最高优先级配置。
|
||
|
||
### 导入步骤详解
|
||
|
||
<details>
|
||
<summary>点击展开</summary>
|
||
|
||
1. **从浏览器导出书签**
|
||
|
||
**Chrome**:
|
||
- 打开Chrome菜单 (右上角三点图标)
|
||
- 选择"书签" > "书签管理器"
|
||
- 点击右上角三点图标，选择"导出书签"
|
||
- 保存HTML文件到本地
|
||
|
||
**Firefox**:
|
||
- 点击书签菜单按钮
|
||
- 选择"管理书签"
|
||
- 在菜单栏选择"导入和备份" > "导出书签到HTML"
|
||
- 保存文件到本地
|
||
|
||
**Edge**:
|
||
- 打开菜单 (右上角三点图标)
|
||
- 选择"收藏夹"
|
||
- 点击"更多选项" > "导出收藏夹"
|
||
- 保存为HTML文件
|
||
|
||
2. **导入书签到MeNav**
|
||
|
||
**GitHub Pages方式**:
|
||
- Fork本仓库后，在您的仓库中创建`bookmarks`目录
|
||
- 上传HTML格式书签文件到此目录
|
||
- GitHub Actions会自动处理文件并生成配置
|
||
|
||
**本地开发方式**:
|
||
- 在项目根目录创建`bookmarks`文件夹
|
||
- 复制HTML书签文件到此文件夹
|
||
- 运行`npm run import-bookmarks`命令处理书签文件
|
||
- 系统生成配置文件后即可使用`npm run dev`预览
|
||
|
||
3. **处理结果**
|
||
|
||
处理完成后：
|
||
- 书签分类会变成网站分类
|
||
- 书签文件夹结构会被保留
|
||
- 系统自动尝试匹配网站图标
|
||
- 生成的配置可在`bookmarks.user.yml`或`config/user/pages/bookmarks.yml`中查看和编辑
|
||
|
||
### 书签导入注意事项
|
||
|
||
- 仅支持标准HTML格式的书签文件（大多数浏览器导出格式）
|
||
- 每次只会处理目录中最新的一个书签文件
|
||
- 文件夹结构会保留，但可能需要手动调整图标和描述
|
||
- 处理完成后，原始书签文件会被自动删除，以防止重复处理
|
||
</details>
|
||
|
||
## 常见问题
|
||
|
||
<details>
|
||
<summary>为什么推荐使用模块化配置而非双文件配置？</summary>
|
||
模块化配置将不同功能的配置分散到多个文件中，便于管理和维护。当网站内容较多时，单一配置文件会变得臃肿难以编辑，而模块化配置则可以让您只关注需要修改的部分。
|
||
</details>
|
||
|
||
<details>
|
||
<summary>如何更改网站的主题或样式？</summary>
|
||
目前MeNav采用统一的设计风格，您可以通过修改`config/user/site.yml`（或`config.user.yml`）中的字体设置来调整网站外观。未来版本将考虑增加主题切换功能。
|
||
</details>
|
||
|
||
<details>
|
||
<summary>可以添加自定义JS脚本吗？</summary>
|
||
当前版本不直接支持添加自定义JS。如果您需要此功能，可以考虑Fork项目后修改`templates/index.html`模板文件，添加您的自定义脚本。
|
||
</details>
|
||
|
||
<details>
|
||
<summary>导入的书签没有正确显示图标怎么办？</summary>
|
||
系统会尝试根据网址自动匹配Font Awesome图标。如果匹配不理想，您可以手动编辑`bookmarks.user.yml`或`config/user/pages/bookmarks.yml`，修改每个站点的icon属性。
|
||
</details>
|
||
|
||
## 贡献指南
|
||
|
||
欢迎通过 Issues 或 Pull Requests 的形式做出贡献。如果您有好的想法或发现了问题，请随时提出。
|
||
|
||
## 许可证
|
||
|
||
[](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)文件中查看。
|