vitepress 0.20.3 → 0.20.4

package/dist/client/index.d.ts

@@ -1,24 +1,28 @@
-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';
-
-export declare function build(root: string, buildOptions?: BuildOptions & {
-    mpa?: string;
-}): Promise<void>;
-
-export declare const createMarkdownRenderer: (srcDir: string, options?: MarkdownOptions) => MarkdownRenderer;
-
-export declare function createServer(root?: string, serverOptions?: ServerOptions): Promise<ViteDevServer>;
-
-/**
- * Type config helper
- */
-export declare function defineConfig(config: RawConfigExports): RawConfigExports;
+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 const Content: DefineComponent<    {}, () => VNode<RendererNode, RendererElement, {
+[key: string]: any;
+}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<{} & {} & {}>, {}>;
+
+export declare const Debug: ComponentOptions<{}, any, any, any, any, any, any, any>;
+
+export declare interface EnhanceAppContext {
+    app: App;
+    router: Router;
+    siteData: Ref<SiteData>;
+}
 
 export declare type HeadConfig =
 | [string, Record<string, string>]
@@ -30,6 +34,8 @@ export declare interface Header {
     slug: string
 }
 
+export declare const inBrowser: boolean;
+
 export declare interface LocaleConfig {
     lang: string
     title?: string
@@ -39,64 +45,24 @@ export declare interface LocaleConfig {
     selectText?: 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 MarkdownParsedData {
-    hoistedTags?: string[];
-    links?: string[];
-    headers?: Header[];
+export declare interface PageData {
+    relativePath: string
+    title: string
+    description: string
+    headers: Header[]
+    frontmatter: Record<string, any>
+    lastUpdated: number
 }
 
-export declare interface MarkdownRenderer {
-    __data: MarkdownParsedData;
-    render: (src: string, env?: any) => {
-        html: string;
-        data: any;
-    };
+export declare interface Route {
+    path: string;
+    data: PageData;
+    component: Component | null;
 }
 
-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 Router {
+    route: Route;
+    go: (href?: string) => Promise<void>;
 }
 
 export declare interface SiteData<ThemeConfig = any> {
@@ -133,31 +99,29 @@ export declare interface SiteData<ThemeConfig = any> {
     >
 }
 
-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 { }

package/dist/node/index.d.ts

@@ -0,0 +1,163 @@
+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';
+
+export declare function build(root: string, buildOptions?: BuildOptions & {
+    mpa?: string;
+}): Promise<void>;
+
+export declare const createMarkdownRenderer: (srcDir: string, options?: MarkdownOptions) => MarkdownRenderer;
+
+export declare function createServer(root?: string, serverOptions?: ServerOptions): Promise<ViteDevServer>;
+
+/**
+ * Type config helper
+ */
+export declare function defineConfig(config: RawConfigExports): RawConfigExports;
+
+export declare type HeadConfig =
+| [string, Record<string, string>]
+| [string, Record<string, string>, string]
+
+export declare interface Header {
+    level: number
+    title: string
+    slug: string
+}
+
+export declare interface LocaleConfig {
+    lang: string
+    title?: string
+    description?: string
+    head?: HeadConfig[]
+    label?: string
+    selectText?: 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 MarkdownParsedData {
+    hoistedTags?: string[];
+    links?: string[];
+    headers?: Header[];
+}
+
+export declare interface MarkdownRenderer {
+    __data: MarkdownParsedData;
+    render: (src: string, env?: any) => {
+        html: string;
+        data: any;
+    };
+}
+
+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> {
+    base: string
+    /**
+     * Language of the site as it should be set on the `html` element.
+     * @example `en-US`, `zh-CN`
+     */
+    lang: string
+    title: string
+    description: string
+    head: HeadConfig[]
+    themeConfig: ThemeConfig
+    locales: Record<string, LocaleConfig>
+    /**
+     * Available locales for the site when it has defined `locales` in its
+     * `themeConfig`. This object is otherwise empty. Keys are paths like `/` or
+     * `/zh/`.
+     */
+    langs: Record<
+    string,
+        {
+        /**
+         * Lang attribute as set on the `<html>` element.
+         * @example `en-US`, `zh-CN`
+         */
+        lang: string
+        /**
+         * Label to display in the language menu.
+         * @example `English`, `简体中文`
+         */
+        label: 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 { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitepress",
-  "version": "0.20.3",
+  "version": "0.20.4",
   "description": "Vite & Vue powered static site generator",
   "main": "dist/node/index.js",
   "typings": "types/index.d.ts",