vitepress 0.20.2 → 0.20.3

package/dist/client/index.d.ts

@@ -1,28 +1,24 @@
-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>;
-}
+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>]
@@ -34,8 +30,6 @@ export declare interface Header {
     slug: string
 }
 
-export declare const inBrowser: boolean;
-
 export declare interface LocaleConfig {
     lang: string
     title?: string
@@ -45,24 +39,64 @@ export declare interface LocaleConfig {
     selectText?: string
 }
 
-export declare interface PageData {
-    relativePath: string
-    title: string
-    description: string
-    headers: Header[]
-    frontmatter: Record<string, any>
-    lastUpdated: number
+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 Route {
-    path: string;
-    data: PageData;
-    component: Component | null;
+export declare interface MarkdownParsedData {
+    hoistedTags?: string[];
+    links?: string[];
+    headers?: Header[];
 }
 
-export declare interface Router {
-    route: Route;
-    go: (href?: string) => Promise<void>;
+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> {
@@ -99,29 +133,31 @@ export declare interface SiteData<ThemeConfig = any> {
     >
 }
 
-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 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 function withBase(path: string): string;
-
 export { }

package/dist/node/cli.js

@@ -1,6 +1,9 @@
 'use strict';
 
-var serve = require('./serve-c378302d.js');
+var serve = require('./serve-f83deb60.js');
+require('fs');
+require('path');
+require('url');
 require('vite');
 require('readline');
 require('assert');
@@ -8,11 +11,8 @@ require('events');
 require('stream');
 require('util');
 require('buffer');
-require('path');
-require('fs');
 require('punycode');
 require('prismjs');
-require('url');
 require('querystring');
 require('tty');
 require('net');

package/dist/node/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var serve = require('./serve-c378302d.js');
+var serve = require('./serve-f83deb60.js');
 require('vite');
 require('readline');
 require('assert');
@@ -26,6 +26,7 @@ require('http');
 
 
 exports.build = serve.build;
+exports.createMarkdownRenderer = serve.createMarkdownRenderer;
 exports.createServer = serve.createServer;
 exports.defineConfig = serve.defineConfig;
 exports.resolveConfig = serve.resolveConfig;

package/dist/node/{serve-c378302d.js → serve-f83deb60.js}

@@ -65020,6 +65020,7 @@ async function serve(options = {}) {
 }
 
 exports.build = build;
+exports.createMarkdownRenderer = createMarkdownRenderer;
 exports.createServer = createServer;
 exports.defineConfig = defineConfig;
 exports.resolveConfig = resolveConfig;

package/dist/{node/index.d.ts → vitepress.d.ts}

@@ -11,6 +11,8 @@ 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>;
 
 /**
@@ -22,6 +24,12 @@ 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
@@ -46,6 +54,20 @@ export declare interface MarkdownOptions extends MarkdownIt.Options {
     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>;

package/package.json

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