vitepress 0.22.4 → 1.0.0-draft.3

package/dist/node/index.d.ts

@@ -17,126 +17,169 @@ export declare function createServer(root?: string, serverOptions?: ServerOption
 
 export declare namespace DefaultTheme {
     export interface Config {
-        logo?: string
-        nav?: NavItem[] | false
-        sidebar?: SideBarConfig | MultiSideBarConfig
-
         /**
-         * GitHub repository following the format <user>/<project>.
+         * The logo file of the site.
          *
-         * @example `"vuejs/vue-next"`
+         * @example '/logo.svg'
          */
-        repo?: string
+        logo?: string
 
         /**
-         * Customize the header label. Defaults to GitHub/Gitlab/Bitbucket
-         * depending on the provided repo.
-         *
-         * @example `"Contribute!"`
+         * The nav items.
          */
-        repoLabel?: string
+        nav?: NavItem[]
 
         /**
-         * If your docs are in a different repository from your main project.
-         *
-         * @example `"vuejs/docs-next"`
+         * The sidebar items.
          */
-        docsRepo?: string
+        sidebar?: Sidebar
 
         /**
-         * If your docs are not at the root of the repo.
-         *
-         * @example `"docs"`
+         * Info for the edit link. If it's undefined, the edit link feature will
+         * be disabled.
          */
-        docsDir?: string
+        editLink?: EditLink
 
         /**
-         * If your docs are in a different branch. Defaults to `master`.
-         *
-         * @example `"next"`
+         * The social links to be displayed at the end of the nav bar. Perfect for
+         * placing links to social services such as GitHub, Twitter, Facebook, etc.
          */
-        docsBranch?: string
+        socialLinks?: SocialLink[]
 
         /**
-         * Enable links to edit pages at the bottom of the page.
+         * The footer configuration.
          */
-        editLinks?: boolean
+        footer?: Footer
 
         /**
-         * Custom text for edit link. Defaults to "Edit this page".
+         * Adds locale menu to the nav. This option should be used when you have
+         * your translated sites outside of the project.
          */
-        editLinkText?: string
+        localeLinks?: LocaleLinks
 
         /**
-         * 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").
+         * The algolia options. Leave it undefined to disable the search feature.
          */
-        lastUpdated?: string | boolean
-
-        prevLinks?: boolean
-        nextLinks?: boolean
-
-        locales?: Record<string, LocaleConfig & Omit<Config, 'locales'>>
-
         algolia?: AlgoliaSearchOptions
 
-        carbonAds?: {
-            carbon: string
-            custom?: string
-            placement: string
-        }
+        /**
+         * The carbon ads options. Leave it undefined to disable the ads feature.
+         */
+        carbonAds?: CarbonAdsOptions
     }
 
-    // navbar --------------------------------------------------------------------
+    // nav -----------------------------------------------------------------------
 
     export type NavItem = NavItemWithLink | NavItemWithChildren
 
-    export interface NavItemBase {
+    export type NavItemWithLink = {
         text: string
-        target?: string
-        rel?: string
-        ariaLabel?: string
-        activeMatch?: string
-    }
-
-    export interface NavItemWithLink extends NavItemBase {
         link: string
+
+        /**
+         * `activeMatch` is expected to be a regex string. We can't use actual
+         * RegExp object here because it isn't serializable
+         */
+        activeMatch?: string
     }
 
-    export interface NavItemWithChildren extends NavItemBase {
+    export interface NavItemWithChildren {
+        text?: string
         items: NavItemWithLink[]
     }
 
     // sidebar -------------------------------------------------------------------
 
-    export type SideBarConfig = SideBarItem[] | 'auto' | false
+    export type Sidebar = SidebarGroup[] | SidebarMulti
 
-    export interface MultiSideBarConfig {
-        [path: string]: SideBarConfig
+    export interface SidebarMulti {
+        [path: string]: SidebarGroup[]
     }
 
-    export type SideBarItem = SideBarLink | SideBarGroup
+    export interface SidebarGroup {
+        text: string
+        items: SidebarItem[]
+    }
 
-    export interface SideBarLink {
+    export interface SidebarItem {
         text: string
         link: string
     }
 
-    export interface SideBarGroup {
-        text: string
-        link?: string
+    // edit link -----------------------------------------------------------------
+
+    export interface EditLink {
+        /**
+         * Repo of the site.
+         *
+         * @example 'vuejs/docs'
+         */
+        repo: string
+
+        /**
+         * Branch of the repo.
+         *
+         * @default 'main'
+         */
+        branch?: string
 
         /**
-         * @default false
+         * If your docs are not at the root of the repo.
+         *
+         * @example 'docs'
          */
-        collapsable?: boolean
+        dir?: string
 
-        children: SideBarItem[]
+        /**
+         * Custom text for edit link.
+         *
+         * @default 'Edit this page'
+         */
+        text?: string
+    }
+
+    // social link ---------------------------------------------------------------
+
+    export interface SocialLink {
+        icon: SocialLinkIcon
+        link: string
+    }
+
+    export type SocialLinkIcon =
+    | 'discord'
+    | 'facebook'
+    | 'github'
+    | 'instagram'
+    | 'linkedin'
+    | 'slack'
+    | 'twitter'
+    | 'youtube'
+
+    // footer --------------------------------------------------------------------
+
+    export interface Footer {
+        message?: string
+        copyright?: string
+    }
+
+    // locales -------------------------------------------------------------------
+
+    export interface LocaleLinks {
+        text: string
+        items: LocaleLink[]
+    }
+
+    export interface LocaleLink {
+        text: string
+        link: string
     }
 
-    // algolia  ------------------------------------------------------------------
-    // partially copied from @docsearch/react/dist/esm/DocSearch.d.ts
+    // algolia ------------------------------------------------------------------
+
+    /**
+     * The Algolia search options. Partially copied from
+     * `@docsearch/react/dist/esm/DocSearch.d.ts`
+     */
     export interface AlgoliaSearchOptions {
         appId: string
         apiKey: string
@@ -147,18 +190,12 @@ export declare namespace DefaultTheme {
         initialQuery?: string
     }
 
-    // locales -------------------------------------------------------------------
-
-    export interface LocaleConfig {
-        /**
-         * Text for the language dropdown.
-         */
-        selectText?: string
+    // carbon ads ----------------------------------------------------------------
 
-        /**
-         * Label for this locale in the language dropdown.
-         */
-        label?: string
+    export interface CarbonAdsOptions {
+        carbon: string
+        custom?: string
+        placement: string
     }
 }
 
@@ -247,17 +284,22 @@ export declare interface SiteConfig<ThemeConfig = any> extends Pick<UserConfig,
 
 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[]
+    appearance: boolean
     themeConfig: ThemeConfig
     scrollOffset: number | string
     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
@@ -282,11 +324,12 @@ export declare interface SiteData<ThemeConfig = any> {
 
 export declare interface UserConfig<ThemeConfig = any> {
     extends?: RawConfigExports<ThemeConfig>;
-    lang?: string;
     base?: string;
+    lang?: string;
     title?: string;
     description?: string;
     head?: HeadConfig[];
+    appearance?: boolean;
     themeConfig?: ThemeConfig;
     locales?: Record<string, LocaleConfig>;
     markdown?: MarkdownOptions;

package/dist/node/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var serve = require('./serve-3035f99b.js');
+var serve = require('./serve-b5dc02b2.js');
 require('vite');
 require('readline');
 require('assert');