chill/menav
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

feat(readme): 更新文档和配置注释

Browse Source
This commit is contained in:
coolzr
2025-10-19 00:24:03 +08:00
parent aa264cc727
commit 9e2a8b0da4
10 changed files with 221 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
config/_default/navigation.yml
View File

@@ -1,7 +1,12 @@
- name: 首页
icon: fas fa-home
id: home
active: true
# 默认导航配置（请勿直接修改）。
# 建议复制到 config/user/navigation.yml 并按需调整。
# 规则：
# - 每个导航项的 id 必须唯一，并与 pages/<id>.yml 对应
# - 全局仅允许一个 active: true 作为默认激活页面
- name: 首页 # 菜单名称
icon: fas fa-home # Font Awesome 图标类
id: home # 页面标识符（唯一，需与 pages/home.yml 对应）
active: true # 是否默认激活（全局仅一个 true）
- name: 项目
icon: fas fa-project-diagram
id: projects
@@ -13,4 +18,4 @@
id: friends
- name: 书签
icon: fas fa-bookmark
id: bookmarks
id: bookmarks

21
config/_default/pages/articles.yml
View File

@@ -1,17 +1,20 @@
title: 技术文章
subtitle: 分享我的技术文章和学习笔记
# 默认页面配置（请勿直接修改）。
# 建议复制到 config/user/pages/articles.yml 并按需调整。
title: 技术文章 # 页面标题
subtitle: 分享我的技术文章和学习笔记 # 页面副标题
# 指定使用的模板文件名，现有页面模板可见templates\pages
# 指定使用的模板文件名，现有页面模板可见 templates/pages（不含 .hbs）
template: articles
# 页面分类与站点列表
categories:
- name: 最新文章
icon: fas fa-pen
icon: fas fa-pen # 分类图标
sites:
- name: Vue3最佳实践
icon: fab fa-vuejs
description: Vue3组合式API的使用技巧
url: "#"
- name: Vue3最佳实践 # 站点名称
icon: fab fa-vuejs # 文章/站点图标
description: Vue3组合式API的使用技巧 # 摘要
url: "#" # 链接（示例）
- name: JavaScript进阶
icon: fab fa-js
description: JavaScript高级特性解析
@@ -34,4 +37,4 @@ categories:
- name: Node.js实战
icon: fab fa-node-js
description: Node.js服务端开发笔记
url: "#"
url: "#"

18
config/_default/pages/bookmarks.yml
View File

@@ -1,17 +1,21 @@
# 默认页面配置（请勿直接修改）。
# 建议复制到 config/user/pages/bookmarks.yml 并按需调整。
# 说明：该页面通常由“书签导入工具”自动生成，手工修改时请保持字段结构一致。
title: 我的书签
subtitle: 从浏览器导入的书签收藏
# 指定使用的模板文件名，现有页面模板可见templates\pages
# 指定使用的模板文件名，现有页面模板可见 templates/pages（不含 .hbs）
template: bookmarks
# 页面分类与站点列表（大量示例项，按需删减）
categories:
- name: 技术资源
icon: fas fa-folder
icon: fas fa-folder # 分类图标
sites:
- name: GitHub
url: https://github.com/
icon: fab fa-github
description: "从书签导入: GitHub"
- name: GitHub # 站点名称
url: https://github.com/ # http/https URL（favicon 模式将尝试加载站点图标）
icon: fab fa-github # 手动图标（manual 模式显示；favicon 失败时回退）
description: "从书签导入: GitHub" # 描述
- name: Stack Overflow
url: https://stackoverflow.com/
icon: fab fa-stack-overflow
@@ -30,4 +34,4 @@ categories:
- name: LinkedIn
url: https://www.linkedin.com/
icon: fab fa-linkedin
description: "从书签导入: LinkedIn"
description: "从书签导入: LinkedIn"

21
config/_default/pages/friends.yml
View File

@@ -1,17 +1,20 @@
title: 友情链接
subtitle: 优秀的博主和朋友们
# 默认页面配置（请勿直接修改）。
# 建议复制到 config/user/pages/friends.yml 并按需调整。
title: 友情链接 # 页面标题
subtitle: 优秀的博主和朋友们 # 页面副标题
# 指定使用的模板文件名，现有页面模板可见templates\pages
# 指定使用的模板文件名，现有页面模板可见 templates/pages（不含 .hbs）
template: friends
# 页面分类与站点列表
categories:
- name: 技术博主
icon: fas fa-user-friends
icon: fas fa-user-friends # 分类图标
sites:
- name: 小明的博客
icon: fas fa-code
description: 全栈开发工程师，分享技术心得
url: "#"
- name: 小明的博客 # 站点名称
icon: fas fa-code # 站点图标
description: 全栈开发工程师，分享技术心得 # 描述
url: "#" # 链接（示例）
- name: 小红的前端
icon: fas fa-paint-brush
description: 专注前端开发与设计
@@ -30,4 +33,4 @@ categories:
- name: Stack Overflow
icon: fab fa-stack-overflow
description: 程序员问答社区
url: https://stackoverflow.com
url: https://stackoverflow.com

