vitepress 0.20.10 → 0.21.3

package/dist/client/app/router.js

@@ -9,8 +9,8 @@ const getDefaultRoute = () => ({
     component: null,
     // this will be set upon initial page load, which is before
     // the app is mounted, so it's guaranteed to be available in
-    // components
-    data: null
+    // components. We just need enough data for 404 pages to render.
+    data: { frontmatter: {} }
 });
 export function createRouter(loadPageModule, fallbackComponent) {
     const route = reactive(getDefaultRoute());

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

@@ -55,7 +55,7 @@ const { lang } = useData()
 // if the user has multiple locales, the search results should be filtered
 // based on the language
 const facetFilters: string[] = props.multilang
-  ? ['language:' + lang.value]
+  ? ['lang:' + lang.value]
   : []
 
 if (props.options.searchParameters?.facetFilters) {
@@ -66,10 +66,10 @@ watch(
   lang,
   (newLang, oldLang) => {
     const index = facetFilters.findIndex(
-      (filter) => filter === 'language:' + oldLang
+      (filter) => filter === 'lang:' + oldLang
     )
     if (index > -1) {
-      facetFilters.splice(index, 1, 'language:' + newLang)
+      facetFilters.splice(index, 1, 'lang:' + newLang)
     }
   }
 )

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

@@ -24,6 +24,9 @@ const { site, theme, localePath } = useData()
   font-size: 1.3rem;
   font-weight: 600;
   color: var(--c-text);
+  display: flex;
+  justify-content: center;
+  align-items: center;
 }
 
 .nav-bar-title:hover {

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

@@ -15,7 +15,7 @@ export function useSideBar() {
         if (frontSidebar === false) {
             return [];
         }
-        // if it's `atuo`, render headers of the current page
+        // if it's `auto`, render headers of the current page
         if (frontSidebar === 'auto') {
             return resolveAutoSidebar(headers, sidebarDepth);
         }

package/dist/node/cli.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var serve = require('./serve-b109daa0.js');
+var serve = require('./serve-d0483577.js');
 require('fs');
 require('path');
 require('url');

package/dist/node/index.d.ts

@@ -15,10 +15,162 @@ export declare const createMarkdownRenderer: (srcDir: string, options?: Markdown
 
 export declare function createServer(root?: string, serverOptions?: ServerOptions): Promise<ViteDevServer>;
 
+export declare namespace DefaultTheme {
+    export interface Config {
+        logo?: string
+        nav?: NavItem[] | false
+        sidebar?: SideBarConfig | MultiSideBarConfig
+
+        /**
+         * GitHub repository following the format <user>/<project>.
+         *
+         * @example `"vuejs/vue-next"`
+         */
+        repo?: string
+
+        /**
+         * Customize the header label. Defaults to GitHub/Gitlab/Bitbucket
+         * depending on the provided repo.
+         *
+         * @example `"Contribute!"`
+         */
+        repoLabel?: string
+
+        /**
+         * If your docs are in a different repository from your main project.
+         *
+         * @example `"vuejs/docs-next"`
+         */
+        docsRepo?: string
+
+        /**
+         * If your docs are not at the root of the repo.
+         *
+         * @example `"docs"`
+         */
+        docsDir?: string
+
+        /**
+         * If your docs are in a different branch. Defaults to `master`.
+         *
+         * @example `"next"`
+         */
+        docsBranch?: string
+
+        /**
+         * Enable links to edit pages at the bottom of the page.
+         */
+        editLinks?: boolean
+
+        /**
+         * Custom text for edit link. Defaults to "Edit this page".
+         */
+        editLinkText?: string
+
+        /**
+         * Show last updated time at the bottom of the page. Defaults to `false`.
+         * If given a string, it will be displayed as a prefix (default value:
+         * "Last Updated").
+         */
+        lastUpdated?: string | boolean
+
+        prevLinks?: boolean
+        nextLinks?: boolean
+
+        locales?: Record<string, LocaleConfig & Omit<Config, 'locales'>>
+
+        algolia?: AlgoliaSearchOptions
+
+        carbonAds?: {
+            carbon: string
+            custom?: string
+            placement: string
+        }
+    }
+
+    // navbar --------------------------------------------------------------------
+
+    export type NavItem = NavItemWithLink | NavItemWithChildren
+
+    export interface NavItemBase {
+        text: string
+        target?: string
+        rel?: string
+        ariaLabel?: string
+        activeMatch?: string
+    }
+
+    export interface NavItemWithLink extends NavItemBase {
+        link: string
+    }
+
+    export interface NavItemWithChildren extends NavItemBase {
+        items: NavItemWithLink[]
+    }
+
+    // sidebar -------------------------------------------------------------------
+
+    export type SideBarConfig = SideBarItem[] | 'auto' | false
+
+    export interface MultiSideBarConfig {
+        [path: string]: SideBarConfig
+    }
+
+    export type SideBarItem = SideBarLink | SideBarGroup
+
+    export interface SideBarLink {
+        text: string
+        link: string
+    }
+
+    export interface SideBarGroup {
+        text: string
+        link?: string
+
+        /**
+         * @default false
+         */
+        collapsable?: boolean
+
+        children: SideBarItem[]
+    }
+
+    // algolia  ------------------------------------------------------------------
+    // partially copied from @docsearch/react/dist/esm/DocSearch.d.ts
+    export interface AlgoliaSearchOptions {
+        appId?: string
+        apiKey: string
+        indexName: string
+        placeholder?: string
+        searchParameters?: any
+        disableUserPersonalization?: boolean
+        initialQuery?: string
+    }
+
+    // locales -------------------------------------------------------------------
+
+    export interface LocaleConfig {
+        /**
+         * Text for the language dropdown.
+         */
+        selectText?: string
+
+        /**
+         * Label for this locale in the language dropdown.
+         */
+        label?: string
+    }
+}
+
 /**
  * Type config helper
  */
-export declare function defineConfig(config: RawConfigExports): RawConfigExports;
+export declare function defineConfig(config: UserConfig<DefaultTheme.Config>): UserConfig<DefaultTheme.Config>;
+
+/**
+ * Type config helper for custom theme config
+ */
+export declare function defineConfigWithTheme<ThemeConfig>(config: UserConfig<ThemeConfig>): UserConfig<ThemeConfig>;
 
 export declare type HeadConfig =
 | [string, Record<string, string>]
@@ -60,15 +212,13 @@ export declare interface MarkdownParsedData {
     headers?: Header[];
 }
 
-export declare interface MarkdownRenderer {
+export declare interface MarkdownRenderer extends MarkdownIt {
+    __path: string;
+    __relativePath: string;
     __data: MarkdownParsedData;
-    render: (src: string, env?: any) => {
-        html: string;
-        data: any;
-    };
 }
 
-export declare type RawConfigExports = UserConfig | Promise<UserConfig> | (() => UserConfig | Promise<UserConfig>);
+export declare type RawConfigExports<ThemeConfig = any> = UserConfig<ThemeConfig> | Promise<UserConfig<ThemeConfig>> | (() => UserConfig<ThemeConfig> | Promise<UserConfig<ThemeConfig>>);
 
 export declare function resolveConfig(root?: string, command?: 'serve' | 'build', mode?: string): Promise<SiteConfig>;
 
@@ -130,7 +280,7 @@ export declare interface SiteData<ThemeConfig = any> {
 }
 
 export declare interface UserConfig<ThemeConfig = any> {
-    extends?: RawConfigExports;
+    extends?: RawConfigExports<ThemeConfig>;
     lang?: string;
     base?: string;
     title?: string;
@@ -140,7 +290,7 @@ export declare interface UserConfig<ThemeConfig = any> {
     locales?: Record<string, LocaleConfig>;
     markdown?: MarkdownOptions;
     /**
-     * Opitons to pass on to `@vitejs/plugin-vue`
+     * Options to pass on to `@vitejs/plugin-vue`
      */
     vue?: Options;
     /**
@@ -149,6 +299,7 @@ export declare interface UserConfig<ThemeConfig = any> {
     vite?: UserConfig_2;
     srcDir?: string;
     srcExclude?: string[];
+    outDir?: string;
     shouldPreload?: (link: string, page: string) => boolean;
     /**
      * Enable MPA / zero-JS mode

package/dist/node/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var serve = require('./serve-b109daa0.js');
+var serve = require('./serve-d0483577.js');
 require('vite');
 require('readline');
 require('assert');
@@ -29,6 +29,7 @@ exports.build = serve.build;
 exports.createMarkdownRenderer = serve.createMarkdownRenderer;
 exports.createServer = serve.createServer;
 exports.defineConfig = serve.defineConfig;
+exports.defineConfigWithTheme = serve.defineConfigWithTheme;
 exports.resolveConfig = serve.resolveConfig;
 exports.resolveSiteData = serve.resolveSiteData;
 exports.resolveSiteDataByRoute = serve.resolveSiteDataByRoute;

package/dist/node/{serve-b109daa0.js → serve-d0483577.js}

@@ -12306,12 +12306,19 @@ const SHARED_PATH = path__default["default"].join(DIST_CLIENT_PATH, "shared");
 const DEFAULT_THEME_PATH = path__default["default"].join(DIST_CLIENT_PATH, "theme-default");
 const SITE_DATA_ID = "@siteData";
 const SITE_DATA_REQUEST_PATH = "/" + SITE_DATA_ID;
-function resolveAliases(themeDir) {
+const vueRuntimePath = "vue/dist/vue.runtime.esm-bundler.js";
+function resolveAliases(root, themeDir) {
   const paths = {
     "/@theme": themeDir,
     "/@shared": SHARED_PATH,
     [SITE_DATA_ID]: SITE_DATA_REQUEST_PATH
   };
+  let vuePath;
+  try {
+    vuePath = require.resolve(vueRuntimePath, { paths: [root] });
+  } catch (e) {
+    vuePath = require.resolve(vueRuntimePath);
+  }
   const aliases = [
     ...Object.keys(paths).map((p) => ({
       find: p,
@@ -12328,7 +12335,7 @@ function resolveAliases(themeDir) {
     { find: /^vitepress\//, replacement: PKG_ROOT + "/" },
     {
       find: /^vue$/,
-      replacement: require.resolve("vue/dist/vue.runtime.esm-bundler.js")
+      replacement: vuePath
     }
   ];
   return aliases;
@@ -13349,10 +13356,14 @@ const resolve = (root, file) => vite.normalizePath(path__default["default"].reso
 function defineConfig(config) {
   return config;
 }
+function defineConfigWithTheme(config) {
+  return config;
+}
 async function resolveConfig(root = process.cwd(), command = "serve", mode = "development") {
   const [userConfig, configPath] = await resolveUserConfig(root, command, mode);
   const site = await resolveSiteData(root, userConfig);
   const srcDir = path__default["default"].resolve(root, userConfig.srcDir || ".");
+  const outDir = userConfig.outDir ? path__default["default"].resolve(root, userConfig.outDir) : resolve(root, "dist");
   const userThemeDir = resolve(root, "theme");
   const themeDir = await lib$1.pathExists(userThemeDir) ? userThemeDir : DEFAULT_THEME_PATH;
   const pages = (await globby(["**.md"], {
@@ -13366,10 +13377,10 @@ async function resolveConfig(root = process.cwd(), command = "serve", mode = "de
     themeDir,
     pages,
     configPath,
-    outDir: resolve(root, "dist"),
-    tempDir: path__default["default"].resolve(APP_PATH, "temp"),
+    outDir,
+    tempDir: resolve(root, ".temp"),
     markdown: userConfig.markdown,
-    alias: resolveAliases(themeDir),
+    alias: resolveAliases(root, themeDir),
     vue: userConfig.vue,
     vite: userConfig.vite,
     shouldPreload: userConfig.shouldPreload,
@@ -13377,7 +13388,7 @@ async function resolveConfig(root = process.cwd(), command = "serve", mode = "de
   };
   return config;
 }
-const supportedConfigExtensions = ["js", "ts", ".mjs", "mts"];
+const supportedConfigExtensions = ["js", "ts", "mjs", "mts"];
 async function resolveUserConfig(root, command, mode) {
   var _a;
   let configPath;
@@ -34187,10 +34198,11 @@ var require$$0$4 = {
 };
 
 const parseEmojis = (str) => {
-  return String(str).replace(/:(.+?):/g, (placeholder, key) => require$$0$4[key] || placeholder);
+  return str.replace(/:(.+?):/g, (placeholder, key) => require$$0$4[key] || placeholder);
 };
-const unescapeHtml = (html) => String(html).replace(/&quot;/g, '"').replace(/&#39;/g, "'").replace(/&#x3A;/g, ":").replace(/&lt;/g, "<").replace(/&gt;/g, ">");
-const removeMarkdownTokens = (str) => String(str).replace(/(\[(.[^\]]+)\]\((.[^)]+)\))/g, "$2").replace(/(`|\*{1,3}|_)(.*?[^\\])\1/g, "$2").replace(/(\\)(\*|_|`|\!|<|\$)/g, "$2");
+const unescapeHtml = (html) => html.replace(/&quot;/g, '"').replace(/&#39;/g, "'").replace(/&#x3A;/g, ":").replace(/&lt;/g, "<").replace(/&gt;/g, ">");
+const removeMarkdownTokens = (str) => str.replace(/(\[(.[^\]]+)\]\((.[^)]+)\))/g, "$2").replace(/(`|\*{1,3}|_)(.*?[^\\])\1/g, "$2").replace(/(\\)(\*|_|`|\!|<|\$)/g, "$2");
+const remvoeCustomAnchor = (str) => str.replace(/\{#([a-z0-9\-_]+?)\}\s*$/, "");
 const trim = (str) => str.trim();
 const removeNonCodeWrappedHTML = (str) => {
   return String(str).replace(/(^|[^><`\\])<.*>([^><`]|$)/g, "$1$2");
@@ -34204,7 +34216,7 @@ const compose = (...processors) => {
     return (str) => next(prev(str));
   });
 };
-const parseHeader = compose(unescapeHtml, parseEmojis, removeMarkdownTokens, trim);
+const parseHeader = compose(unescapeHtml, parseEmojis, remvoeCustomAnchor, removeMarkdownTokens, trim);
 const deeplyParseHeader = compose(removeNonCodeWrappedHTML, parseHeader);
 
 /*!
@@ -34901,7 +34913,7 @@ var markdownItContainer = function container_plugin(md, name, options) {
 };
 
 const containerPlugin = (md) => {
-  md.use(...createContainer("tip", "TIP")).use(...createContainer("info", "INFO")).use(...createContainer("warning", "WARNING")).use(...createContainer("danger", "WARNING")).use(markdownItContainer, "v-pre", {
+  md.use(...createContainer("tip", "TIP")).use(...createContainer("info", "INFO")).use(...createContainer("warning", "WARNING")).use(...createContainer("danger", "WARNING")).use(...createContainer("details", "Details")).use(markdownItContainer, "v-pre", {
     render: (tokens, idx) => tokens[idx].nesting === 1 ? `<div v-pre>
 ` : `</div>
 `
@@ -34916,10 +34928,15 @@ function createContainer(klass, defaultTitle) {
         const token = tokens[idx];
         const info = token.info.trim().slice(klass.length).trim();
         if (token.nesting === 1) {
+          if (klass === "details") {
+            return `<details class="${klass} custom-block">${info ? `<summary>${info}</summary>` : ""}
+`;
+          }
           return `<div class="${klass} custom-block"><p class="custom-block-title">${info || defaultTitle}</p>
 `;
         } else {
-          return `</div>
+          return klass === "details" ? `</details>
+` : `</div>
 `;
         }
       }
@@ -35075,6 +35092,9 @@ const linkPlugin = (md, externalAttrs) => {
         Object.entries(externalAttrs).forEach(([key, val]) => {
           token.attrSet(key, val);
         });
+        if (url.replace(EXTERNAL_URL_RE, "").startsWith("//localhost:")) {
+          pushLink(url);
+        }
       } else if (!url.startsWith("#") && !url.startsWith("mailto:")) {
         normalizeHref(hrefAttr);
       }
@@ -35102,14 +35122,17 @@ const linkPlugin = (md, externalAttrs) => {
     if (!url.startsWith("/") && !/^\.\//.test(url)) {
       url = "./" + url;
     }
+    pushLink(url.replace(/\.html$/, ""));
+    hrefAttr[1] = decodeURI(url);
+  }
+  function pushLink(link) {
     const data = md.__data;
     const links = data.links || (data.links = []);
-    links.push(url.replace(/\.html$/, ""));
-    hrefAttr[1] = decodeURI(url);
+    links.push(link);
   }
 };
 
-const extractHeaderPlugin = (md, include = ["h2", "h3"]) => {
+const headingPlugin = (md, include = ["h2", "h3"]) => {
   md.renderer.rules.heading_open = (tokens, i, options, env, self) => {
     const token = tokens[i];
     if (include.includes(token.tag)) {
@@ -36278,7 +36301,7 @@ const createMarkdownRenderer = (srcDir, options = {}) => {
     linkify: true,
     highlight
   }, options));
-  md.use(componentPlugin).use(highlightLinePlugin).use(preWrapperPlugin).use(snippetPlugin, srcDir).use(hoistPlugin).use(containerPlugin).use(extractHeaderPlugin).use(linkPlugin, __spreadValues$2({
+  md.use(componentPlugin).use(highlightLinePlugin).use(preWrapperPlugin).use(snippetPlugin, srcDir).use(hoistPlugin).use(containerPlugin).use(headingPlugin).use(linkPlugin, __spreadValues$2({
     target: "_blank",
     rel: "noopener noreferrer"
   }, options.externalLinks)).use(markdownItAttrs, options.attrs).use(b, __spreadValues$2({
@@ -36295,16 +36318,6 @@ const createMarkdownRenderer = (srcDir, options = {}) => {
   if (options.lineNumbers) {
     md.use(lineNumberPlugin);
   }
-  const render = md.render;
-  const wrappedRender = (src) => {
-    md.__data = {};
-    const html = render.call(md, src);
-    return {
-      html,
-      data: md.__data
-    };
-  };
-  md.render = wrappedRender;
   return md;
 };
 
@@ -36336,7 +36349,11 @@ function createMarkdownToVueRenderFn(srcDir, options = {}, pages, userDefines, i
       return content2;
     });
     const { content, data: frontmatter } = grayMatter(src);
-    let { html, data } = md.render(content);
+    md.__path = file;
+    md.__relativePath = relativePath;
+    md.__data = {};
+    let html = md.render(content);
+    const data = md.__data;
     if (isBuild) {
       html = html.replace(/\bimport\.meta/g, "import.<wbr/>meta").replace(/\bprocess\.env/g, "process.<wbr/>env");
       if (userDefineRegex) {
@@ -36344,17 +36361,24 @@ function createMarkdownToVueRenderFn(srcDir, options = {}, pages, userDefines, i
       }
     }
     const deadLinks = [];
+    const recordDeadLink = (url) => {
+      console.warn(source.yellow(`
+(!) Found dead link ${source.cyan(url)} in file ${source.white.dim(file)}`));
+      deadLinks.push(url);
+    };
     if (data.links) {
       const dir2 = path__default["default"].dirname(file);
       for (let url of data.links) {
+        if (url.replace(EXTERNAL_URL_RE, "").startsWith("//localhost:")) {
+          recordDeadLink(url);
+          continue;
+        }
         url = url.replace(/[?#].*$/, "").replace(/\.(html|md)$/, "");
         if (url.endsWith("/"))
           url += `index`;
-        const resolved = slash(url.startsWith("/") ? url.slice(1) : path__default["default"].relative(srcDir, path__default["default"].resolve(dir2, url)));
+        const resolved = decodeURIComponent(slash(url.startsWith("/") ? url.slice(1) : path__default["default"].relative(srcDir, path__default["default"].resolve(dir2, url))));
         if (!pages.includes(resolved) && !fs__default["default"].existsSync(path__default["default"].resolve(dir2, publicDir, `${resolved}.html`))) {
-          console.warn(source.yellow(`
-(!) Found dead link ${source.cyan(url)} in file ${source.white.dim(file)}`));
-          deadLinks.push(url);
+          recordDeadLink(url);
         }
       }
     }
@@ -36362,7 +36386,7 @@ function createMarkdownToVueRenderFn(srcDir, options = {}, pages, userDefines, i
       title: inferTitle(frontmatter, content),
       description: inferDescription(frontmatter),
       frontmatter,
-      headers: data.headers,
+      headers: data.headers || [],
       relativePath,
       lastUpdated: Math.round(fs__default["default"].statSync(file).mtimeMs)
     };
@@ -36594,7 +36618,11 @@ function createVitePressPlugin(root, siteConfig, ssr = false, pageToHashMap, cli
     },
     load(id) {
       if (id === SITE_DATA_REQUEST_PATH) {
-        return `export default ${JSON.stringify(JSON.stringify(siteData))}`;
+        let data = siteData;
+        if (config.command === "build") {
+          data = __spreadProps$1(__spreadValues$1({}, siteData), { head: [] });
+        }
+        return `export default ${JSON.stringify(JSON.stringify(data))}`;
       }
     },
     transform(code, id) {
@@ -40035,7 +40063,15 @@ async function renderPage(config, page, result, appChunk, cssChunk, pageToHashMa
   const routePath = `/${page.replace(/\.md$/, "")}`;
   const siteData = resolveSiteDataByRoute(config.site, routePath);
   router.go(routePath);
-  const content = await require("vue/server-renderer").renderToString(app);
+  let rendererPath;
+  try {
+    rendererPath = require.resolve("vue/server-renderer", {
+      paths: [config.root]
+    });
+  } catch (e) {
+    rendererPath = require.resolve("vue/server-renderer");
+  }
+  const content = await require(rendererPath).renderToString(app);
   const pageName = page.replace(/\//g, "_");
   const pageServerJsFileName = pageName + ".js";
   const pageHash = pageToHashMap[pageName.toLowerCase()];
@@ -65095,9 +65131,20 @@ class Polka extends Router {
 
 var polka = opts => new Polka(opts);
 
+function trimChar(str, char) {
+  while (str.charAt(0) === char) {
+    str = str.substring(1);
+  }
+  while (str.charAt(str.length - 1) === char) {
+    str = str.substring(0, str.length - 1);
+  }
+  return str;
+}
 async function serve(options = {}) {
+  var _a, _b;
   const port = options.port !== void 0 ? options.port : 5e3;
   const site = await resolveConfig(options.root, "serve", "production");
+  const base = trimChar((_b = (_a = site == null ? void 0 : site.site) == null ? void 0 : _a.base) != null ? _b : "", "/");
   const compress = compression$1();
   const serve2 = sirv(site.outDir, {
     etag: true,
@@ -65110,18 +65157,28 @@ async function serve(options = {}) {
       }
     }
   });
-  polka().use(compress, serve2).listen(port, (err) => {
-    if (err)
-      throw err;
-    console.log(`Built site served at http://localhost:${port}/
+  if (base) {
+    polka().use(base, compress, serve2).listen(port, (err) => {
+      if (err)
+        throw err;
+      console.log(`Built site served at http://localhost:${port}/${base}/
 `);
-  });
+    });
+  } else {
+    polka().use(compress, serve2).listen(port, (err) => {
+      if (err)
+        throw err;
+      console.log(`Built site served at http://localhost:${port}/
+`);
+    });
+  }
 }
 
 exports.build = build;
 exports.createMarkdownRenderer = createMarkdownRenderer;
 exports.createServer = createServer;
 exports.defineConfig = defineConfig;
+exports.defineConfigWithTheme = defineConfigWithTheme;
 exports.resolveConfig = resolveConfig;
 exports.resolveSiteData = resolveSiteData;
 exports.resolveSiteDataByRoute = resolveSiteDataByRoute;

package/dist/vitepress.d.ts

@@ -15,10 +15,162 @@ export declare const createMarkdownRenderer: (srcDir: string, options?: Markdown
 
 export declare function createServer(root?: string, serverOptions?: ServerOptions): Promise<ViteDevServer>;
 
+export declare namespace DefaultTheme {
+    export interface Config {
+        logo?: string
+        nav?: NavItem[] | false
+        sidebar?: SideBarConfig | MultiSideBarConfig
+
+        /**
+         * GitHub repository following the format <user>/<project>.
+         *
+         * @example `"vuejs/vue-next"`
+         */
+        repo?: string
+
+        /**
+         * Customize the header label. Defaults to GitHub/Gitlab/Bitbucket
+         * depending on the provided repo.
+         *
+         * @example `"Contribute!"`
+         */
+        repoLabel?: string
+
+        /**
+         * If your docs are in a different repository from your main project.
+         *
+         * @example `"vuejs/docs-next"`
+         */
+        docsRepo?: string
+
+        /**
+         * If your docs are not at the root of the repo.
+         *
+         * @example `"docs"`
+         */
+        docsDir?: string
+
+        /**
+         * If your docs are in a different branch. Defaults to `master`.
+         *
+         * @example `"next"`
+         */
+        docsBranch?: string
+
+        /**
+         * Enable links to edit pages at the bottom of the page.
+         */
+        editLinks?: boolean
+
+        /**
+         * Custom text for edit link. Defaults to "Edit this page".
+         */
+        editLinkText?: string
+
+        /**
+         * Show last updated time at the bottom of the page. Defaults to `false`.
+         * If given a string, it will be displayed as a prefix (default value:
+         * "Last Updated").
+         */
+        lastUpdated?: string | boolean
+
+        prevLinks?: boolean
+        nextLinks?: boolean
+
+        locales?: Record<string, LocaleConfig & Omit<Config, 'locales'>>
+
+        algolia?: AlgoliaSearchOptions
+
+        carbonAds?: {
+            carbon: string
+            custom?: string
+            placement: string
+        }
+    }
+
+    // navbar --------------------------------------------------------------------
+
+    export type NavItem = NavItemWithLink | NavItemWithChildren
+
+    export interface NavItemBase {
+        text: string
+        target?: string
+        rel?: string
+        ariaLabel?: string
+        activeMatch?: string
+    }
+
+    export interface NavItemWithLink extends NavItemBase {
+        link: string
+    }
+
+    export interface NavItemWithChildren extends NavItemBase {
+        items: NavItemWithLink[]
+    }
+
+    // sidebar -------------------------------------------------------------------
+
+    export type SideBarConfig = SideBarItem[] | 'auto' | false
+
+    export interface MultiSideBarConfig {
+        [path: string]: SideBarConfig
+    }
+
+    export type SideBarItem = SideBarLink | SideBarGroup
+
+    export interface SideBarLink {
+        text: string
+        link: string
+    }
+
+    export interface SideBarGroup {
+        text: string
+        link?: string
+
+        /**
+         * @default false
+         */
+        collapsable?: boolean
+
+        children: SideBarItem[]
+    }
+
+    // algolia  ------------------------------------------------------------------
+    // partially copied from @docsearch/react/dist/esm/DocSearch.d.ts
+    export interface AlgoliaSearchOptions {
+        appId?: string
+        apiKey: string
+        indexName: string
+        placeholder?: string
+        searchParameters?: any
+        disableUserPersonalization?: boolean
+        initialQuery?: string
+    }
+
+    // locales -------------------------------------------------------------------
+
+    export interface LocaleConfig {
+        /**
+         * Text for the language dropdown.
+         */
+        selectText?: string
+
+        /**
+         * Label for this locale in the language dropdown.
+         */
+        label?: string
+    }
+}
+
 /**
  * Type config helper
  */
-export declare function defineConfig(config: RawConfigExports): RawConfigExports;
+export declare function defineConfig(config: UserConfig<DefaultTheme.Config>): UserConfig<DefaultTheme.Config>;
+
+/**
+ * Type config helper for custom theme config
+ */
+export declare function defineConfigWithTheme<ThemeConfig>(config: UserConfig<ThemeConfig>): UserConfig<ThemeConfig>;
 
 export declare type HeadConfig =
 | [string, Record<string, string>]
@@ -60,15 +212,13 @@ export declare interface MarkdownParsedData {
     headers?: Header[];
 }
 
-export declare interface MarkdownRenderer {
+export declare interface MarkdownRenderer extends MarkdownIt {
+    __path: string;
+    __relativePath: string;
     __data: MarkdownParsedData;
-    render: (src: string, env?: any) => {
-        html: string;
-        data: any;
-    };
 }
 
-export declare type RawConfigExports = UserConfig | Promise<UserConfig> | (() => UserConfig | Promise<UserConfig>);
+export declare type RawConfigExports<ThemeConfig = any> = UserConfig<ThemeConfig> | Promise<UserConfig<ThemeConfig>> | (() => UserConfig<ThemeConfig> | Promise<UserConfig<ThemeConfig>>);
 
 export declare function resolveConfig(root?: string, command?: 'serve' | 'build', mode?: string): Promise<SiteConfig>;
 
@@ -130,7 +280,7 @@ export declare interface SiteData<ThemeConfig = any> {
 }
 
 export declare interface UserConfig<ThemeConfig = any> {
-    extends?: RawConfigExports;
+    extends?: RawConfigExports<ThemeConfig>;
     lang?: string;
     base?: string;
     title?: string;
@@ -140,7 +290,7 @@ export declare interface UserConfig<ThemeConfig = any> {
     locales?: Record<string, LocaleConfig>;
     markdown?: MarkdownOptions;
     /**
-     * Opitons to pass on to `@vitejs/plugin-vue`
+     * Options to pass on to `@vitejs/plugin-vue`
      */
     vue?: Options;
     /**
@@ -149,6 +299,7 @@ export declare interface UserConfig<ThemeConfig = any> {
     vite?: UserConfig_2;
     srcDir?: string;
     srcExclude?: string[];
+    outDir?: string;
     shouldPreload?: (link: string, page: string) => boolean;
     /**
      * Enable MPA / zero-JS mode

package/package.json

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

package/types/default-theme.d.ts

@@ -0,0 +1,146 @@
+export namespace DefaultTheme {
+  export interface Config {
+    logo?: string
+    nav?: NavItem[] | false
+    sidebar?: SideBarConfig | MultiSideBarConfig
+
+    /**
+     * GitHub repository following the format <user>/<project>.
+     *
+     * @example `"vuejs/vue-next"`
+     */
+    repo?: string
+
+    /**
+     * Customize the header label. Defaults to GitHub/Gitlab/Bitbucket
+     * depending on the provided repo.
+     *
+     * @example `"Contribute!"`
+     */
+    repoLabel?: string
+
+    /**
+     * If your docs are in a different repository from your main project.
+     *
+     * @example `"vuejs/docs-next"`
+     */
+    docsRepo?: string
+
+    /**
+     * If your docs are not at the root of the repo.
+     *
+     * @example `"docs"`
+     */
+    docsDir?: string
+
+    /**
+     * If your docs are in a different branch. Defaults to `master`.
+     *
+     * @example `"next"`
+     */
+    docsBranch?: string
+
+    /**
+     * Enable links to edit pages at the bottom of the page.
+     */
+    editLinks?: boolean
+
+    /**
+     * Custom text for edit link. Defaults to "Edit this page".
+     */
+    editLinkText?: string
+
+    /**
+     * Show last updated time at the bottom of the page. Defaults to `false`.
+     * If given a string, it will be displayed as a prefix (default value:
+     * "Last Updated").
+     */
+    lastUpdated?: string | boolean
+
+    prevLinks?: boolean
+    nextLinks?: boolean
+
+    locales?: Record<string, LocaleConfig & Omit<Config, 'locales'>>
+
+    algolia?: AlgoliaSearchOptions
+
+    carbonAds?: {
+      carbon: string
+      custom?: string
+      placement: string
+    }
+  }
+
+  // navbar --------------------------------------------------------------------
+
+  export type NavItem = NavItemWithLink | NavItemWithChildren
+
+  export interface NavItemBase {
+    text: string
+    target?: string
+    rel?: string
+    ariaLabel?: string
+    activeMatch?: string
+  }
+
+  export interface NavItemWithLink extends NavItemBase {
+    link: string
+  }
+
+  export interface NavItemWithChildren extends NavItemBase {
+    items: NavItemWithLink[]
+  }
+
+  // sidebar -------------------------------------------------------------------
+
+  export type SideBarConfig = SideBarItem[] | 'auto' | false
+
+  export interface MultiSideBarConfig {
+    [path: string]: SideBarConfig
+  }
+
+  export type SideBarItem = SideBarLink | SideBarGroup
+
+  export interface SideBarLink {
+    text: string
+    link: string
+  }
+
+  export interface SideBarGroup {
+    text: string
+    link?: string
+
+    /**
+     * @default false
+     */
+    collapsable?: boolean
+
+    children: SideBarItem[]
+  }
+
+  // algolia  ------------------------------------------------------------------
+  // partially copied from @docsearch/react/dist/esm/DocSearch.d.ts
+  export interface AlgoliaSearchOptions {
+    appId?: string
+    apiKey: string
+    indexName: string
+    placeholder?: string
+    searchParameters?: any
+    disableUserPersonalization?: boolean
+    initialQuery?: string
+  }
+
+  // locales -------------------------------------------------------------------
+
+  export interface LocaleConfig {
+    /**
+     * Text for the language dropdown.
+     */
+    selectText?: string
+
+    /**
+     * Label for this locale in the language dropdown.
+     */
+    label?: string
+  }
+}

package/types/index.d.ts

@@ -1,4 +1,2 @@
-export * from './shared'
 export * from '../dist/node/index'
 export * from '../dist/client/index'
-export * from '../dist/client/theme-default/config'

package/types/shared.d.ts

@@ -1,12 +1,14 @@
 // types shared between server and client
 
-export interface LocaleConfig {
-  lang: string
-  title?: string
-  description?: string
-  head?: HeadConfig[]
-  label?: string
-  selectText?: string
+export { DefaultTheme } from './default-theme'
+
+export interface PageData {
+  relativePath: string
+  title: string
+  description: string
+  headers: Header[]
+  frontmatter: Record<string, any>
+  lastUpdated: number
 }
 
 export interface SiteData<ThemeConfig = any> {
@@ -47,17 +49,17 @@ export type HeadConfig =
   | [string, Record<string, string>]
   | [string, Record<string, string>, string]
 
-export interface PageData {
-  relativePath: string
-  title: string
-  description: string
-  headers: Header[]
-  frontmatter: Record<string, any>
-  lastUpdated: number
-}
-
 export interface Header {
   level: number
   title: string
   slug: string
 }
+
+export interface LocaleConfig {
+  lang: string
+  title?: string
+  description?: string
+  head?: HeadConfig[]
+  label?: string
+  selectText?: string
+}