Skip to content

Commit c08061e

Browse files
committed
feat(navigation): 优化开发指南文档结构及导航配置
- 将开发指南相关文档从 tutorials 目录移动到 development 目录 - 为新开发指南页面添加 type、id、collection 等元数据字段 - 修正并完善文档中基础教程和 README 的链接地址 - 在配置文件中添加 development 目录启用注释提示 - 更新导航组件,支持动态获取并翻译 development 路由名称 - 为中英文语言包添加 development 对应的翻译项
1 parent 971e34d commit c08061e

6 files changed

Lines changed: 22 additions & 8 deletions

File tree

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: 开发指南
33
description: PPage 开发相关文档中心
4+
type: page
45
order: 0
56
isPinned: true
67
showInDocumentCenter: true
@@ -20,8 +21,8 @@ showInDocumentCenter: true
2021

2122
如果你是第一次参与 PPage 开发,建议按以下顺序阅读:
2223

23-
1. 先阅读项目根目录的 [README.md](../../../readme.md) 了解项目概况
24-
2. 查看 [基础教程](../basic/) 了解如何使用 PPage
24+
1. 先阅读项目根目录的 README.md 了解项目概况
25+
2. 查看 [基础教程](/tutorials) 了解如何使用 PPage
2526
3. 阅读本开发指南了解开发流程
2627

2728
## 🔧 开发环境

content/tutorials/development/release-guide.md renamed to content/development/release-guide.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: GitHub Release 发布指南
33
description: 详细介绍如何在 GitHub 上发布新版本
4+
id: release-guide
5+
type: page
6+
collection: development
47
parent: 开发指南
58
order: 1
69
showInDocumentCenter: true

public/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ content:
7070

7171
# 文档集合配置
7272
# 控制哪些文件夹被自动扫描和显示
73+
# 注意:这里配置的是 content/ 目录下的顶级文件夹
7374
# enabled: true 表示启用此文件夹的自动扫描
7475
# enabled: false 表示禁用,该文件夹不会出现在导航中
7576
collections:

src/components/layout/Header.jsx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ function getNavigationLabel(path, t) {
2323
'/files': 'pages.files',
2424
'/news': 'pages.news',
2525
'/tutorials': 'pages.tutorials',
26+
'/development': 'pages.development',
2627
}
2728

2829
return t(pathToI18nKey[path]) || path
@@ -41,12 +42,18 @@ export function Header({ folderConfigs = [] }) {
4142
...navigation,
4243
...folderConfigs
4344
.filter(config => config.showInNavigation !== false) // 过滤不显示的项
44-
.map(config => ({
45-
name: config.title,
46-
path: `/${config.name}`,
47-
isDynamic: true,
48-
showInMobile: config.showInMobile ?? false, // 使用 config 中的配置
49-
})),
45+
.map(config => {
46+
// 尝试使用 i18n 翻译,如果没有则使用 index.md 中的 title
47+
const i18nKey = `pages.${config.name}`
48+
const translatedTitle = t(i18nKey)
49+
50+
return {
51+
name: translatedTitle === i18nKey ? config.title : translatedTitle,
52+
path: `/${config.name}`,
53+
isDynamic: true,
54+
showInMobile: config.showInMobile ?? false, // 使用 config 中的配置
55+
}
56+
}),
5057
]
5158

5259
// 分离移动端显示和汉堡菜单中的导航项

src/i18n/locales/en.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export const en = {
2222
files: 'Files',
2323
news: 'News',
2424
tutorials: 'Tutorials',
25+
development: 'Development',
2526
},
2627

2728
// Home page

src/i18n/locales/zh.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export const zh = {
2222
files: '文件',
2323
news: '动态',
2424
tutorials: '教程中心',
25+
development: '开发指南',
2526
},
2627

2728
// 首页

0 commit comments

Comments
 (0)