vitepress
Advanced tools
Comparing version 0.20.3 to 0.20.4
@@ -1,23 +0,27 @@ | ||
import { AliasOptions } from 'vite'; | ||
import anchor from 'markdown-it-anchor'; | ||
import { BuildOptions } from 'vite'; | ||
import MarkdownIt from 'markdown-it'; | ||
import { Options } from '@vitejs/plugin-vue'; | ||
import { ServerOptions } from 'vite'; | ||
import { UserConfig as UserConfig_2 } from 'vite'; | ||
import { ViteDevServer } from 'vite'; | ||
import { AllowedComponentProps } from 'vue'; | ||
import { App } from 'vue'; | ||
import { Component } from 'vue'; | ||
import { ComponentCustomProps } from 'vue'; | ||
import { ComponentOptions } from 'vue'; | ||
import { ComponentOptionsMixin } from 'vue'; | ||
import { DefineComponent } from 'vue'; | ||
import { EmitsOptions } from 'vue'; | ||
import { Ref } from 'vue'; | ||
import { RendererElement } from 'vue'; | ||
import { RendererNode } from 'vue'; | ||
import { VNode } from 'vue'; | ||
import { VNodeProps } from 'vue'; | ||
export declare function build(root: string, buildOptions?: BuildOptions & { | ||
mpa?: string; | ||
}): Promise<void>; | ||
export declare const Content: DefineComponent< {}, () => VNode<RendererNode, RendererElement, { | ||
[key: string]: any; | ||
}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<{} & {} & {}>, {}>; | ||
export declare const createMarkdownRenderer: (srcDir: string, options?: MarkdownOptions) => MarkdownRenderer; | ||
export declare const Debug: ComponentOptions<{}, any, any, any, any, any, any, any>; | ||
export declare function createServer(root?: string, serverOptions?: ServerOptions): Promise<ViteDevServer>; | ||
export declare interface EnhanceAppContext { | ||
app: App; | ||
router: Router; | ||
siteData: Ref<SiteData>; | ||
} | ||
/** | ||
* Type config helper | ||
*/ | ||
export declare function defineConfig(config: RawConfigExports): RawConfigExports; | ||
export declare type HeadConfig = | ||
@@ -33,2 +37,4 @@ | [string, Record<string, string>] | ||
export declare const inBrowser: boolean; | ||
export declare interface LocaleConfig { | ||
@@ -43,62 +49,22 @@ lang: string | ||
export declare interface MarkdownOptions extends MarkdownIt.Options { | ||
lineNumbers?: boolean; | ||
config?: (md: MarkdownIt) => void; | ||
anchor?: { | ||
permalink?: anchor.AnchorOptions['permalink']; | ||
}; | ||
attrs?: { | ||
leftDelimiter?: string; | ||
rightDelimiter?: string; | ||
allowedAttributes?: string[]; | ||
}; | ||
toc?: any; | ||
externalLinks?: Record<string, string>; | ||
export declare interface PageData { | ||
relativePath: string | ||
title: string | ||
description: string | ||
headers: Header[] | ||
frontmatter: Record<string, any> | ||
lastUpdated: number | ||
} | ||
export declare interface MarkdownParsedData { | ||
hoistedTags?: string[]; | ||
links?: string[]; | ||
headers?: Header[]; | ||
export declare interface Route { | ||
path: string; | ||
data: PageData; | ||
component: Component | null; | ||
} | ||
export declare interface MarkdownRenderer { | ||
__data: MarkdownParsedData; | ||
render: (src: string, env?: any) => { | ||
html: string; | ||
data: any; | ||
}; | ||
export declare interface Router { | ||
route: Route; | ||
go: (href?: string) => Promise<void>; | ||
} | ||
export declare type RawConfigExports = UserConfig | Promise<UserConfig> | (() => UserConfig | Promise<UserConfig>); | ||
export declare function resolveConfig(root?: string, command?: 'serve' | 'build', mode?: string): Promise<SiteConfig>; | ||
export declare function resolveSiteData(root: string, userConfig?: UserConfig, command?: 'serve' | 'build', mode?: string): Promise<SiteData>; | ||
export declare function resolveSiteDataByRoute(siteData: SiteData, route: string): SiteData; | ||
export declare function serve(options?: ServeOptions): Promise<void>; | ||
export declare interface ServeOptions { | ||
root?: string; | ||
port?: number; | ||
} | ||
export declare interface SiteConfig<ThemeConfig = any> { | ||
root: string; | ||
srcDir: string; | ||
site: SiteData<ThemeConfig>; | ||
configPath: string | undefined; | ||
themeDir: string; | ||
outDir: string; | ||
tempDir: string; | ||
alias: AliasOptions; | ||
pages: string[]; | ||
markdown: MarkdownOptions | undefined; | ||
vue: Options | undefined; | ||
vite: UserConfig_2 | undefined; | ||
mpa: boolean; | ||
} | ||
export declare interface SiteData<ThemeConfig = any> { | ||
@@ -138,29 +104,27 @@ base: string | ||
export declare interface UserConfig<ThemeConfig = any> { | ||
extends?: RawConfigExports; | ||
lang?: string; | ||
base?: string; | ||
title?: string; | ||
description?: string; | ||
head?: HeadConfig[]; | ||
themeConfig?: ThemeConfig; | ||
locales?: Record<string, LocaleConfig>; | ||
markdown?: MarkdownOptions; | ||
/** | ||
* Opitons to pass on to `@vitejs/plugin-vue` | ||
*/ | ||
vue?: Options; | ||
/** | ||
* Vite config | ||
*/ | ||
vite?: UserConfig_2; | ||
srcDir?: string; | ||
srcExclude?: string[]; | ||
/** | ||
* Enable MPA / zero-JS mode | ||
* @experimental | ||
*/ | ||
mpa?: boolean; | ||
export declare interface Theme { | ||
Layout: Component; | ||
NotFound?: Component; | ||
enhanceApp?: (ctx: EnhanceAppContext) => void; | ||
} | ||
export declare function useData<T = any>(): VitePressData<T>; | ||
export declare function useRoute(): Route; | ||
export declare function useRouter(): Router; | ||
export declare interface VitePressData<T = any> { | ||
site: Ref<SiteData<T>>; | ||
page: Ref<PageData>; | ||
theme: Ref<T>; | ||
frontmatter: Ref<PageData['frontmatter']>; | ||
title: Ref<string>; | ||
description: Ref<string>; | ||
lang: Ref<string>; | ||
localePath: Ref<string>; | ||
} | ||
export declare function withBase(path: string): string; | ||
export { } |
{ | ||
"name": "vitepress", | ||
"version": "0.20.3", | ||
"version": "0.20.4", | ||
"description": "Vite & Vue powered static site generator", | ||
@@ -5,0 +5,0 @@ "main": "dist/node/index.js", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
1575931
67
62057
4