Skip to content

Commit e45ccd8

Browse files
SunnyHazeSunnyHaze
committed
[update] finalize file structure easy to follow
1 parent 18d1885 commit e45ccd8

38 files changed

+519
-225
lines changed

‎docs/.vuepress/navbar.ts‎

Lines changed: 0 additions & 80 deletions
This file was deleted.

‎docs/.vuepress/navbars/en/index.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
/**
2+
* @see https://theme-plume.vuejs.press/config/navigation/ 查看文档了解配置详情
3+
*
4+
* Navbar 配置文件，它在 `.vuepress/plume.config.ts` 中被导入。
5+
*/
6+
7+
import { defineNavbarConfig } from 'vuepress-theme-plume'
8+
9+
export const enNavbar = defineNavbarConfig([
10+
// { text: 'Home', link: '/' },
11+
// { text: 'Blog', link: '/blog/' },
12+
// { text: 'Tags', link: '/blog/tags/' },
13+
// { text: 'Archives', link: '/blog/archives/' },
14+
{
15+
text: 'Guide',
16+
// link: '/en/guide/',
17+
icon: 'icon-park-outline:guide-board',
18+
items: [
19+
{
20+
text: 'Installation',
21+
link: '/en/note/guide/quickstart/install.md',
22+
icon: 'material-symbols-light:download-rounded'
23+
},
24+
]
25+
},
26+
{
27+
text: 'API Reference',
28+
link: '/en/blog/',
29+
icon: 'material-symbols:article-outline'
30+
},
31+
{
32+
text: 'Developer Guide',
33+
items: [
34+
{ text: "logging", link: '/en/dev_guide/logging.md' },
35+
{ text: "testcase", link: '/en/dev_guide/testcase.md' },
36+
]
37+
},
38+
{
39+
text: 'Notes',
40+
items: [
41+
{ text: 'Demo', link: '/en/notes/demo/README.md' }
42+
]
43+
},
44+
])

‎docs/.vuepress/navbars/index.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export * from './en/index.js'
2+
export * from './zh/index.js'

‎docs/.vuepress/navbars/zh/index.ts‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
/**
2+
* @see https://theme-plume.vuejs.press/config/navigation/ 查看文档了解配置详情
3+
*
4+
* Navbar 配置文件，它在 `.vuepress/plume.config.ts` 中被导入。
5+
*/
6+
7+
import { defineNavbarConfig } from 'vuepress-theme-plume'
8+
9+
export const zhNavbar = defineNavbarConfig([
10+
// { text: '首页', link: '/zh/' },
11+
// { text: '博客', link: '/zh/blog/' },
12+
// { text: '标签', link: '/zh/blog/tags/' },
13+
// { text: '归档', link: '/zh/blog/archives/' },
14+
{
15+
text: '指南',
16+
// link: '/zh/guide/',
17+
icon: 'icon-park-outline:guide-board',
18+
items: [
19+
20+
{
21+
text: '基本信息',
22+
items: [
23+
{
24+
text: '简介',
25+
link: '/zh/notes/guide/basicinfo/intro.md',
26+
icon: 'material-symbols-light:download-rounded',
27+
activeMatch: '^/guide/'
28+
},
29+
{
30+
text: '框架设计',
31+
link: '/zh/notes/guide/basicinfo/framework.md',
32+
icon: 'material-symbols-light:download-rounded',
33+
activeMatch: '^/guide/'
34+
},
35+
]
36+
},
37+
{
38+
text: '快速开始',
39+
items: [
40+
{
41+
text: '安装',
42+
link: '/zh/notes/guide/quickstart/install.md',
43+
icon: 'material-symbols-light:download-rounded',
44+
activeMatch: '^/guide/'
45+
},
46+
]
47+
},
48+
49+
50+
]
51+
},
52+
{
53+
text: 'API 文档',
54+
link: '/zh/notes/api/1.home.md',
55+
icon: 'material-symbols:article-outline'
56+
},
57+
{
58+
text: '开发者指南',
59+
// items: [
60+
// { text: "PR规范", link: '/zh/notes/dev_guide/pull_request.md' },
61+
// { text: "日志", link: '/zh/notes/dev_guide/logging.md' },
62+
// { text: "测试用例", link: '/zh/notes/dev_guide/testcase.md' },
63+
// ]
64+
link: '/zh/notes/dev_guide/1.index_guide.md',
65+
},
66+
// {
67+
// text: '笔记',
68+
// items: [{ text: '示例', link: '/zh/notes/demo/README.md' }]
69+
// },
70+
])
71+

