vitepress 0.22.4 → 1.0.0-draft.1

package/dist/client/theme-default/support/sidebar.js

@@ -0,0 +1,29 @@
+import { ensureStartingSlash } from './utils';
+/**
+ * Get the `Sidebar` from sidebar option. This method will ensure to get correct
+ * sidebar config from `MultiSideBarConfig` with various path combinations such
+ * as matching `guide/` and `/guide/`. If no matching config was found, it will
+ * return empty array.
+ */
+export function getSidebar(sidebar, path) {
+    if (Array.isArray(sidebar)) {
+        return sidebar;
+    }
+    path = ensureStartingSlash(path);
+    for (const dir in sidebar) {
+        // make sure the multi sidebar key starts with slash too
+        if (path.startsWith(ensureStartingSlash(dir))) {
+            return sidebar[dir];
+        }
+    }
+    return [];
+}
+export function getFlatSideBarLinks(sidebar) {
+    const links = [];
+    for (const group of sidebar) {
+        for (const link of group.items) {
+            links.push(link);
+        }
+    }
+    return links;
+}

package/dist/client/theme-default/support/utils.js

@@ -0,0 +1,43 @@
+import { ref } from 'vue';
+import { withBase } from 'vitepress';
+export const HASH_RE = /#.*$/;
+export const EXT_RE = /(index)?\.(md|html)$/;
+export const OUTBOUND_RE = /^[a-z]+:/i;
+const inBrowser = typeof window !== 'undefined';
+const hashRef = ref(inBrowser ? location.hash : '');
+export function isExternal(path) {
+    return OUTBOUND_RE.test(path);
+}
+export function isActive(currentPath, matchPath, asRegex = false) {
+    if (matchPath === undefined) {
+        return false;
+    }
+    currentPath = normalize(`/${currentPath}`);
+    if (asRegex) {
+        return new RegExp(matchPath).test(currentPath);
+    }
+    if (normalize(matchPath) !== currentPath) {
+        return false;
+    }
+    const hashMatch = matchPath.match(HASH_RE);
+    if (hashMatch) {
+        return hashRef.value === hashMatch[0];
+    }
+    return true;
+}
+export function ensureStartingSlash(path) {
+    return /^\//.test(path) ? path : `/${path}`;
+}
+export function normalize(path) {
+    return decodeURI(path).replace(HASH_RE, '').replace(EXT_RE, '');
+}
+export function normalizeLink(url) {
+    if (isExternal(url)) {
+        return url;
+    }
+    const { pathname, search, hash } = new URL(url, 'http://example.com');
+    const normalizedPath = pathname.endsWith('/') || pathname.endsWith('.html')
+        ? url
+        : `${pathname.replace(/(\.md)?$/, '.html')}${search}${hash}`;
+    return withBase(normalizedPath);
+}

package/dist/node/cli.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var serve = require('./serve-3035f99b.js');
+var serve = require('./serve-428d4610.js');
 require('fs');
 require('path');
 require('url');
@@ -94,7 +94,7 @@ var minimist = function (args, opts) {
         var o = obj;
         for (var i = 0; i < keys.length-1; i++) {
             var key = keys[i];
-            if (isConstructorOrProto(o, key)) return;
+            if (key === '__proto__') return;
             if (o[key] === undefined) o[key] = {};
             if (o[key] === Object.prototype || o[key] === Number.prototype
                 || o[key] === String.prototype) o[key] = {};
@@ -103,7 +103,7 @@ var minimist = function (args, opts) {
         }
 
         var key = keys[keys.length - 1];
-        if (isConstructorOrProto(o, key)) return;
+        if (key === '__proto__') return;
         if (o === Object.prototype || o === Number.prototype
             || o === String.prototype) o = {};
         if (o === Array.prototype) o = [];
@@ -267,11 +267,6 @@ function isNumber (x) {
     return /^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/.test(x);
 }
 
-
-function isConstructorOrProto (obj, key) {
-    return key === 'constructor' && typeof obj[key] === 'function' || key === '__proto__';
-}
-
 const argv = minimist(process.argv.slice(2));
 console.log(serve.source.cyan(`vitepress v${require("../../package.json").version}`));
 const command = argv._[0];

package/dist/node/index.d.ts

@@ -17,126 +17,157 @@ 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.
+         * Adds locale menu to the nav. This option should be used when you have
+         * your translated sites outside of the project.
          */
-        editLinks?: boolean
+        localeLinks?: LocaleLinks
 
         /**
-         * Custom text for edit link. Defaults to "Edit this page".
+         * The algolia options. Leave it undefined to disable the search feature.
          */
-        editLinkText?: string
+        algolia?: AlgoliaSearchOptions
 
         /**
-         * 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 carbon ads options. Leave it undefined to disable the ads feature.
          */
-        lastUpdated?: string | boolean
-
-        prevLinks?: boolean
-        nextLinks?: boolean
-
-        locales?: Record<string, LocaleConfig & Omit<Config, 'locales'>>
-
-        algolia?: AlgoliaSearchOptions
-
-        carbonAds?: {
-            carbon: string
-            custom?: string
-            placement: string
-        }
+        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
+
+        /**
+         * If your docs are not at the root of the repo.
+         *
+         * @example 'docs'
+         */
+        dir?: string
 
         /**
-         * @default false
+         * Custom text for edit link.
+         *
+         * @default 'Edit this page'
          */
-        collapsable?: boolean
+        text?: string
+    }
+
+    // social link ---------------------------------------------------------------
+
+    export interface SocialLink {
+        icon: SocialLinkIcon
+        link: string
+    }
+
+    export type SocialLinkIcon =
+    | 'discord'
+    | 'facebook'
+    | 'github'
+    | 'instagram'
+    | 'linkedin'
+    | 'slack'
+    | 'twitter'
+    | 'youtube'
+
+    // locales -------------------------------------------------------------------
+
+    export interface LocaleLinks {
+        text: string
+        items: LocaleLink[]
+    }
 
-        children: SideBarItem[]
+    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 +178,12 @@ export declare namespace DefaultTheme {
         initialQuery?: string
     }
 
-    // locales -------------------------------------------------------------------
+    // carbon ads ----------------------------------------------------------------
 
-    export interface LocaleConfig {
-        /**
-         * Text for the language dropdown.
-         */
-        selectText?: string
-
-        /**
-         * Label for this locale in the language dropdown.
-         */
-        label?: string
+    export interface CarbonAdsOptions {
+        carbon: string
+        custom?: string
+        placement: string
     }
 }
 

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-428d4610.js');
 require('vite');
 require('readline');
 require('assert');