chore: 使用 Prettier 统一代码风格
This commit is contained in:
100
config/README.md
100
config/README.md
@@ -117,13 +117,13 @@ MeNav 配置系统采用“完全替换”策略(不合并),按以下优
|
||||
- 示例:
|
||||
```yml
|
||||
sites:
|
||||
- name: "Ant Design"
|
||||
url: "https://ant.design/"
|
||||
icon: "fas fa-th"
|
||||
forceIconMode: manual # 强制使用手动图标,绕过 favicon 默认"地球"图标
|
||||
- name: "Example"
|
||||
url: "https://example.com/"
|
||||
faviconUrl: "https://example.com/favicon.png" # 单站点自定义 favicon
|
||||
- name: 'Ant Design'
|
||||
url: 'https://ant.design/'
|
||||
icon: 'fas fa-th'
|
||||
forceIconMode: manual # 强制使用手动图标,绕过 favicon 默认"地球"图标
|
||||
- name: 'Example'
|
||||
url: 'https://example.com/'
|
||||
faviconUrl: 'https://example.com/favicon.png' # 单站点自定义 favicon
|
||||
```
|
||||
|
||||
3. **安全策略(链接白名单)**
|
||||
@@ -254,46 +254,46 @@ MeNav 配置系统采用“完全替换”策略:只会选择一套目录加
|
||||
|
||||
```yaml
|
||||
# 网站基本信息
|
||||
title: "我的个人导航"
|
||||
description: "个人收藏的网站导航页"
|
||||
keywords: "导航,网址,书签,个人主页"
|
||||
title: '我的个人导航'
|
||||
description: '个人收藏的网站导航页'
|
||||
keywords: '导航,网址,书签,个人主页'
|
||||
|
||||
# 个人资料配置
|
||||
profile:
|
||||
title: "个人导航站"
|
||||
subtitle: "我收藏的精选网站"
|
||||
title: '个人导航站'
|
||||
subtitle: '我收藏的精选网站'
|
||||
|
||||
# 字体:全站基础字体
|
||||
fonts:
|
||||
source: css
|
||||
cssUrl: "https://fontsapi.zeoseven.com/292/main/result.css"
|
||||
cssUrl: 'https://fontsapi.zeoseven.com/292/main/result.css'
|
||||
preload: true
|
||||
family: "LXGW WenKai"
|
||||
family: 'LXGW WenKai'
|
||||
weight: normal
|
||||
|
||||
|
||||
# 社交媒体链接
|
||||
social:
|
||||
- name: "GitHub"
|
||||
url: "https://github.com/username"
|
||||
icon: "fab fa-github"
|
||||
- name: "Twitter"
|
||||
url: "https://twitter.com/username"
|
||||
icon: "fab fa-twitter"
|
||||
- name: 'GitHub'
|
||||
url: 'https://github.com/username'
|
||||
icon: 'fab fa-github'
|
||||
- name: 'Twitter'
|
||||
url: 'https://twitter.com/username'
|
||||
icon: 'fab fa-twitter'
|
||||
|
||||
# 导航配置
|
||||
navigation:
|
||||
- name: "常用"
|
||||
icon: "fas fa-star"
|
||||
id: "common"
|
||||
- name: "项目"
|
||||
icon: "fas fa-project-diagram"
|
||||
id: "projects"
|
||||
- name: "文章"
|
||||
icon: "fas fa-book"
|
||||
id: "articles"
|
||||
- name: "书签"
|
||||
icon: "fas fa-bookmark"
|
||||
id: "bookmarks"
|
||||
- name: '常用'
|
||||
icon: 'fas fa-star'
|
||||
id: 'common'
|
||||
- name: '项目'
|
||||
icon: 'fas fa-project-diagram'
|
||||
id: 'projects'
|
||||
- name: '文章'
|
||||
icon: 'fas fa-book'
|
||||
id: 'articles'
|
||||
- name: '书签'
|
||||
icon: 'fas fa-bookmark'
|
||||
id: 'bookmarks'
|
||||
```
|
||||
|
||||
### 通用页面配置示例(例如 common.yml)
|
||||
@@ -301,25 +301,25 @@ navigation:
|
||||
```yaml
|
||||
# 页面分类配置
|
||||
categories:
|
||||
- name: "常用工具"
|
||||
icon: "fas fa-tools"
|
||||
- name: '常用工具'
|
||||
icon: 'fas fa-tools'
|
||||
sites:
|
||||
- name: "Google"
|
||||
url: "https://www.google.com"
|
||||
description: "全球最大的搜索引擎"
|
||||
icon: "fab fa-google"
|
||||
- name: "GitHub"
|
||||
url: "https://github.com"
|
||||
description: "代码托管平台"
|
||||
icon: "fab fa-github"
|
||||
|
||||
- name: "学习资源"
|
||||
icon: "fas fa-graduation-cap"
|
||||
- name: 'Google'
|
||||
url: 'https://www.google.com'
|
||||
description: '全球最大的搜索引擎'
|
||||
icon: 'fab fa-google'
|
||||
- name: 'GitHub'
|
||||
url: 'https://github.com'
|
||||
description: '代码托管平台'
|
||||
icon: 'fab fa-github'
|
||||
|
||||
- name: '学习资源'
|
||||
icon: 'fas fa-graduation-cap'
|
||||
sites:
|
||||
- name: "MDN Web Docs"
|
||||
url: "https://developer.mozilla.org"
|
||||
description: "Web开发技术文档"
|
||||
icon: "fab fa-firefox-browser"
|
||||
- name: 'MDN Web Docs'
|
||||
url: 'https://developer.mozilla.org'
|
||||
description: 'Web开发技术文档'
|
||||
icon: 'fab fa-firefox-browser'
|
||||
```
|
||||
|
||||
## 最佳实践
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# 默认页面配置(请勿直接修改)。
|
||||
# 建议复制到 config/user/pages/articles.yml 并按需调整。
|
||||
title: 技术文章 # 页面标题
|
||||
subtitle: RSS 聚合文章列表 # 页面副标题
|
||||
title: 技术文章 # 页面标题
|
||||
subtitle: RSS 聚合文章列表 # 页面副标题
|
||||
|
||||
# 指定使用的模板文件名,现有页面模板可见 templates/pages(不含 .hbs)
|
||||
template: articles
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# 默认页面配置(请勿直接修改)。
|
||||
# 建议复制到 config/user/pages/common.yml 并按需调整。
|
||||
title: 常用网站 # 页面标题
|
||||
subtitle: Common website # 页面副标题
|
||||
title: 常用网站 # 页面标题
|
||||
subtitle: Common website # 页面副标题
|
||||
|
||||
# 指定使用的模板文件名,现有页面模板可见 templates/pages(不含 .hbs)
|
||||
# 说明:推荐使用通用模板 page;首页由“导航第一项”决定
|
||||
@@ -12,9 +12,9 @@ categories:
|
||||
- name: 置顶
|
||||
icon: fas fa-star # 分类图标
|
||||
sites:
|
||||
- name: Linux.do # 站点名称
|
||||
url: https://linux.do/ # http/https URL(favicon 模式将尝试加载站点图标)
|
||||
icon: fab fa-linux # 手动图标:manual 模式使用;favicon 模式下作为回退
|
||||
- name: Linux.do # 站点名称
|
||||
url: https://linux.do/ # http/https URL(favicon 模式将尝试加载站点图标)
|
||||
icon: fab fa-linux # 手动图标:manual 模式使用;favicon 模式下作为回退
|
||||
description: 新的理想型社区 # 站点描述
|
||||
- name: Menav
|
||||
url: https://rbetree.github.io/menav
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# 默认页面配置(请勿直接修改)。
|
||||
# 建议复制到 config/user/pages/projects.yml 并按需调整。
|
||||
title: 项目 # 页面标题
|
||||
subtitle: 项目展示 # 页面副标题
|
||||
title: 项目 # 页面标题
|
||||
subtitle: 项目展示 # 页面副标题
|
||||
|
||||
# 指定使用的模板文件名,现有页面模板可见 templates/pages(不含 .hbs)
|
||||
template: projects
|
||||
@@ -14,20 +14,20 @@ template: projects
|
||||
# - `npm run build` 默认不联网;缓存缺失时卡片仅展示标题与描述
|
||||
categories:
|
||||
- name: 个人项目
|
||||
icon: fas fa-code # 分类图标(Font Awesome)
|
||||
icon: fas fa-code # 分类图标(Font Awesome)
|
||||
sites:
|
||||
- name: MeNav
|
||||
icon: fab fa-github # 手动图标(manual 模式显示;favicon 模式下作为回退)
|
||||
icon: fab fa-github # 手动图标(manual 模式显示;favicon 模式下作为回退)
|
||||
description: 一键部署的个人导航站生成器,支持书签导入与自动构建,轻松整理展示您的网络收藏 # 站点描述
|
||||
url: https://github.com/rbetree/menav
|
||||
- name: MarksVault
|
||||
icon: fab fa-github
|
||||
description: 一个强大的浏览器扩展,用于智能管理、整理和安全备份您的书签数据
|
||||
url: "https://github.com/rbetree/MarksVault"
|
||||
url: 'https://github.com/rbetree/MarksVault'
|
||||
- name: star
|
||||
icon: fas fa-star
|
||||
sites:
|
||||
- name: CLIProxyAPI
|
||||
icon: fab fa-github
|
||||
description: Wrap Gemini CLI, Antigravity, ChatGPT Codex, Claude Code, Qwen Code, iFlow as an OpenAI/Gemini/Claude/Codex compatible API service, allowing you to enjoy the free Gemini 2.5 Pro, GPT 5, Claude, Qwen model through API
|
||||
url: "https://github.com/router-for-me/CLIProxyAPI"
|
||||
url: 'https://github.com/router-for-me/CLIProxyAPI'
|
||||
|
||||
@@ -41,7 +41,7 @@ security:
|
||||
# - system: 只使用本地/系统字体,不额外发起请求
|
||||
fonts:
|
||||
source: css
|
||||
cssUrl: "https://fontsapi.zeoseven.com/292/main/result.css"
|
||||
cssUrl: 'https://fontsapi.zeoseven.com/292/main/result.css'
|
||||
preload: true # 可选:使用 preload+onload 的方式非阻塞加载字体 CSS(更利于首屏性能)
|
||||
family: LXGW WenKai
|
||||
weight: normal
|
||||
@@ -67,23 +67,23 @@ rss:
|
||||
enabled: true
|
||||
cacheDir: dev
|
||||
fetch:
|
||||
timeoutMs: 10000 # 单请求超时(毫秒)
|
||||
totalTimeoutMs: 60000 # 全流程总超时(毫秒)
|
||||
concurrency: 5 # 并发抓取站点数
|
||||
maxRetries: 1 # 单站点重试次数(best-effort)
|
||||
maxRedirects: 3 # 最大重定向次数
|
||||
timeoutMs: 10000 # 单请求超时(毫秒)
|
||||
totalTimeoutMs: 60000 # 全流程总超时(毫秒)
|
||||
concurrency: 5 # 并发抓取站点数
|
||||
maxRetries: 1 # 单站点重试次数(best-effort)
|
||||
maxRedirects: 3 # 最大重定向次数
|
||||
articles:
|
||||
perSite: 8 # 单站点最多抓取条数
|
||||
total: 50 # 全站聚合上限
|
||||
summaryMaxLength: 200 # 摘要最大长度(字符)
|
||||
perSite: 8 # 单站点最多抓取条数
|
||||
total: 50 # 全站聚合上限
|
||||
summaryMaxLength: 200 # 摘要最大长度(字符)
|
||||
|
||||
# GitHub:用于 projects 页面右侧“贡献热力图”(可选)
|
||||
# - username:你的 GitHub 用户名(例如 torvalds)
|
||||
# - heatmapColor:热力图主题色(不带 #,例如 339af0)
|
||||
github:
|
||||
username: "rbetree" # 你的 GitHub 用户名(例如 torvalds;为空则 projects 页不展示热力图)
|
||||
username: 'rbetree' # 你的 GitHub 用户名(例如 torvalds;为空则 projects 页不展示热力图)
|
||||
heatmapColor: 339af0
|
||||
cacheDir: dev # projects 仓库元信息缓存目录(默认 dev,仓库默认 gitignore)
|
||||
cacheDir: dev # projects 仓库元信息缓存目录(默认 dev,仓库默认 gitignore)
|
||||
|
||||
# 社交媒体链接:显示在侧边栏底部;可按需增删
|
||||
social:
|
||||
@@ -102,9 +102,9 @@ social:
|
||||
|
||||
# 导航配置(顺序第一项即首页/默认打开页)
|
||||
navigation:
|
||||
- name: 常用 # 菜单名称
|
||||
icon: fas fa-star # Font Awesome 图标类
|
||||
id: common # 页面标识符(唯一,需与 pages/<id>.yml 对应)
|
||||
- name: 常用 # 菜单名称
|
||||
icon: fas fa-star # Font Awesome 图标类
|
||||
id: common # 页面标识符(唯一,需与 pages/<id>.yml 对应)
|
||||
- name: 项目
|
||||
icon: fas fa-project-diagram
|
||||
id: projects
|
||||
|
||||
@@ -13,12 +13,14 @@
|
||||
用途:为 `articles` 页面提供 RSS/Atom 文章聚合数据,供 `npm run sync-articles` 联网抓取并写入缓存;`npm run build` 默认不联网,只读取缓存渲染。
|
||||
|
||||
关键字段(默认示例见 `config/_default/site.yml`):
|
||||
|
||||
- `site.rss.enabled`:是否启用 RSS 抓取能力
|
||||
- `site.rss.cacheDir`:缓存目录(建议 `dev/`,仓库默认 gitignore)
|
||||
- `site.rss.fetch.*`:抓取参数(超时、并发、重试、重定向等)
|
||||
- `site.rss.articles.*`:抓取条数与摘要长度(例如每站点最多 8 篇)
|
||||
|
||||
说明:
|
||||
|
||||
- RSS 抓取只影响 `articles` Phase 2(文章条目只读展示),不会影响扩展对“来源站点(sites)”的写回能力(构建会保留影子写回结构)。
|
||||
|
||||
---
|
||||
@@ -26,15 +28,18 @@
|
||||
### 1.2 `site.github.*`(projects 仓库元信息 + 热力图)
|
||||
|
||||
用途:
|
||||
|
||||
- projects 卡片可展示仓库元信息(language/stars/forks 等,只读),由 `npm run sync-projects` 联网抓取并写入缓存。
|
||||
- projects 标题区右侧可选展示 GitHub 贡献热力图。
|
||||
|
||||
关键字段(默认示例见 `config/_default/site.yml`):
|
||||
|
||||
- `site.github.username`:GitHub 用户名;为空则不展示热力图
|
||||
- `site.github.heatmapColor`:热力图主题色(不带 `#`,如 `339af0`)
|
||||
- `site.github.cacheDir`:仓库元信息缓存目录(建议 `dev/`)
|
||||
|
||||
说明:
|
||||
|
||||
- 仓库元信息来自 GitHub API,属于“时效性数据”,不会写回到 `pages/projects.yml`。
|
||||
|
||||
---
|
||||
@@ -44,6 +49,7 @@
|
||||
用途:指定页面使用的模板(对应 `templates/pages/<template>.hbs`,不含扩展名)。
|
||||
|
||||
行为规则:
|
||||
|
||||
- 若 `template` 缺省:优先尝试同名模板(`templates/pages/<pageId>.hbs`),不存在则回退到通用 `page` 模板。
|
||||
- `bookmarks/projects/articles` 等特殊页建议显式配置 `template`,以减少误解。
|
||||
|
||||
@@ -56,6 +62,7 @@
|
||||
当前版本不再回退读取根目录 `config.yml`/`config.yaml`。
|
||||
|
||||
迁移要点:
|
||||
|
||||
- 使用模块化配置目录:`config/user/`(优先级最高,完全替换)或 `config/_default/`(默认示例)。
|
||||
- 推荐迁移方式:复制 `config/_default/` → `config/user/`,再按需修改 `site.yml` 与 `pages/*.yml`。
|
||||
|
||||
@@ -66,6 +73,7 @@
|
||||
当前版本仅从 `site.yml -> navigation` 读取导航配置,不再读取 `navigation.yml`。
|
||||
|
||||
迁移要点:
|
||||
|
||||
- 将原 `navigation.yml` 的数组内容移动到 `config/user/site.yml` 的 `navigation:` 字段下。
|
||||
|
||||
---
|
||||
@@ -75,6 +83,7 @@
|
||||
当前版本不再维护“首页固定叫 `home`”的遗留逻辑(例如把 `pages/home.yml` 的分类提升到顶层 `config.categories`)。
|
||||
|
||||
迁移要点:
|
||||
|
||||
- 不要依赖固定页面 id `home`。
|
||||
- 首页始终由 `site.yml -> navigation` 的**第一项**决定;其分类内容应写在对应的 `pages/<homePageId>.yml` 中。
|
||||
|
||||
@@ -85,10 +94,12 @@
|
||||
历史版本可能通过 `navigation[].active` 指定“默认打开页/首页”。
|
||||
|
||||
当前版本:
|
||||
|
||||
- 首页/默认打开页始终由 `site.yml -> navigation` 的**第一项**决定
|
||||
- `active` 字段将被忽略(即使写了也不会生效)
|
||||
|
||||
迁移要点:
|
||||
|
||||
- 通过调整 `navigation` 数组顺序来设置首页(把希望作为首页的页面放到第一项)。
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user