vitepress 0.22.2 → 1.0.0-draft.1

package/dist/node/index.d.ts

@@ -11,134 +11,165 @@ export declare function build(root: string, buildOptions?: BuildOptions & {
     mpa?: string;
 }): Promise<void>;
 
-export declare const createMarkdownRenderer: (srcDir: string, options?: MarkdownOptions) => MarkdownRenderer;
+export declare const createMarkdownRenderer: (srcDir: string, options: MarkdownOptions | undefined, base: string) => MarkdownRenderer;
 
 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>.
+         * 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
+        appId: string
         apiKey: string
         indexName: string
         placeholder?: 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-cf4b2162.js');
+var serve = require('./serve-428d4610.js');
 require('vite');
 require('readline');
 require('assert');

package/dist/node/{serve-cf4b2162.js → serve-428d4610.js}

@@ -35100,7 +35100,7 @@ const preWrapperPlugin = (md) => {
 };
 
 const indexRE = /(^|.*\/)index.md(#?.*)$/i;
-const linkPlugin = (md, externalAttrs) => {
+const linkPlugin = (md, externalAttrs, base) => {
   md.renderer.rules.link_open = (tokens, idx, options, env, self) => {
     const token = tokens[idx];
     const hrefIndex = token.attrIndex("href");
@@ -35115,7 +35115,7 @@ const linkPlugin = (md, externalAttrs) => {
         if (url.replace(EXTERNAL_URL_RE, "").startsWith("//localhost:")) {
           pushLink(url);
         }
-      } else if (!url.startsWith("#") && !url.startsWith("mailto:")) {
+      } else if (!url.startsWith("#") && !url.startsWith("mailto:") && !/\.(?!html|md)\w+($|\?)/i.test(url)) {
         normalizeHref(hrefAttr);
       }
       hrefAttr[1] = hrefAttr[1].replace(/\bimport\.meta/g, "import%2Emeta").replace(/\bprocess\.env/g, "process%2Eenv");
@@ -35129,7 +35129,7 @@ const linkPlugin = (md, externalAttrs) => {
       const [, path, hash] = indexMatch;
       url = path + hash;
     } else {
-      let cleanUrl = url.replace(/\#.*$/, "").replace(/\?.*$/, "");
+      let cleanUrl = url.replace(/[?#].*$/, "");
       if (cleanUrl.endsWith(".md")) {
         cleanUrl = cleanUrl.replace(/\.md$/, ".html");
       }
@@ -35143,6 +35143,9 @@ const linkPlugin = (md, externalAttrs) => {
       url = "./" + url;
     }
     pushLink(url.replace(/\.html$/, ""));
+    if (url.startsWith("/")) {
+      url = `${base}${url}`.replace(/\/+/g, "/");
+    }
     hrefAttr[1] = decodeURI(url);
   }
   function pushLink(link) {
@@ -35171,6 +35174,17 @@ const headingPlugin = (md, include = ["h2", "h3"]) => {
   };
 };
 
+const imagePlugin = (md) => {
+  md.renderer.rules.image = (tokens, idx, options, env, self) => {
+    const token = tokens[idx];
+    const url = token.attrGet("src");
+    if (url && !EXTERNAL_URL_RE.test(url) && !/^\.?\//.test(url)) {
+      token.attrSet("src", "./" + url);
+    }
+    return self.renderToken(tokens, idx, options);
+  };
+};
+
 var e=!1,n={false:"push",true:"unshift",after:"push",before:"unshift"},t={isPermalinkSymbol:!0};function r(r,a,i,l){var o;if(!e){var c="Using deprecated markdown-it-anchor permalink option, see https://github.com/valeriangalliat/markdown-it-anchor#todo-anchor-or-file";"object"==typeof process&&process&&process.emitWarning?process.emitWarning(c):console.warn(c),e=!0;}var s=[Object.assign(new i.Token("link_open","a",1),{attrs:[].concat(a.permalinkClass?[["class",a.permalinkClass]]:[],[["href",a.permalinkHref(r,i)]],Object.entries(a.permalinkAttrs(r,i)))}),Object.assign(new i.Token("html_block","",0),{content:a.permalinkSymbol,meta:t}),new i.Token("link_close","a",-1)];a.permalinkSpace&&i.tokens[l+1].children[n[a.permalinkBefore]](Object.assign(new i.Token("text","",0),{content:" "})),(o=i.tokens[l+1].children)[n[a.permalinkBefore]].apply(o,s);}function a(e){return "#"+e}function i(e){return {}}var l={class:"header-anchor",symbol:"#",renderHref:a,renderAttrs:i};function o(e){function n(t){return t=Object.assign({},n.defaults,t),function(n,r,a,i){return e(n,t,r,a,i)}}return n.defaults=Object.assign({},l),n.renderPermalinkImpl=e,n}var c=o(function(e,r,a,i,l){var o,c=[Object.assign(new i.Token("link_open","a",1),{attrs:[].concat(r.class?[["class",r.class]]:[],[["href",r.renderHref(e,i)]],r.ariaHidden?[["aria-hidden","true"]]:[],Object.entries(r.renderAttrs(e,i)))}),Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t}),new i.Token("link_close","a",-1)];r.space&&i.tokens[l+1].children[n[r.placement]](Object.assign(new i.Token("text","",0),{content:" "})),(o=i.tokens[l+1].children)[n[r.placement]].apply(o,c);});Object.assign(c.defaults,{space:!0,placement:"after",ariaHidden:!1});var s$1=o(c.renderPermalinkImpl);s$1.defaults=Object.assign({},c.defaults,{ariaHidden:!0});var d$1=o(function(e,n,t,r,a){var i=[Object.assign(new r.Token("link_open","a",1),{attrs:[].concat(n.class?[["class",n.class]]:[],[["href",n.renderHref(e,r)]],Object.entries(n.renderAttrs(e,r)))})].concat(n.safariReaderFix?[new r.Token("span_open","span",1)]:[],r.tokens[a+1].children,n.safariReaderFix?[new r.Token("span_close","span",-1)]:[],[new r.Token("link_close","a",-1)]);r.tokens[a+1]=Object.assign(new r.Token("inline","",0),{children:i});});Object.assign(d$1.defaults,{safariReaderFix:!1});var u=o(function(e,r,a,i,l){var o;if(!["visually-hidden","aria-label","aria-describedby","aria-labelledby"].includes(r.style))throw new Error("`permalink.linkAfterHeader` called with unknown style option `"+r.style+"`");if(!["aria-describedby","aria-labelledby"].includes(r.style)&&!r.assistiveText)throw new Error("`permalink.linkAfterHeader` called without the `assistiveText` option in `"+r.style+"` style");if("visually-hidden"===r.style&&!r.visuallyHiddenClass)throw new Error("`permalink.linkAfterHeader` called without the `visuallyHiddenClass` option in `visually-hidden` style");var c=i.tokens[l+1].children.filter(function(e){return "text"===e.type||"code_inline"===e.type}).reduce(function(e,n){return e+n.content},""),s=[],d=[];r.class&&d.push(["class",r.class]),d.push(["href",r.renderHref(e,i)]),d.push.apply(d,Object.entries(r.renderAttrs(e,i))),"visually-hidden"===r.style?(s.push(Object.assign(new i.Token("span_open","span",1),{attrs:[["class",r.visuallyHiddenClass]]}),Object.assign(new i.Token("text","",0),{content:r.assistiveText(c)}),new i.Token("span_close","span",-1)),r.space&&s[n[r.placement]](Object.assign(new i.Token("text","",0),{content:" "})),s[n[r.placement]](Object.assign(new i.Token("span_open","span",1),{attrs:[["aria-hidden","true"]]}),Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t}),new i.Token("span_close","span",-1))):s.push(Object.assign(new i.Token("html_inline","",0),{content:r.symbol,meta:t})),"aria-label"===r.style?d.push(["aria-label",r.assistiveText(c)]):["aria-describedby","aria-labelledby"].includes(r.style)&&d.push([r.style,e]);var u=[Object.assign(new i.Token("link_open","a",1),{attrs:d})].concat(s,[new i.Token("link_close","a",-1)]);(o=i.tokens).splice.apply(o,[l+3,0].concat(u));});function f(e,n,t,r){var a=e,i=r;if(t&&Object.prototype.hasOwnProperty.call(n,a))throw new Error("User defined `id` attribute `"+e+"` is not unique. Please fix it in your Markdown to continue.");for(;Object.prototype.hasOwnProperty.call(n,a);)a=e+"-"+i,i+=1;return n[a]=!0,a}function b(e,n){n=Object.assign({},b.defaults,n),e.core.ruler.push("anchor",function(e){for(var t,a={},i=e.tokens,l=Array.isArray(n.level)?(t=n.level,function(e){return t.includes(e)}):function(e){return function(n){return n>=e}}(n.level),o=0;o<i.length;o++){var c=i[o];if("heading_open"===c.type&&l(Number(c.tag.substr(1)))){var s=i[o+1].children.filter(function(e){return "text"===e.type||"code_inline"===e.type}).reduce(function(e,n){return e+n.content},""),d=c.attrGet("id");d=null==d?f(n.slugify(s),a,!1,n.uniqueSlugStartIndex):f(d,a,!0,n.uniqueSlugStartIndex),c.attrSet("id",d),!1!==n.tabIndex&&c.attrSet("tabindex",""+n.tabIndex),"function"==typeof n.permalink?n.permalink(d,n,e,o):(n.permalink||n.renderPermalink&&n.renderPermalink!==r)&&n.renderPermalink(d,n,e,o),o=i.indexOf(c),n.callback&&n.callback(c,{slug:d,title:s});}}});}Object.assign(u.defaults,{style:"visually-hidden",space:!0,placement:"after"}),b.permalink={__proto__:null,legacy:r,renderHref:a,renderAttrs:i,makePermalink:o,linkInsideHeader:c,ariaHidden:s$1,headerLink:d$1,linkAfterHeader:u},b.defaults={level:1,slugify:function(e){return encodeURIComponent(String(e).trim().toLowerCase().replace(/\s+/g,"-"))},uniqueSlugStartIndex:1,tabIndex:"-1",permalink:!1,renderPermalink:r,permalinkClass:s$1.defaults.class,permalinkSpace:s$1.defaults.space,permalinkSymbol:"¶",permalinkBefore:"before"===s$1.defaults.placement,permalinkHref:s$1.defaults.renderHref,permalinkAttrs:s$1.defaults.renderAttrs},b.default=b;
 
 var utils$1 = {};
@@ -36446,16 +36460,16 @@ var __spreadValues$2 = (a, b) => {
     }
   return a;
 };
-const createMarkdownRenderer = (srcDir, options = {}) => {
+const createMarkdownRenderer = (srcDir, options = {}, base) => {
   const md = markdownIt(__spreadValues$2({
     html: true,
     linkify: true,
     highlight
   }, options));
-  md.use(componentPlugin).use(highlightLinePlugin).use(preWrapperPlugin).use(snippetPlugin, srcDir).use(hoistPlugin).use(containerPlugin).use(headingPlugin).use(linkPlugin, __spreadValues$2({
+  md.use(componentPlugin).use(highlightLinePlugin).use(preWrapperPlugin).use(snippetPlugin, srcDir).use(hoistPlugin).use(containerPlugin).use(headingPlugin).use(imagePlugin).use(linkPlugin, __spreadValues$2({
     target: "_blank",
     rel: "noopener noreferrer"
-  }, options.externalLinks)).use(markdownItAttrs, options.attrs).use(b, __spreadValues$2({
+  }, options.externalLinks), base).use(markdownItAttrs, options.attrs).use(b, __spreadValues$2({
     slugify: slugify$1,
     permalink: b.permalink.ariaHidden({})
   }, options.anchor)).use(markdownItTableOfContents, __spreadValues$2({
@@ -37109,8 +37123,8 @@ function getGitTimestamp(file) {
 const debug$2 = _debug("vitepress:md");
 const cache$1 = new lruCache({ max: 1024 });
 const includesRE = /<!--\s*@include:\s*(.*?)\s*-->/g;
-function createMarkdownToVueRenderFn(srcDir, options = {}, pages, userDefines, isBuild = false, includeLastUpdatedData = false) {
-  const md = createMarkdownRenderer(srcDir, options);
+function createMarkdownToVueRenderFn(srcDir, options = {}, pages, userDefines, isBuild = false, base, includeLastUpdatedData = false) {
+  const md = createMarkdownRenderer(srcDir, options, base);
   pages = pages.map((p) => slash(p.replace(/\.md$/, "")));
   const userDefineRegex = userDefines ? new RegExp(`\\b(${Object.keys(userDefines).map((key) => key.replace(/[-[\]/{}()*+?.\\^$|]/g, "\\$&")).join("|")})`, "g") : null;
   return async (src, file, publicDir) => {
@@ -37149,6 +37163,8 @@ function createMarkdownToVueRenderFn(srcDir, options = {}, pages, userDefines, i
     if (data.links) {
       const dir2 = path__default["default"].dirname(file);
       for (let url of data.links) {
+        if (/\.(?!html|md)\w+($|\?)/i.test(url))
+          continue;
         if (url.replace(EXTERNAL_URL_RE, "").startsWith("//localhost:")) {
           recordDeadLink(url);
           continue;
@@ -37368,7 +37384,7 @@ function createVitePressPlugin(root, siteConfig, ssr = false, pageToHashMap, cli
     name: "vitepress",
     configResolved(resolvedConfig) {
       config = resolvedConfig;
-      markdownToVue = createMarkdownToVueRenderFn(srcDir, markdown, pages, config.define, config.command === "build", siteConfig.lastUpdated);
+      markdownToVue = createMarkdownToVueRenderFn(srcDir, markdown, pages, config.define, config.command === "build", config.base, siteConfig.lastUpdated);
     },
     config() {
       var _a, _b;
@@ -37436,6 +37452,7 @@ function createVitePressPlugin(root, siteConfig, ssr = false, pageToHashMap, cli
         server.middlewares.use((req, res, next) => {
           if (req.url.endsWith(".html")) {
             res.statusCode = 200;
+            res.setHeader("Content-Type", "text/html");
             res.end(`
 <!DOCTYPE html>
 <html>
@@ -40963,7 +40980,7 @@ function renderHead(head) {
   return Promise.all(head.map(async ([tag, attrs = {}, innerHTML = ""]) => {
     const openTag = `<${tag}${renderAttrs(attrs)}>`;
     if (tag !== "link" && tag !== "meta") {
-      if (tag === "script") {
+      if (tag === "script" && (attrs.type === void 0 || attrs.type.includes("javascript"))) {
         innerHTML = (await vite.transformWithEsbuild(innerHTML, "inline-script.js", {
           minify: true
         })).code.trim();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitepress",
-  "version": "0.22.2",
+  "version": "1.0.0-draft.1",
   "description": "Vite & Vue powered static site generator",
   "main": "dist/node/index.js",
   "typings": "types/index.d.ts",
@@ -14,20 +14,6 @@
     "client.d.ts",
     "theme.d.ts"
   ],
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "gitHooks": {
-    "pre-commit": "lint-staged"
-  },
-  "lint-staged": {
-    "*.js": [
-      "prettier --write"
-    ],
-    "*.ts": [
-      "prettier --parser=typescript --write"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vuejs/vitepress.git"
@@ -39,24 +25,41 @@
   ],
   "author": "Evan You",
   "license": "MIT",
-  "homepage": "https://github.com/vuejs/vitepress/tree/master/#readme",
+  "homepage": "https://github.com/vuejs/vitepress/tree/main/#readme",
   "bugs": {
     "url": "https://github.com/vuejs/vitepress/issues"
   },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "gitHooks": {
+    "pre-commit": "lint-staged"
+  },
+  "lint-staged": {
+    "*.js": [
+      "prettier --write"
+    ],
+    "*.ts": [
+      "prettier --parser=typescript --write"
+    ]
+  },
   "dependencies": {
-    "@docsearch/css": "^3.0.0-alpha.41",
-    "@docsearch/js": "^3.0.0-alpha.41",
-    "@vitejs/plugin-vue": "^2.2.0",
+    "@docsearch/css": "^3.0.0",
+    "@docsearch/js": "^3.0.0",
+    "@vitejs/plugin-vue": "^2.3.2",
+    "@vueuse/core": "^8.5.0",
+    "body-scroll-lock": "^4.0.0-beta.0",
     "prismjs": "^1.25.0",
-    "vite": "^2.8.1",
-    "vue": "^3.2.31"
+    "vite": "^2.9.7",
+    "vue": "3.2.33"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.9",
+    "@microsoft/api-extractor": "^7.23.1",
     "@rollup/plugin-alias": "^3.1.5",
     "@rollup/plugin-commonjs": "^20.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.0.4",
+    "@types/body-scroll-lock": "^3.1.0",
     "@types/compression": "^1.7.0",
     "@types/cross-spawn": "^6.0.2",
     "@types/debug": "^4.1.7",
@@ -66,6 +69,7 @@
     "@types/lru-cache": "^5.1.0",
     "@types/markdown-it": "^12.0.1",
     "@types/micromatch": "^4.0.2",
+    "@types/minimist": "^1.2.2",
     "@types/node": "^15.6.1",
     "@types/polka": "^0.5.3",
     "chalk": "^4.1.1",
@@ -102,8 +106,8 @@
     "rollup-plugin-esbuild": "^4.8.2",
     "semver": "^7.3.5",
     "sirv": "^1.0.12",
-    "typescript": "^4.3.2",
-    "vitest": "^0.1.19",
+    "typescript": "^4.6.4",
+    "vitest": "^0.10.4",
     "yorkie": "^2.0.0"
   },
   "scripts": {
@@ -124,15 +128,15 @@
     "lint:js": "prettier --check --write \"{bin,docs,scripts,src}/**/*.js\"",
     "lint:ts": "prettier --check --write --parser typescript \"{__tests__,src,docs,types}/**/*.ts\"",
     "test": "vitest run __tests__ -c __tests__/vitest.config.js --global",
+    "test:all": "run-s lint test",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
     "release": "node scripts/release.js",
     "docs": "run-p dev docs-dev",
     "docs-dev": "node ./bin/vitepress dev docs",
     "docs-debug": "node --inspect-brk ./bin/vitepress dev docs",
-    "docs-build": "npm run build && node ./bin/vitepress build docs",
+    "docs-build": "run-s build docs-build-only",
     "docs-build-only": "node ./bin/vitepress build docs",
     "docs-serve": "node ./bin/vitepress serve docs",
     "ci-docs": "run-s build docs-build"
-  },
-  "readme": "# (WIP) VitePress 📝💨\n\n[![Test](https://github.com/vuejs/vitepress/workflows/Test/badge.svg)](https://github.com/vuejs/vitepress/actions)\n[![npm](https://img.shields.io/npm/v/vitepress)](https://www.npmjs.com/package/vitepress)\n\n---\n\nVitePress is [VuePress](http://vuepress.vuejs.org/)' spiritual successor, built on top of [vite](https://github.com/vuejs/vite).\n\n## Documentation\n\nTo check out docs, visit [vitepress.vuejs.org](https://vitepress.vuejs.org).\n\n## Changelog\n\nDetailed changes for each release are documented in the [CHANGELOG](https://github.com/vuejs/vitepress/blob/master/CHANGELOG.md).\n\n## Contribution\n\nPlease make sure to read the [Contributing Guide](./.github/contributing.md) before making a pull request.\n\n## License\n\n[MIT](https://opensource.org/licenses/MIT)\n\nCopyright (c) 2019-present, Yuxi (Evan) You\n"
+  }
 }