vitepress 0.17.2 → 0.19.0

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+# [0.19.0](https://github.com/vuejs/vitepress/compare/v0.18.1...v0.19.0) (2021-09-21)
+
+### Features
+
+- upgrade vue, simplify deps ([9030486](https://github.com/vuejs/vitepress/commit/9030486409f10a59115d874b9365f71348ed76c2))
+- use `markdown-it-attrs` for markdown-it plugins ([#393](https://github.com/vuejs/vitepress/issues/393)) ([610e9b7](https://github.com/vuejs/vitepress/commit/610e9b7111462d3aace878017fa4d359cd2ae7ea))
+
+## [0.18.1](https://github.com/vuejs/vitepress/compare/v0.18.0...v0.18.1) (2021-09-16)
+
+### Bug Fixes
+
+- ensure stable pages entry order across builds ([929bcf5](https://github.com/vuejs/vitepress/commit/929bcf50ee634d9fe73adbe2aae5f7038b048e5a))
+
+# [0.18.0](https://github.com/vuejs/vitepress/compare/v0.17.3...v0.18.0) (2021-09-14)
+
+### Features
+
+- map mode + remove deprecated options ([b94b163](https://github.com/vuejs/vitepress/commit/b94b163a3a931fe03e69547391d6ac22eb41b789))
+- support `<script client>` in mpa mode ([e0b6997](https://github.com/vuejs/vitepress/commit/e0b69973f840bfa281fae209da1f1c674c1301a8))
+
+## [0.17.3](https://github.com/vuejs/vitepress/compare/v0.17.2...v0.17.3) (2021-09-09)
+
+### Bug Fixes
+
+- emit prevented hashchange event ([4fb387d](https://github.com/vuejs/vitepress/commit/4fb387d94ea9d7ae28a871929cbbc57e931b8d7a))
+
 ## [0.17.2](https://github.com/vuejs/vitepress/compare/v0.17.1...v0.17.2) (2021-09-08)
 
 ### Bug Fixes

package/README.md

@@ -5,11 +5,7 @@
 
 ---
 
-**:fire: Note this is early WIP! Currently the focus is on making Vite stable and feature complete first. It is not recommended to use this for anything serious yet.**
-
----
-
-VitePress is [VuePress](http://vuepress.vuejs.org/)' little brother, built on top of [vite](https://github.com/vuejs/vite).
+VitePress is [VuePress](http://vuepress.vuejs.org/)' spiritual successor, built on top of [vite](https://github.com/vuejs/vite).
 
 ## Documentation
 
@@ -17,7 +13,7 @@ To check out docs, visit [vitepress.vuejs.org](https://vitepress.vuejs.org).
 
 ## Changelog
 
-Detailed changes for each release are documented in the [release notes](https://github.com/vuejs/vitepress/releases).
+Detailed changes for each release are documented in the [CHANGELOG](https://github.com/vuejs/vitepress/blob/master/CHANGELOG.md).
 
 ## Contribution
 

package/dist/client/app/router.js

@@ -96,6 +96,8 @@ export function createRouter(loadPageModule, fallbackComponent) {
                         // scroll between hash anchors in the same page
                         if (hash && hash !== currentUrl.hash) {
                             history.pushState(null, '', hash);
+                            // still emit the event so we can listen to it in themes
+                            window.dispatchEvent(new Event('hashchange'));
                             // use smooth scroll when clicking on header anchor links
                             scrollTo(link, hash, link.classList.contains('header-anchor'));
                         }

package/dist/client/index.d.ts

@@ -1,9 +1,127 @@
-export type { Router, Route } from './app/router';
-export type { Theme, EnhanceAppContext } from './app/theme';
-export { useData } from './app/data';
-export { useRouter, useRoute } from './app/router';
-export { inBrowser, withBase } from './app/utils';
-export { Content } from './app/components/Content';
-import { ComponentOptions } from 'vue';
-declare const Debug: ComponentOptions<{}, any, any, any, any, any, any, any>;
-export { Debug };
+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>;
+}
+
+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 const inBrowser: boolean;
+
+export declare interface LocaleConfig {
+    lang: string
+    title?: string
+    description?: string
+    head?: HeadConfig[]
+    label?: string
+    selectText?: string
+}
+
+export declare interface PageData {
+    relativePath: string
+    title: string
+    description: string
+    headers: Header[]
+    frontmatter: Record<string, any>
+    lastUpdated: number
+}
+
+export declare interface Route {
+    path: string;
+    data: PageData;
+    component: Component | null;
+}
+
+export declare interface Router {
+    route: Route;
+    go: (href?: string) => Promise<void>;
+}
+
+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[]
+    themeConfig: ThemeConfig
+    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
+     * `/zh/`.
+     */
+    langs: Record<
+    string,
+        {
+        /**
+         * Lang attribute as set on the `<html>` element.
+         * @example `en-US`, `zh-CN`
+         */
+        lang: string
+        /**
+         * Label to display in the language menu.
+         * @example `English`, `简体中文`
+         */
+        label: string
+    }
+    >
+}
+
+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 function withBase(path: string): string;
+
+export { }

package/dist/node/cli.js

@@ -1,41 +1,296 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+'use strict';
+
+var serve = require('./serve-dbc4b971.js');
+require('vite');
+require('readline');
+require('assert');
+require('events');
+require('stream');
+require('util');
+require('buffer');
+require('path');
+require('fs');
+require('punycode');
+require('url');
+require('@vitejs/plugin-vue');
+require('querystring');
+require('tty');
+require('net');
+require('zlib');
+require('constants');
+require('os');
+
+var minimist = function (args, opts) {
+    if (!opts) opts = {};
+    
+    var flags = { bools : {}, strings : {}, unknownFn: null };
+
+    if (typeof opts['unknown'] === 'function') {
+        flags.unknownFn = opts['unknown'];
+    }
+
+    if (typeof opts['boolean'] === 'boolean' && opts['boolean']) {
+      flags.allBools = true;
+    } else {
+      [].concat(opts['boolean']).filter(Boolean).forEach(function (key) {
+          flags.bools[key] = true;
+      });
+    }
+    
+    var aliases = {};
+    Object.keys(opts.alias || {}).forEach(function (key) {
+        aliases[key] = [].concat(opts.alias[key]);
+        aliases[key].forEach(function (x) {
+            aliases[x] = [key].concat(aliases[key].filter(function (y) {
+                return x !== y;
+            }));
+        });
+    });
+
+    [].concat(opts.string).filter(Boolean).forEach(function (key) {
+        flags.strings[key] = true;
+        if (aliases[key]) {
+            flags.strings[aliases[key]] = true;
+        }
+     });
+
+    var defaults = opts['default'] || {};
+    
+    var argv = { _ : [] };
+    Object.keys(flags.bools).forEach(function (key) {
+        setArg(key, defaults[key] === undefined ? false : defaults[key]);
+    });
+    
+    var notFlags = [];
+
+    if (args.indexOf('--') !== -1) {
+        notFlags = args.slice(args.indexOf('--')+1);
+        args = args.slice(0, args.indexOf('--'));
+    }
+
+    function argDefined(key, arg) {
+        return (flags.allBools && /^--[^=]+$/.test(arg)) ||
+            flags.strings[key] || flags.bools[key] || aliases[key];
+    }
+
+    function setArg (key, val, arg) {
+        if (arg && flags.unknownFn && !argDefined(key, arg)) {
+            if (flags.unknownFn(arg) === false) return;
+        }
+
+        var value = !flags.strings[key] && isNumber(val)
+            ? Number(val) : val
+        ;
+        setKey(argv, key.split('.'), value);
+        
+        (aliases[key] || []).forEach(function (x) {
+            setKey(argv, x.split('.'), value);
+        });
+    }
+
+    function setKey (obj, keys, value) {
+        var o = obj;
+        for (var i = 0; i < keys.length-1; i++) {
+            var key = keys[i];
+            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] = {};
+            if (o[key] === Array.prototype) o[key] = [];
+            o = o[key];
+        }
+
+        var key = keys[keys.length - 1];
+        if (key === '__proto__') return;
+        if (o === Object.prototype || o === Number.prototype
+            || o === String.prototype) o = {};
+        if (o === Array.prototype) o = [];
+        if (o[key] === undefined || flags.bools[key] || typeof o[key] === 'boolean') {
+            o[key] = value;
+        }
+        else if (Array.isArray(o[key])) {
+            o[key].push(value);
+        }
+        else {
+            o[key] = [ o[key], value ];
+        }
+    }
+    
+    function aliasIsBoolean(key) {
+      return aliases[key].some(function (x) {
+          return flags.bools[x];
+      });
+    }
+
+    for (var i = 0; i < args.length; i++) {
+        var arg = args[i];
+        
+        if (/^--.+=/.test(arg)) {
+            // Using [\s\S] instead of . because js doesn't support the
+            // 'dotall' regex modifier. See:
+            // http://stackoverflow.com/a/1068308/13216
+            var m = arg.match(/^--([^=]+)=([\s\S]*)$/);
+            var key = m[1];
+            var value = m[2];
+            if (flags.bools[key]) {
+                value = value !== 'false';
+            }
+            setArg(key, value, arg);
+        }
+        else if (/^--no-.+/.test(arg)) {
+            var key = arg.match(/^--no-(.+)/)[1];
+            setArg(key, false, arg);
+        }
+        else if (/^--.+/.test(arg)) {
+            var key = arg.match(/^--(.+)/)[1];
+            var next = args[i + 1];
+            if (next !== undefined && !/^-/.test(next)
+            && !flags.bools[key]
+            && !flags.allBools
+            && (aliases[key] ? !aliasIsBoolean(key) : true)) {
+                setArg(key, next, arg);
+                i++;
+            }
+            else if (/^(true|false)$/.test(next)) {
+                setArg(key, next === 'true', arg);
+                i++;
+            }
+            else {
+                setArg(key, flags.strings[key] ? '' : true, arg);
+            }
+        }
+        else if (/^-[^-]+/.test(arg)) {
+            var letters = arg.slice(1,-1).split('');
+            
+            var broken = false;
+            for (var j = 0; j < letters.length; j++) {
+                var next = arg.slice(j+2);
+                
+                if (next === '-') {
+                    setArg(letters[j], next, arg);
+                    continue;
+                }
+                
+                if (/[A-Za-z]/.test(letters[j]) && /=/.test(next)) {
+                    setArg(letters[j], next.split('=')[1], arg);
+                    broken = true;
+                    break;
+                }
+                
+                if (/[A-Za-z]/.test(letters[j])
+                && /-?\d+(\.\d*)?(e-?\d+)?$/.test(next)) {
+                    setArg(letters[j], next, arg);
+                    broken = true;
+                    break;
+                }
+                
+                if (letters[j+1] && letters[j+1].match(/\W/)) {
+                    setArg(letters[j], arg.slice(j+2), arg);
+                    broken = true;
+                    break;
+                }
+                else {
+                    setArg(letters[j], flags.strings[letters[j]] ? '' : true, arg);
+                }
+            }
+            
+            var key = arg.slice(-1)[0];
+            if (!broken && key !== '-') {
+                if (args[i+1] && !/^(-|--)[^-]/.test(args[i+1])
+                && !flags.bools[key]
+                && (aliases[key] ? !aliasIsBoolean(key) : true)) {
+                    setArg(key, args[i+1], arg);
+                    i++;
+                }
+                else if (args[i+1] && /^(true|false)$/.test(args[i+1])) {
+                    setArg(key, args[i+1] === 'true', arg);
+                    i++;
+                }
+                else {
+                    setArg(key, flags.strings[key] ? '' : true, arg);
+                }
+            }
+        }
+        else {
+            if (!flags.unknownFn || flags.unknownFn(arg) !== false) {
+                argv._.push(
+                    flags.strings['_'] || !isNumber(arg) ? arg : Number(arg)
+                );
+            }
+            if (opts.stopEarly) {
+                argv._.push.apply(argv._, args.slice(i + 1));
+                break;
+            }
+        }
+    }
+    
+    Object.keys(defaults).forEach(function (key) {
+        if (!hasKey(argv, key.split('.'))) {
+            setKey(argv, key.split('.'), defaults[key]);
+            
+            (aliases[key] || []).forEach(function (x) {
+                setKey(argv, x.split('.'), defaults[key]);
+            });
+        }
+    });
+    
+    if (opts['--']) {
+        argv['--'] = new Array();
+        notFlags.forEach(function(key) {
+            argv['--'].push(key);
+        });
+    }
+    else {
+        notFlags.forEach(function(key) {
+            argv._.push(key);
+        });
+    }
+
+    return argv;
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = __importDefault(require("chalk"));
-const minimist_1 = __importDefault(require("minimist"));
-const _1 = require(".");
-const argv = minimist_1.default(process.argv.slice(2));
-console.log(chalk_1.default.cyan(`vitepress v${require('../../package.json').version}`));
-console.log(chalk_1.default.cyan(`vite v${require('vite/package.json').version}`));
-const command = argv._[0];
-const root = argv._[command ? 1 : 0];
-if (root) {
-    argv.root = root;
-}
-if (!command || command === 'dev') {
-    _1.createServer(root, argv)
-        .then((server) => server.listen())
-        .catch((err) => {
-        console.error(chalk_1.default.red(`failed to start server. error:\n`), err);
-        process.exit(1);
+
+function hasKey (obj, keys) {
+    var o = obj;
+    keys.slice(0,-1).forEach(function (key) {
+        o = (o[key] || {});
     });
+
+    var key = keys[keys.length - 1];
+    return key in o;
 }
-else if (command === 'build') {
-    _1.build(root, argv).catch((err) => {
-        console.error(chalk_1.default.red(`build error:\n`), err);
-        process.exit(1);
-    });
+
+function isNumber (x) {
+    if (typeof x === 'number') return true;
+    if (/^0x[0-9a-f]+$/i.test(x)) return true;
+    return /^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/.test(x);
 }
-else if (command === 'serve') {
-    _1.serve(argv).catch((err) => {
-        console.error(chalk_1.default.red(`failed to start server. error:\n`), err);
-        process.exit(1);
-    });
+
+const argv = minimist(process.argv.slice(2));
+console.log(serve.source.cyan(`vitepress v${require("../../package.json").version}`));
+const command = argv._[0];
+const root = argv._[command ? 1 : 0];
+if (root) {
+  argv.root = root;
 }
-else {
-    console.log(chalk_1.default.red(`unknown command "${command}".`));
+if (!command || command === "dev") {
+  serve.createServer(root, argv).then((server) => server.listen()).catch((err) => {
+    console.error(serve.source.red(`failed to start server. error:
+`), err);
+    process.exit(1);
+  });
+} else if (command === "build") {
+  serve.build(root, argv).catch((err) => {
+    console.error(serve.source.red(`build error:
+`), err);
+    process.exit(1);
+  });
+} else if (command === "serve") {
+  serve.serve(argv).catch((err) => {
+    console.error(serve.source.red(`failed to start server. error:
+`), err);
     process.exit(1);
+  });
+} else {
+  console.log(serve.source.red(`unknown command "${command}".`));
+  process.exit(1);
 }
-//# sourceMappingURL=cli.js.map

package/dist/node/index.d.ts

@@ -1,4 +1,138 @@
-export * from './server';
-export * from './build/build';
-export * from './serve/serve';
-export * from './config';
+import { AliasOptions } from 'vite';
+import { AnchorOptions } 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 function createServer(root?: string, serverOptions?: ServerOptions): Promise<ViteDevServer>;
+
+export declare type HeadConfig =
+| [string, Record<string, string>]
+| [string, Record<string, string>, string]
+
+export declare interface LocaleConfig {
+    lang: string
+    title?: string
+    description?: string
+    head?: HeadConfig[]
+    label?: string
+    selectText?: string
+}
+
+export declare interface MarkdownOptions extends MarkdownIt.Options {
+    lineNumbers?: boolean;
+    config?: (md: MarkdownIt) => void;
+    anchor?: {
+        permalink?: AnchorOptions['permalink'];
+    };
+    attrs?: {
+        leftDelimiter?: string;
+        rightDelimiter?: string;
+        allowedAttributes?: string[];
+    };
+    toc?: any;
+    externalLinks?: Record<string, string>;
+}
+
+export declare type RawConfigExports = UserConfig | Promise<UserConfig> | (() => UserConfig | Promise<UserConfig>);
+
+export declare function resolveConfig(root?: string): Promise<SiteConfig>;
+
+export declare function resolveSiteData(root: string, userConfig?: UserConfig): Promise<SiteData>;
+
+export declare function resolveSiteDataByRoute(siteData: SiteData, route: string): SiteData;
+
+export declare function resolveUserConfig(root: string): Promise<UserConfig>;
+
+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;
+    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> {
+    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[]
+    themeConfig: ThemeConfig
+    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
+     * `/zh/`.
+     */
+    langs: Record<
+    string,
+        {
+        /**
+         * Lang attribute as set on the `<html>` element.
+         * @example `en-US`, `zh-CN`
+         */
+        lang: string
+        /**
+         * Label to display in the language menu.
+         * @example `English`, `简体中文`
+         */
+        label: 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 { }