21
config/_default/pages/home.yml
View File

@@ -1,17 +1,20 @@
title: 欢迎使用
subtitle: 个人导航站点
# 默认页面配置（请勿直接修改）。
# 建议复制到 config/user/pages/home.yml 并按需调整。
title: 欢迎使用 # 页面标题
subtitle: 个人导航站点 # 页面副标题
# 指定使用的模板文件名，现有页面模板可见templates\pages
# 指定使用的模板文件名，现有页面模板可见 templates/pages（不含 .hbs）
template: home
# 页面分类与站点列表（可按需增删顺序）
categories:
- name: 常用网站
icon: fas fa-star
icon: fas fa-star # 分类图标（Font Awesome）
sites:
- name: Linux.do
url: https://linux.do/
icon: fab fa-linux
description: 新的理想型社区
- name: Linux.do # 站点名称
url: https://linux.do/ # http/https URL（favicon 模式将尝试加载站点图标）
icon: fab fa-linux # 手动图标：manual 模式使用；favicon 模式下作为回退
description: 新的理想型社区 # 站点描述
- name: Google
url: https://www.google.com
icon: fab fa-google
@@ -214,4 +217,4 @@ categories:
- name: Heroku
url: https://www.heroku.com
icon: fas fa-h-square
description: 应用部署平台
description: 应用部署平台

21
config/_default/pages/projects.yml
View File

@@ -1,17 +1,20 @@
title: 我的项目
subtitle: 这里展示了我的一些个人项目和开源贡献
# 默认页面配置（请勿直接修改）。
# 建议复制到 config/user/pages/projects.yml 并按需调整。
title: 我的项目 # 页面标题
subtitle: 这里展示了我的一些个人项目和开源贡献 # 页面副标题
# 指定使用的模板文件名，现有页面模板可见templates\pages
# 指定使用的模板文件名，现有页面模板可见 templates/pages（不含 .hbs）
template: projects
# 页面分类与站点列表
categories:
- name: 个人项目
icon: fas fa-code
icon: fas fa-code # 分类图标（Font Awesome）
sites:
- name: 个人导航站
icon: fas fa-compass
description: 一个简洁美观的个人导航页面
url: "#"
- name: 个人导航站 # 站点名称
icon: fas fa-compass # 手动图标（manual 模式显示；favicon 模式下作为回退）
description: 一个简洁美观的个人导航页面 # 站点描述
url: "#" # 链接（示例）
- name: Todo List
icon: fas fa-tasks
description: 基于Vue3的待办事项管理器
@@ -30,4 +33,4 @@ categories:
- name: Project B
icon: fab fa-github
description: 开源项目贡献
url: "#"
url: "#"

16
config/_default/site.yml
View File

@@ -1,9 +1,21 @@
# 默认配置（请勿直接修改）。
# 建议复制到 config/user/site.yml 并按需调整；用户配置采用“完全替换”策略，将覆盖默认配置。
# 网站基本信息
title: 我的导航
description: 个人网络导航站
author: Your Name
favicon: favicon.ico
logo_text: 导航站
icons:
# 站点卡片图标模式：
# - favicon：自动根据 URL 加载站点 favicon（失败时回退到 Font Awesome 图标）
# - manual：始终使用手动指定的 Font Awesome 图标（不发起外部请求）
# 隐私提示：启用 favicon 模式会请求第三方服务以获取图标，可能将站点 URL 发送给服务商（详见 README“隐私说明”）。
mode: favicon # 可选: favicon | manual（默认 favicon）
# 字体设置（source: google | system；请确保字体支持相应字重）
fonts:
title:
family: Poppins
@@ -18,11 +30,13 @@ fonts:
weight: 400
source: google
# 个人资料：显示在首页顶部的欢迎信息
profile:
title: Hello,
subtitle: Welcome to My Navigation
description: 导航菜单
# 社交媒体链接：显示在侧边栏底部；可按需增删
social:
- name: GitHub
url: https://github.com
@@ -35,4 +49,4 @@ social:
icon: fab fa-twitter
- name: Steam
url: https://steam.com
icon: fab fa-steam
icon: fab fa-steam