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

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

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