Skip to content

Commit 6400027

Browse files
committed
update docs/*/config.ts: use defineAdditionalConfig() instead of defineConfig
1 parent f5bdd2b commit 6400027

File tree

8 files changed

+42
-26
lines changed

8 files changed

+42
-26
lines changed

docs/config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { createRequire } from 'module'
2-
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
33

44
const require = createRequire(import.meta.url)
55
const pkg = require('vitepress/package.json')
66

7-
export default defineConfig({
7+
export default defineAdditionalConfig({
88
lang: 'en-US',
99
description: 'Vite & Vue powered static site generator.',
1010

docs/es/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
import { createRequire } from 'module'
2-
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
33

44
const require = createRequire(import.meta.url)
55
const pkg = require('vitepress/package.json')
66

7-
export default defineConfig({
7+
export default defineAdditionalConfig({
88
lang: 'es-CO',
99
description: 'Generador de Sitios Estaticos desarrollado con Vite y Vue.',
1010

1111
themeConfig: {
1212
nav: nav(),
13-
search: { options: searchOptions() } as DefaultTheme.Config['search'],
13+
search: { options: searchOptions() },
1414
sidebar: {
1515
'/es/guide/': { base: '/es/guide/', items: sidebarGuide() },
1616
'/es/reference/': { base: '/es/reference/', items: sidebarReference() }

docs/fa/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { createRequire } from 'module'
2-
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
33

44
const require = createRequire(import.meta.url)
55
const pkg = require('vitepress/package.json')
66

7-
export default defineConfig({
7+
export default defineAdditionalConfig({
88
title: 'ویت‌پرس',
99
lang: 'fa-IR',
1010
description: 'Vite & Vue powered static site generator.',
@@ -20,7 +20,7 @@ export default defineConfig({
2020
},
2121
themeConfig: {
2222
nav: nav(),
23-
search: { options: searchOptions() } as DefaultTheme.Config['search'],
23+
search: { options: searchOptions() },
2424
sidebar: {
2525
'/fa/guide/': { base: '/fa/guide/', items: sidebarGuide() },
2626
'/fa/reference/': { base: '/fa/reference/', items: sidebarReference() }

docs/ko/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
import { createRequire } from 'module'
2-
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
33

44
const require = createRequire(import.meta.url)
55
const pkg = require('vitepress/package.json')
66

7-
export default defineConfig({
7+
export default defineAdditionalConfig({
88
lang: 'ko-KR',
99
description: 'Vite 및 Vue 기반 정적 사이트 생성기.',
1010

1111
themeConfig: {
1212
nav: nav(),
13-
search: { options: searchOptions() } as DefaultTheme.Config['search'],
13+
search: { options: searchOptions() },
1414
sidebar: {
1515
'/ko/guide/': { base: '/ko/guide/', items: sidebarGuide() },
1616
'/ko/reference/': { base: '/ko/reference/', items: sidebarReference() }

docs/pt/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
import { createRequire } from 'module'
2-
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
33

44
const require = createRequire(import.meta.url)
55
const pkg = require('vitepress/package.json')
66

7-
export default defineConfig({
7+
export default defineAdditionalConfig({
88
lang: 'pt-BR',
99
description: 'Gerador de Site Estático desenvolvido com Vite e Vue.',
1010

1111
themeConfig: {
1212
nav: nav(),
13-
search: { options: searchOptions() } as DefaultTheme.Config['search'],
13+
search: { options: searchOptions() },
1414
sidebar: {
1515
'/pt/guide/': { base: '/pt/guide/', items: sidebarGuide() },
1616
'/pt/reference/': { base: '/pt/reference/', items: sidebarReference() }

docs/ru/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
import { createRequire } from 'module'
2-
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
33

44
const require = createRequire(import.meta.url)
55
const pkg = require('vitepress/package.json')
66

7-
export default defineConfig({
7+
export default defineAdditionalConfig({
88
lang: 'ru-RU',
99
description: 'Генератор статических сайтов на основе Vite и Vue.',
1010

1111
themeConfig: {
1212
nav: nav(),
13-
search: { options: searchOptions() } as DefaultTheme.Config['search'],
13+
search: { options: searchOptions() },
1414
sidebar: {
1515
'/ru/guide/': { base: '/ru/guide/', items: sidebarGuide() },
1616
'/ru/reference/': { base: '/ru/reference/', items: sidebarReference() }

docs/zh/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
import { createRequire } from 'module'
2-
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
33

44
const require = createRequire(import.meta.url)
55
const pkg = require('vitepress/package.json')
66

7-
export default defineConfig({
7+
export default defineAdditionalConfig({
88
lang: 'zh-Hans',
99
description: '由 Vite 和 Vue 驱动的静态站点生成器',
1010

1111
themeConfig: {
1212
nav: nav(),
13-
search: { options: searchOptions() } as DefaultTheme.Config['search'],
13+
search: { options: searchOptions() },
1414
sidebar: {
1515
'/zh/guide/': { base: '/zh/guide/', items: sidebarGuide() },
1616
'/zh/reference/': { base: '/zh/reference/', items: sidebarReference() }

src/node/config.ts

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@ import type { DefaultTheme } from './defaultTheme'
1414
import { resolvePages } from './plugins/dynamicRoutesPlugin'
1515
import { APPEARANCE_KEY, slash, type HeadConfig, type SiteData } from './shared'
1616
import type { RawConfigExports, SiteConfig, UserConfig } from './siteConfig'
17-
import type {
18-
AdditionalConfigDict,
19-
AdditionalConfigEntry
20-
} from '../../types/shared'
17+
import type { AdditionalConfig, AdditionalConfigDict } from '../../types/shared'
2118
import { glob } from 'tinyglobby'
2219

2320
export { resolvePages } from './plugins/dynamicRoutesPlugin'
@@ -43,6 +40,15 @@ export function defineConfig(config: UserConfig<DefaultTheme.Config>) {
4340
return config
4441
}
4542

43+
/**
44+
* Type additional config helper
45+
*/
46+
export function defineAdditionalConfig(
47+
config: AdditionalConfig<DefaultTheme.Config>
48+
) {
49+
return config
50+
}
51+
4652
/**
4753
* Type config helper for custom theme config
4854
*/
@@ -52,6 +58,15 @@ export function defineConfigWithTheme<ThemeConfig>(
5258
return config
5359
}
5460

61+
/**
62+
* Type additional config helper
63+
*/
64+
export function defineAdditionalConfigWithTheme<ThemeConfig>(
65+
config: AdditionalConfig<ThemeConfig>
66+
) {
67+
return config
68+
}
69+
5570
export async function resolveConfig(
5671
root: string = process.cwd(),
5772
command: 'serve' | 'build' = 'serve',
@@ -198,8 +213,9 @@ async function gatherAdditionalConfig(
198213
normalizePath(path.resolve(file))
199214
)
200215
)
201-
if (mode === 'development') (configExports.config as any).VP_SOURCE = file
202-
return [id, configExports.config as AdditionalConfigEntry]
216+
if (mode === 'development')
217+
(configExports.config as any)['[VP_SOURCE]'] = file
218+
return [id, configExports.config as AdditionalConfig]
203219
})
204220
)
205221
return [Object.fromEntries(exports.filter(([id, config]) => config)), deps]

0 commit comments

Comments
 (0)