ppage/config.example.yml at main · Mappedinfo/ppage · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# PPage 个人主页配置文件示例
# 这是一个完整的示例配置，展示了所有可用的配置选项
# 运行 npm run init 后会生成指引式的配置文件

# ========================================
# 站点基本信息
# ========================================
site:
  title: "个人主页"
  description: "这是一个基于 Markdown 的个人主页系统"
  author: "Your Name"
  baseUrl: "/"
  favicon: "/vite.svg"  # 网站图标路径，支持 .ico, .png, .svg 等格式
                         # 示例: "/favicon.ico", "/assets/icon.png", "/logo.svg"

# ========================================
# 个人信息
# ========================================
profile:
  name: "Your Name"
  avatar: "/assets/images/avatar.jpg"
  bio: "研究者 | 开发者 | 学习者"
  email: "your.email@example.com"
  location: "City, Country"

# ========================================
# 社交链接
# ========================================
# 支持的图标类型：
# 常见社交平台: github, twitter, linkedin, facebook, instagram, youtube, email,
#               website, medium, reddit, stackoverflow, wechat, weibo, zhihu
# 学术平台: scholar/google-scholar (Google Scholar), orcid (ORCID),
#          researchgate/research-gate (ResearchGate)
social:
  - name: "GitHub"
    icon: "github"
    url: "https://github.com/yourusername"
  - name: "Email"
    icon: "email"
    url: "mailto:your.email@example.com"
  - name: "Twitter"
    icon: "twitter"
    url: "https://twitter.com/yourusername"
  # 学术平台示例：
  # - name: "Google Scholar"
  #   icon: "scholar"
  #   url: "https://scholar.google.com/citations?user=YOUR_ID"
  # - name: "ORCID"
  #   icon: "orcid"
  #   url: "https://orcid.org/YOUR-ORCID-ID"
  # - name: "ResearchGate"
  #   icon: "researchgate"
  #   url: "https://www.researchgate.net/profile/YOUR_PROFILE"

# ========================================
# 导航菜单配置
# ========================================
# showInMobile: 控制在移动端是否默认显示 (false 则放入汉堡菜单)
# order: 控制导航顺序，数值越小越靠前，默认按配置顺序（order 值从 999 开始）
navigation:
  - name: "首页"
    path: "/"
    order: 1            # 排序优先级最高
  - name: "关于"
    path: "/about"
    order: 2
  - name: "项目"
    path: "/projects"
  - name: "博客"
    path: "/posts"
  - name: "文件"
    path: "/files"
  - name: "动态"
    path: "/news"

# ========================================
# 主题配置
# ========================================
theme:
  default: "light"
  available:
    - "light"
    - "dark"
    - "academic"
    - "glass"

# ========================================
# 语言配置
# ========================================
language:
  default: "zh"  # zh(中文) 或 en(英文)

# ========================================
# 页面文案配置（可选）
# ========================================
pageContent:
  about:
    siteDescription:
      zh: "本站点使用 PPage 构建，这是一个纯前端的个人主页生成系统。"
      en: "This site is built with PPage, a pure frontend personal homepage generation system."

# ========================================
# 内容路径配置
# ========================================
content:
  postsPath: "/content/posts"
  pagesPath: "/content/pages"
  filesPath: "/content/files"
  assetsPath: "/assets"

# ========================================
# 文件配置
# ========================================
files:
  # 系统会自动扫描 Markdown 中的文件链接
  # 也可以手动配置文件：
  # - title: "示例论文"
  #   description: "这是一个示例 PDF 文件"
  #   type: "pdf"
  #   path: "/content/files/pdfs/sample.pdf"
  #   preview: true
  #   size: "3.5MB"
  #   relatedPost: "欢迎使用 PPage"
  #   relatedProject: "个人主页系统"

# ========================================
# 项目列表
# ========================================
projects:
  - name: "个人主页系统"
    description: "一个纯前端的个人主页生成系统"
    url: "https://github.com/yourusername/ppage"
    tags:
      - "React"
      - "Vite"
      - "Markdown"

# ========================================
# 友情链接配置
# ========================================
# 展示其他网站、朋友博客、合作伙伴等
links:
  - name: "示例博客"
    description: "这是一个示例友情链接描述"
    url: "https://example.com"
    avatar: "/assets/images/link-avatar.jpg"  # 可选：链接站点的头像或 logo
    tags:
      - "博客"
      - "技术"
  - name: "GitHub"
    description: "世界上最大的代码托管平台"
    url: "https://github.com"
    tags:
      - "开发"
      - "开源"

# ========================================
# 部署配置
# ========================================
deploy:
  repository: "https://github.com/yourusername/ppage"
  branch: "gh-pages"
  customDomain: ""  # 自定义域名，例如: "example.com" 或 "www.example.com"
                     # 留空则不生成 CNAME 文件
                     # 如果配置了自定义域名，部署时会自动生成 CNAME 文件

# ========================================
# Google Analytics 配置
# ========================================
# 用于网站访问数据统计和分析
analytics:
  # Google Analytics 测量ID（GA4）
  # 格式示例: G-XXXXXXXXXX
  # 获取方式:
  #   1. 访问 https://analytics.google.com/
  #   2. 创建或选择媒体资源
  #   3. 创建数据流（Data Stream）
  #   4. 复制测量 ID（以 G- 开头）
  googleAnalytics: ""  # 留空则不启用 Google Analytics

  # 是否在开发环境中启用（默认为 false）
  # true: 开发环境（localhost）也会发送数据到 GA
  # false: 只在生产环境（部署后）发送数据
  enableInDev: false

# ========================================
# 新闻/动态配置
# ========================================
news:
  - title: "论文被 ICML 2025 接收"
    description: "我们的论文《基于深度学习的新方法》被 ICML 2025 接收！"
    type: "paper"
    status: "accepted"
    date: "2025-01-15"
    tags:
      - "Machine Learning"
    url: "https://example.com/paper"