update docs/*/config.ts: use defineAdditionalConfig() instead of defineConfig

pull/4660/head
Yuxuan Zhang 6 months ago
parent f5bdd2bbca
commit 64000272b4
No known key found for this signature in database
GPG Key ID: 6910B04F3351EF7D

@ -1,10 +1,10 @@
import { createRequire } from 'module' import { createRequire } from 'module'
import { defineConfig, type DefaultTheme } from 'vitepress' import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url) const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json') const pkg = require('vitepress/package.json')
export default defineConfig({ export default defineAdditionalConfig({
lang: 'en-US', lang: 'en-US',
description: 'Vite & Vue powered static site generator.', description: 'Vite & Vue powered static site generator.',

@ -1,16 +1,16 @@
import { createRequire } from 'module' import { createRequire } from 'module'
import { defineConfig, type DefaultTheme } from 'vitepress' import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url) const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json') const pkg = require('vitepress/package.json')
export default defineConfig({ export default defineAdditionalConfig({
lang: 'es-CO', lang: 'es-CO',
description: 'Generador de Sitios Estaticos desarrollado con Vite y Vue.', description: 'Generador de Sitios Estaticos desarrollado con Vite y Vue.',
themeConfig: { themeConfig: {
nav: nav(), nav: nav(),
search: { options: searchOptions() } as DefaultTheme.Config['search'], search: { options: searchOptions() },
sidebar: { sidebar: {
'/es/guide/': { base: '/es/guide/', items: sidebarGuide() }, '/es/guide/': { base: '/es/guide/', items: sidebarGuide() },
'/es/reference/': { base: '/es/reference/', items: sidebarReference() } '/es/reference/': { base: '/es/reference/', items: sidebarReference() }

@ -1,10 +1,10 @@
import { createRequire } from 'module' import { createRequire } from 'module'
import { defineConfig, type DefaultTheme } from 'vitepress' import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url) const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json') const pkg = require('vitepress/package.json')
export default defineConfig({ export default defineAdditionalConfig({
title: 'ویت‌پرس', title: 'ویت‌پرس',
lang: 'fa-IR', lang: 'fa-IR',
description: 'Vite & Vue powered static site generator.', description: 'Vite & Vue powered static site generator.',
@ -20,7 +20,7 @@ export default defineConfig({
}, },
themeConfig: { themeConfig: {
nav: nav(), nav: nav(),
search: { options: searchOptions() } as DefaultTheme.Config['search'], search: { options: searchOptions() },
sidebar: { sidebar: {
'/fa/guide/': { base: '/fa/guide/', items: sidebarGuide() }, '/fa/guide/': { base: '/fa/guide/', items: sidebarGuide() },
'/fa/reference/': { base: '/fa/reference/', items: sidebarReference() } '/fa/reference/': { base: '/fa/reference/', items: sidebarReference() }

@ -1,16 +1,16 @@
import { createRequire } from 'module' import { createRequire } from 'module'
import { defineConfig, type DefaultTheme } from 'vitepress' import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url) const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json') const pkg = require('vitepress/package.json')
export default defineConfig({ export default defineAdditionalConfig({
lang: 'ko-KR', lang: 'ko-KR',
description: 'Vite 및 Vue 기반 정적 사이트 생성기.', description: 'Vite 및 Vue 기반 정적 사이트 생성기.',
themeConfig: { themeConfig: {
nav: nav(), nav: nav(),
search: { options: searchOptions() } as DefaultTheme.Config['search'], search: { options: searchOptions() },
sidebar: { sidebar: {
'/ko/guide/': { base: '/ko/guide/', items: sidebarGuide() }, '/ko/guide/': { base: '/ko/guide/', items: sidebarGuide() },
'/ko/reference/': { base: '/ko/reference/', items: sidebarReference() } '/ko/reference/': { base: '/ko/reference/', items: sidebarReference() }

@ -1,16 +1,16 @@
import { createRequire } from 'module' import { createRequire } from 'module'
import { defineConfig, type DefaultTheme } from 'vitepress' import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url) const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json') const pkg = require('vitepress/package.json')
export default defineConfig({ export default defineAdditionalConfig({
lang: 'pt-BR', lang: 'pt-BR',
description: 'Gerador de Site Estático desenvolvido com Vite e Vue.', description: 'Gerador de Site Estático desenvolvido com Vite e Vue.',
themeConfig: { themeConfig: {
nav: nav(), nav: nav(),
search: { options: searchOptions() } as DefaultTheme.Config['search'], search: { options: searchOptions() },
sidebar: { sidebar: {
'/pt/guide/': { base: '/pt/guide/', items: sidebarGuide() }, '/pt/guide/': { base: '/pt/guide/', items: sidebarGuide() },
'/pt/reference/': { base: '/pt/reference/', items: sidebarReference() } '/pt/reference/': { base: '/pt/reference/', items: sidebarReference() }

@ -1,16 +1,16 @@
import { createRequire } from 'module' import { createRequire } from 'module'
import { defineConfig, type DefaultTheme } from 'vitepress' import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url) const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json') const pkg = require('vitepress/package.json')
export default defineConfig({ export default defineAdditionalConfig({
lang: 'ru-RU', lang: 'ru-RU',
description: 'Генератор статических сайтов на основе Vite и Vue.', description: 'Генератор статических сайтов на основе Vite и Vue.',
themeConfig: { themeConfig: {
nav: nav(), nav: nav(),
search: { options: searchOptions() } as DefaultTheme.Config['search'], search: { options: searchOptions() },
sidebar: { sidebar: {
'/ru/guide/': { base: '/ru/guide/', items: sidebarGuide() }, '/ru/guide/': { base: '/ru/guide/', items: sidebarGuide() },
'/ru/reference/': { base: '/ru/reference/', items: sidebarReference() } '/ru/reference/': { base: '/ru/reference/', items: sidebarReference() }

@ -1,16 +1,16 @@
import { createRequire } from 'module' import { createRequire } from 'module'
import { defineConfig, type DefaultTheme } from 'vitepress' import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url) const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json') const pkg = require('vitepress/package.json')
export default defineConfig({ export default defineAdditionalConfig({
lang: 'zh-Hans', lang: 'zh-Hans',
description: '由 Vite 和 Vue 驱动的静态站点生成器', description: '由 Vite 和 Vue 驱动的静态站点生成器',
themeConfig: { themeConfig: {
nav: nav(), nav: nav(),
search: { options: searchOptions() } as DefaultTheme.Config['search'], search: { options: searchOptions() },
sidebar: { sidebar: {
'/zh/guide/': { base: '/zh/guide/', items: sidebarGuide() }, '/zh/guide/': { base: '/zh/guide/', items: sidebarGuide() },
'/zh/reference/': { base: '/zh/reference/', items: sidebarReference() } '/zh/reference/': { base: '/zh/reference/', items: sidebarReference() }

@ -14,10 +14,7 @@ import type { DefaultTheme } from './defaultTheme'
import { resolvePages } from './plugins/dynamicRoutesPlugin' import { resolvePages } from './plugins/dynamicRoutesPlugin'
import { APPEARANCE_KEY, slash, type HeadConfig, type SiteData } from './shared' import { APPEARANCE_KEY, slash, type HeadConfig, type SiteData } from './shared'
import type { RawConfigExports, SiteConfig, UserConfig } from './siteConfig' import type { RawConfigExports, SiteConfig, UserConfig } from './siteConfig'
import type { import type { AdditionalConfig, AdditionalConfigDict } from '../../types/shared'
AdditionalConfigDict,
AdditionalConfigEntry
} from '../../types/shared'
import { glob } from 'tinyglobby' import { glob } from 'tinyglobby'
export { resolvePages } from './plugins/dynamicRoutesPlugin' export { resolvePages } from './plugins/dynamicRoutesPlugin'
@ -43,6 +40,15 @@ export function defineConfig(config: UserConfig<DefaultTheme.Config>) {
return config return config
} }
/**
* Type additional config helper
*/
export function defineAdditionalConfig(
config: AdditionalConfig<DefaultTheme.Config>
) {
return config
}
/** /**
* Type config helper for custom theme config * Type config helper for custom theme config
*/ */
@ -52,6 +58,15 @@ export function defineConfigWithTheme<ThemeConfig>(
return config return config
} }
/**
* Type additional config helper
*/
export function defineAdditionalConfigWithTheme<ThemeConfig>(
config: AdditionalConfig<ThemeConfig>
) {
return config
}
export async function resolveConfig( export async function resolveConfig(
root: string = process.cwd(), root: string = process.cwd(),
command: 'serve' | 'build' = 'serve', command: 'serve' | 'build' = 'serve',
@ -198,8 +213,9 @@ async function gatherAdditionalConfig(
normalizePath(path.resolve(file)) normalizePath(path.resolve(file))
) )
) )
if (mode === 'development') (configExports.config as any).VP_SOURCE = file if (mode === 'development')
return [id, configExports.config as AdditionalConfigEntry] (configExports.config as any)['[VP_SOURCE]'] = file
return [id, configExports.config as AdditionalConfig]
}) })
) )
return [Object.fromEntries(exports.filter(([id, config]) => config)), deps] return [Object.fromEntries(exports.filter(([id, config]) => config)), deps]

Loading…
Cancel
Save