vitepress 0.19.2 → 0.20.3

package/dist/client/app/router.js

@@ -53,7 +53,13 @@ export function createRouter(loadPageModule, fallbackComponent) {
                 if (inBrowser) {
                     nextTick(() => {
                         if (targetLoc.hash && !scrollPosition) {
-                            const target = document.querySelector(decodeURIComponent(targetLoc.hash));
+                            let target = null;
+                            try {
+                                target = document.querySelector(decodeURIComponent(targetLoc.hash));
+                            }
+                            catch (e) {
+                                console.warn(e);
+                            }
                             if (target) {
                                 scrollTo(target, targetLoc.hash);
                                 return;
@@ -132,9 +138,15 @@ export function useRoute() {
     return useRouter().route;
 }
 function scrollTo(el, hash, smooth = false) {
-    const target = el.classList.contains('.header-anchor')
-        ? el
-        : document.querySelector(decodeURIComponent(hash));
+    let target = null;
+    try {
+        target = el.classList.contains('.header-anchor')
+            ? el
+            : document.querySelector(decodeURIComponent(hash));
+    }
+    catch (e) {
+        console.warn(e);
+    }
     if (target) {
         const targetTop = target.offsetTop;
         // only smooth scroll if distance is smaller than screen height.

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/client/theme-default/Layout.vue

@@ -89,7 +89,6 @@ const pageClasses = computed(() => {
             v-if="theme.algolia"
             :options="theme.algolia"
             :multilang="isMultiLang"
-            :key="site.lang"
           />
         </slot>
       </template>
@@ -108,17 +107,22 @@ const pageClasses = computed(() => {
 
     <Content v-if="isCustomLayout" />
 
-    <Home v-else-if="enableHome">
-      <template #hero>
-        <slot name="home-hero" />
-      </template>
-      <template #features>
-        <slot name="home-features" />
-      </template>
-      <template #footer>
-        <slot name="home-footer" />
-      </template>
-    </Home>
+    <template v-else-if="enableHome">
+      <!-- A slot for customizing the entire homepage easily -->
+      <slot name="home">
+        <Home>
+          <template #hero>
+            <slot name="home-hero" />
+          </template>
+          <template #features>
+            <slot name="home-features" />
+          </template>
+          <template #footer>
+            <slot name="home-footer" />
+          </template>
+        </Home>
+      </slot>
+    </template>
 
     <Page v-else>
       <template #top>

package/dist/client/theme-default/components/AlgoliaSearchBox.vue

@@ -52,11 +52,29 @@ function update(options: any) {
 
 const { lang } = useData()
 
-function initialize(userOptions: any) {
-  // if the user has multiple locales, the search results should be filtered
-  // based on the language
-  const facetFilters = props.multilang ? ['language:' + lang.value] : []
+// if the user has multiple locales, the search results should be filtered
+// based on the language
+const facetFilters: string[] = props.multilang
+  ? ['language:' + lang.value]
+  : []
+
+if (props.options.searchParameters?.facetFilters) {
+  facetFilters.push(...props.options.searchParameters.facetFilters)
+}
+
+watch(
+  lang,
+  (newLang, oldLang) => {
+    const index = facetFilters.findIndex(
+      (filter) => filter === 'language:' + oldLang
+    )
+    if (index > -1) {
+      facetFilters.splice(index, 1, 'language:' + newLang)
+    }
+  }
+)
 
+function initialize(userOptions: any) {
   docsearch(
     Object.assign({}, userOptions, {
       container: '#docsearch',
@@ -64,23 +82,21 @@ function initialize(userOptions: any) {
       searchParameters: Object.assign({}, userOptions.searchParameters, {
         // pass a custom lang facetFilter to allow multiple language search
         // https://github.com/algolia/docsearch-configs/pull/3942
-        facetFilters: facetFilters.concat(
-          userOptions.searchParameters?.facetFilters || []
-        )
+        facetFilters
       }),
 
       navigator: {
-        navigate: ({ suggestionUrl }: { suggestionUrl: string }) => {
+        navigate: ({ itemUrl }: { itemUrl: string }) => {
           const { pathname: hitPathname } = new URL(
-            window.location.origin + suggestionUrl
+            window.location.origin + itemUrl
           )
 
           // Router doesn't handle same-page navigation so we use the native
           // browser location API for anchor navigation
           if (route.path === hitPathname) {
-            window.location.assign(window.location.origin + suggestionUrl)
+            window.location.assign(window.location.origin + itemUrl)
           } else {
-            router.go(suggestionUrl)
+            router.go(itemUrl)
           }
         }
       },
@@ -132,7 +148,8 @@ function initialize(userOptions: any) {
               router.go(relativeHit)
             },
             children
-          }
+          },
+          __v: null
         }
       }
     })

package/dist/client/theme-default/composables/navLink.js

@@ -11,7 +11,7 @@ export function useNavLink(item) {
             active = new RegExp(item.value.activeMatch).test(routePath);
         }
         else {
-            const itemPath = normalizePath(withBase(item.value.link));
+            const itemPath = normalizePath(item.value.link);
             active =
                 itemPath === '/'
                     ? itemPath === routePath

package/dist/client/theme-default/styles/code.css

@@ -55,6 +55,7 @@ li > div[class*='language-'] {
   -moz-hyphens: none;
   -ms-hyphens: none;
   hyphens: none;
+  background: transparent;
 }
 
 [class*='language-'] pre {
@@ -62,7 +63,6 @@ li > div[class*='language-'] {
   z-index: 1;
   margin: 0;
   padding: 1.25rem 1.5rem;
-  background: transparent;
   overflow-x: auto;
 }
 

package/dist/node/cli.js

@@ -1,6 +1,9 @@
 'use strict';
 
-var serve = require('./serve-5d08e165.js');
+var serve = require('./serve-f83deb60.js');
+require('fs');
+require('path');
+require('url');
 require('vite');
 require('readline');
 require('assert');
@@ -8,12 +11,8 @@ require('events');
 require('stream');
 require('util');
 require('buffer');
-require('path');
-require('fs');
 require('punycode');
 require('prismjs');
-require('url');
-require('@vitejs/plugin-vue');
 require('querystring');
 require('tty');
 require('net');
@@ -275,7 +274,10 @@ if (root) {
   argv.root = root;
 }
 if (!command || command === "dev") {
-  serve.createServer(root, argv).then((server) => server.listen()).catch((err) => {
+  serve.createServer(root, argv).then((server) => server.listen()).then((server) => {
+    console.log();
+    server.printUrls();
+  }).catch((err) => {
     console.error(serve.source.red(`failed to start server. error:
 `), err);
     process.exit(1);

package/dist/node/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var serve = require('./serve-5d08e165.js');
+var serve = require('./serve-f83deb60.js');
 require('vite');
 require('readline');
 require('assert');
@@ -15,7 +15,6 @@ require('fs');
 require('punycode');
 require('prismjs');
 require('url');
-require('@vitejs/plugin-vue');
 require('querystring');
 require('tty');
 require('net');
@@ -27,9 +26,10 @@ require('http');
 
 
 exports.build = serve.build;
+exports.createMarkdownRenderer = serve.createMarkdownRenderer;
 exports.createServer = serve.createServer;
+exports.defineConfig = serve.defineConfig;
 exports.resolveConfig = serve.resolveConfig;
 exports.resolveSiteData = serve.resolveSiteData;
 exports.resolveSiteDataByRoute = serve.resolveSiteDataByRoute;
-exports.resolveUserConfig = serve.resolveUserConfig;
 exports.serve = serve.serve;