‎docs/.vuepress/notes.ts‎

Lines changed: 0 additions & 73 deletions
This file was deleted.

‎docs/.vuepress/notes/en/guide.ts‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
import type { ThemeNote } from 'vuepress-theme-plume'
2+
import { defineNoteConfig } from 'vuepress-theme-plume'
3+
4+
export const Guide: ThemeNote = defineNoteConfig({
5+
dir: 'guide',
6+
link: '/guide/',
7+
sidebar: [
8+
{
9+
text: 'Quick Start',
10+
collapsed: false,
11+
icon: 'carbon:idea',
12+
prefix: 'quickstart',
13+
items: [
14+
'install',
15+
// 'usage',
16+
// 'project-structure',
17+
// 'write',
18+
// 'blog',
19+
// 'document',
20+
// 'international',
21+
// 'deployment',
22+
// 'optimize-build',
23+
],
24+
},
25+
{
26+
text: 'Write',
27+
icon: 'fluent-mdl2:edit-create',
28+
collapsed: false,
29+
items: [
30+
{
31+
text: 'markdown',
32+
icon: 'material-symbols:markdown-outline',
33+
prefix: 'markdown',
34+
collapsed: true,
35+
items: [
36+
'basic',
37+
'extensions',
38+
'icons',
39+
'mark',
40+
'plot',
41+
'abbr',
42+
'annotation',
43+
'card',
44+
'steps',
45+
'file-tree',
46+
'tabs',
47+
'timeline',
48+
'demo-wrapper',
49+
'collapse',
50+
'npm-to',
51+
'caniuse',
52+
'include',
53+
],
54+
},
55+
],
56+
},
57+
{
58+
text: 'Customization',
59+
icon: 'material-symbols:dashboard-customize-outline-rounded',
60+
collapsed: false,
61+
prefix: 'custom',
62+
items: [
63+
'home',
64+
'style',
65+
],
66+
},
67+
],
68+
})

‎docs/.vuepress/notes/en/index.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import type { ThemeNoteListOptions } from 'vuepress-theme-plume'
2+
import { defineNotesConfig } from 'vuepress-theme-plume'
3+
import { Guide } from './guide'
4+
5+
export const enNotes: ThemeNoteListOptions = defineNotesConfig({
6+
dir: 'en/notes',
7+
link: '/en/',
8+
notes: [
9+
Guide,
10+
],
11+
})

‎docs/.vuepress/notes/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export * from './en/index.ts'
2+
export * from './zh/index.ts'
3+

‎docs/.vuepress/notes/zh/api.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import type { ThemeNote } from 'vuepress-theme-plume'
2+
import { defineNoteConfig } from 'vuepress-theme-plume'
3+
4+
export const APIGuide: ThemeNote = defineNoteConfig({
5+
dir: 'api',
6+
link: '/api/',
7+
sidebar: 'auto'
8+
})

‎docs/.vuepress/notes/zh/dev_guide.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import type { ThemeNote } from 'vuepress-theme-plume'
2+
import { defineNoteConfig } from 'vuepress-theme-plume'
3+
4+
export const DevGuide: ThemeNote = defineNoteConfig({
5+
dir: 'dev_guide',
6+
link: '/dev_guide/',
7+
sidebar: 'auto'
8+
})

0 commit comments

Comments
 (0)