vitepress 2.0.0-alpha.2 → 2.0.0-alpha.21

package/dist/node/index.js

@@ -1,121 +1 @@
-import { normalizePath } from 'vite';
-export { loadEnv } from 'vite';
-import { g as glob, c as createMarkdownRenderer, f as fs, m as matter, p as postcssPrefixSelector } from './chunk-CxQfvv8o.js';
-export { S as ScaffoldThemeType, b as build, q as createServer, a as defineConfig, e as defineConfigWithTheme, d as defineLoader, n as disposeMdItInstance, l as init, i as mergeConfig, r as resolveConfig, k as resolvePages, j as resolveSiteData, h as resolveUserConfig, s as scaffold, o as serve } from './chunk-CxQfvv8o.js';
-import path from 'node:path';
-import 'node:crypto';
-import 'node:module';
-import 'node:url';
-import 'node:process';
-import 'node:fs/promises';
-import 'node:fs';
-import 'fs';
-import 'node:events';
-import 'node:stream';
-import 'node:string_decoder';
-import 'path';
-import 'util';
-import 'os';
-import 'stream';
-import 'readline';
-import 'url';
-import 'child_process';
-import 'string_decoder';
-import 'zlib';
-import '@vue/shared';
-import 'node:util';
-import 'node:readline';
-import 'node:tty';
-import 'node:zlib';
-import 'node:http';
-import 'node:timers';
-import 'node:querystring';
-import 'tty';
-import 'constants';
-import 'assert';
-import '@shikijs/transformers';
-import 'shiki';
-import './chunk-C-d2RJOW.js';
-import 'node:worker_threads';
-import 'minisearch';
-
-function createContentLoader(pattern, {
-  includeSrc,
-  render,
-  excerpt: renderExcerpt,
-  transform,
-  globOptions
-} = {}) {
-  const config = global.VITEPRESS_CONFIG;
-  if (!config) {
-    throw new Error(
-      "content loader invoked without an active vitepress process, or before vitepress config is resolved."
-    );
-  }
-  if (typeof pattern === "string") pattern = [pattern];
-  pattern = pattern.map((p) => normalizePath(path.join(config.srcDir, p)));
-  const cache = /* @__PURE__ */ new Map();
-  return {
-    watch: pattern,
-    async load(files) {
-      if (!files) {
-        files = (await glob(pattern, {
-          ignore: ["**/node_modules/**", "**/dist/**"],
-          expandDirectories: false,
-          ...globOptions
-        })).sort();
-      }
-      const md = await createMarkdownRenderer(
-        config.srcDir,
-        config.markdown,
-        config.site.base,
-        config.logger
-      );
-      const raw = [];
-      for (const file of files) {
-        if (!file.endsWith(".md")) {
-          continue;
-        }
-        const timestamp = fs.statSync(file).mtimeMs;
-        const cached = cache.get(file);
-        if (cached && timestamp === cached.timestamp) {
-          raw.push(cached.data);
-        } else {
-          const src = fs.readFileSync(file, "utf-8");
-          const { data: frontmatter, excerpt } = matter(
-            src,
-            // @ts-expect-error gray-matter types are wrong
-            typeof renderExcerpt === "string" ? { excerpt_separator: renderExcerpt } : { excerpt: renderExcerpt }
-          );
-          const url = "/" + normalizePath(path.relative(config.srcDir, file)).replace(/(^|\/)index\.md$/, "$1").replace(/\.md$/, config.cleanUrls ? "" : ".html");
-          const html = render ? md.render(src) : undefined;
-          const renderedExcerpt = renderExcerpt ? excerpt && md.render(excerpt) : undefined;
-          const data = {
-            src: includeSrc ? src : undefined,
-            html,
-            frontmatter,
-            excerpt: renderedExcerpt,
-            url
-          };
-          cache.set(file, { data, timestamp });
-          raw.push(data);
-        }
-      }
-      return transform ? transform(raw) : raw;
-    }
-  };
-}
-
-function postcssIsolateStyles(options = {}) {
-  return postcssPrefixSelector({
-    prefix: ":not(:where(.vp-raw, .vp-raw *))",
-    includeFiles: [/base\.css/],
-    transform(prefix, _selector) {
-      const [selector, pseudo = ""] = _selector.split(/(:\S*)$/);
-      return selector + prefix + pseudo;
-    },
-    ...options
-  });
-}
-
-export { createContentLoader, createMarkdownRenderer, postcssIsolateStyles };
+export { a as ScaffoldThemeType, l as build, p as cacheAllGitTimestamps, c as createContentLoader, h as createMarkdownRenderer, n as createServer, v as defineAdditionalConfig, y as defineConfig, b as defineConfigWithTheme, u as defineLoader, O as defineRoutes, g as disposeMdItInstance, m as getGitTimestamp, o as init, x as isAdditionalConfigFile, t as loadEnv, S as mergeConfig, _ as mergeMarkdownLocales, C as normalizeAssetsBase, w as normalizeSiteBase, i as postcssIsolateStyles, T as resolveConfig, k as resolvePages, E as resolveSiteData, A as resolveSiteDataByRoute, D as resolveUserConfig, s as scaffold, r as serve } from "./chunk-BjrVv9r8.js";

package/dist/web-types.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "http://json.schemastore.org/web-types",
+  "framework": "vue",
+  "name": "vitepress",
+  "version": "2.0.0-alpha.21",
+  "js-types-syntax": "typescript",
+  "description-markup": "markdown",
+  "contributions": {
+    "html": {
+      "vue-components": [
+        {
+          "name": "Content",
+          "source": {
+            "symbol": "Content"
+          },
+          "description": "Displays the rendered markdown contents. Useful when creating your own theme.",
+          "doc-url": "https://vitepress.dev/reference/runtime-api#content",
+          "props": [
+            {
+              "name": "as",
+              "description": "The content wrapper. Accepts an HTML tag name, a component name, or a component reference.",
+              "type": [
+                "string",
+                "object"
+              ],
+              "default": "div"
+            }
+          ]
+        },
+        {
+          "name": "ClientOnly",
+          "source": {
+            "symbol": "ClientOnly"
+          },
+          "description": "Renders its slot only at client side. Useful for wrapping components that are not SSR-friendly.",
+          "doc-url": "https://vitepress.dev/reference/runtime-api#clientonly",
+          "slots": [
+            {
+              "name": "default",
+              "description": "Content to render once the client app is mounted."
+            }
+          ]
+        },
+        {
+          "name": "Badge",
+          "source": {
+            "module": "vitepress/theme",
+            "symbol": "VPBadge"
+          },
+          "description": "Adds a status label to headers, such as a section's type or supported version. Available when using the default theme.",
+          "doc-url": "https://vitepress.dev/reference/default-theme-badge",
+          "props": [
+            {
+              "name": "type",
+              "description": "The badge color type.",
+              "type": "'info' | 'tip' | 'warning' | 'danger'",
+              "default": "tip"
+            },
+            {
+              "name": "text",
+              "description": "The text displayed inside the badge. Ignored when the default slot is passed.",
+              "type": "string"
+            }
+          ],
+          "slots": [
+            {
+              "name": "default",
+              "description": "Content displayed inside the badge. Takes precedence over the `text` prop."
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitepress",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.21",
   "description": "Vite & Vue powered static site generator",
   "keywords": [
     "vite",
@@ -11,7 +11,10 @@
   "bugs": {
     "url": "https://github.com/vuejs/vitepress/issues"
   },
-  "repository": "github:vuejs/vitepress",
+  "repository": {
+    "type": "git",
+    "url": "github:vuejs/vitepress"
+  },
   "license": "MIT",
   "author": "Evan You",
   "type": "module",
@@ -37,10 +40,12 @@
   },
   "main": "dist/node/index.js",
   "types": "types/index.d.ts",
+  "web-types": "./dist/web-types.json",
   "bin": {
     "vitepress": "bin/vitepress.js"
   },
   "files": [
+    "THIRD-PARTY-NOTICES.md",
     "bin",
     "dist",
     "types",
@@ -54,103 +59,93 @@
     "pre-commit": "pnpm lint-staged"
   },
   "lint-staged": {
-    "*": "prettier --write --ignore-unknown"
+    "*": "prettier --experimental-cli --ignore-unknown --write"
   },
   "dependencies": {
-    "@docsearch/css": "^3.8.3",
-    "@docsearch/js": "^3.8.3",
-    "@iconify-json/simple-icons": "^1.2.21",
-    "@shikijs/core": "^2.1.0",
-    "@shikijs/transformers": "^2.1.0",
-    "@shikijs/types": "^2.1.0",
-    "@types/markdown-it": "^14.1.2",
-    "@vitejs/plugin-vue": "^5.2.1",
-    "@vue/devtools-api": "^7.7.0",
-    "@vue/shared": "^3.5.13",
-    "@vueuse/core": "^12.5.0",
-    "@vueuse/integrations": "^12.5.0",
-    "focus-trap": "^7.6.4",
+    "@docsearch/css": "^4.7.1",
+    "@docsearch/js": "^4.7.1",
+    "@docsearch/sidepanel-js": "^4.7.1",
+    "@iconify-json/simple-icons": "^1.2.99",
+    "@shikijs/transformers": "^4.5.0",
+    "@types/markdown-it": "^14.2.0",
+    "@vitejs/plugin-vue": "^6.0.9",
+    "@vue/devtools-api": "^8.2.1",
+    "@vue/shared": "^3.5.43",
+    "@vueuse/core": "^15.0.0",
+    "@vueuse/integrations": "^15.0.0",
+    "focus-trap": "^8.2.3",
     "mark.js": "8.11.1",
-    "minisearch": "^7.1.1",
-    "shiki": "^2.1.0",
-    "vite": "^6.0.11",
-    "vue": "^3.5.13"
+    "minisearch": "^7.2.0",
+    "shiki": "^4.5.0",
+    "vite": "^8.3.4",
+    "vue": "^3.5.43"
   },
   "devDependencies": {
-    "@clack/prompts": "^0.9.1",
-    "@iconify/utils": "^2.2.1",
-    "@mdit-vue/plugin-component": "^2.1.3",
-    "@mdit-vue/plugin-frontmatter": "^2.1.3",
-    "@mdit-vue/plugin-headers": "^2.1.3",
-    "@mdit-vue/plugin-sfc": "^2.1.3",
-    "@mdit-vue/plugin-title": "^2.1.3",
-    "@mdit-vue/plugin-toc": "^2.1.3",
-    "@mdit-vue/shared": "^2.1.3",
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@clack/prompts": "^1.8.1",
+    "@iconify/utils": "^3.1.7",
+    "@mdit-vue/plugin-component": "3.0.2",
+    "@mdit-vue/plugin-frontmatter": "3.0.2",
+    "@mdit-vue/plugin-headers": "3.0.2",
+    "@mdit-vue/plugin-sfc": "3.0.2",
+    "@mdit-vue/plugin-title": "3.0.2",
+    "@mdit-vue/plugin-toc": "3.0.2",
+    "@mdit-vue/shared": "3.0.2",
+    "@mdit/plugin-anchor": "1.1.3",
+    "@mdit/plugin-attrs": "1.1.1",
+    "@mdit/plugin-container": "1.0.2",
+    "@mdit/plugin-emoji": "1.1.1",
+    "@mdit/plugin-footnote": "1.0.2",
+    "@mdit/plugin-tasklist": "1.0.2",
     "@polka/compression": "^1.0.0-next.28",
-    "@rollup/plugin-alias": "^5.1.1",
-    "@rollup/plugin-commonjs": "^28.0.2",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.0",
-    "@rollup/plugin-replace": "^6.0.2",
+    "@rolldown/pluginutils": "^1.0.1",
     "@types/cross-spawn": "^6.0.6",
-    "@types/debug": "^4.1.12",
-    "@types/fs-extra": "^11.0.4",
-    "@types/lodash.template": "^4.5.3",
     "@types/mark.js": "^8.11.12",
-    "@types/markdown-it-attrs": "^4.1.3",
-    "@types/markdown-it-container": "^2.0.10",
-    "@types/markdown-it-emoji": "^3.0.1",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^22.10.9",
-    "@types/picomatch": "^3.0.2",
-    "@types/postcss-prefix-selector": "^1.16.3",
-    "@types/prompts": "^2.4.9",
-    "chokidar": "^4.0.3",
-    "conventional-changelog-cli": "^5.0.0",
+    "@types/node": "^26.6.5",
+    "@types/picomatch": "^4.0.3",
+    "@volar/typescript": "^2.4.28",
+    "@vue/language-core": "^3.3.12",
+    "conventional-changelog": "^8.1.3",
+    "conventional-changelog-angular": "^9.4.0",
     "cross-spawn": "^7.0.6",
-    "debug": "^4.4.0",
-    "esbuild": "^0.24.2",
-    "execa": "^9.5.2",
-    "fs-extra": "^11.3.0",
-    "get-port": "^7.1.0",
+    "eta": "^4.6.0",
+    "get-port": "^7.2.0",
     "gray-matter": "^4.0.3",
-    "lint-staged": "^15.4.2",
-    "lodash.template": "^4.5.0",
-    "lru-cache": "^11.0.2",
-    "markdown-it": "^14.1.0",
-    "markdown-it-anchor": "^9.2.0",
-    "markdown-it-attrs": "^4.3.1",
-    "markdown-it-container": "^4.0.0",
-    "markdown-it-emoji": "^3.0.0",
+    "image-size": "^2.0.4",
+    "lint-staged": "^17.6.0",
+    "lru-cache": "^11.5.3",
+    "markdown-it": "^14.3.2",
+    "markdown-it-async": "^2.2.0",
+    "markdown-it-cjk-friendly": "^2.0.3",
     "markdown-it-mathjax3": "^4.3.2",
     "minimist": "^1.2.8",
-    "nanoid": "^5.0.9",
-    "ora": "^8.1.1",
-    "p-map": "^7.0.3",
+    "nanoid": "^6.0.2",
+    "obug": "^3.0.0",
+    "ora": "^9.4.1",
+    "p-map": "^7.0.8",
+    "package-directory": "^8.2.0",
     "path-to-regexp": "^6.3.0",
     "picocolors": "^1.1.1",
-    "picomatch": "^4.0.2",
-    "pkg-dir": "^8.0.0",
-    "playwright-chromium": "^1.50.0",
+    "picomatch": "^4.0.7",
+    "playwright-chromium": "^1.64.0",
     "polka": "^1.0.0-next.28",
-    "postcss-prefix-selector": "^2.1.0",
-    "prettier": "^3.4.2",
-    "prompts": "^2.4.2",
-    "punycode": "^2.3.1",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.31.0",
-    "rollup-plugin-dts": "^6.1.1",
-    "rollup-plugin-esbuild": "^6.1.1",
-    "semver": "^7.6.3",
-    "simple-git-hooks": "^2.11.1",
-    "sirv": "^3.0.0",
-    "sitemap": "^8.0.0",
-    "synckit": "^0.9.2",
-    "tinyglobby": "^0.2.10",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.4",
-    "vue-tsc": "^2.2.0",
-    "wait-on": "^8.0.2"
+    "postcss": "^8.5.28",
+    "postcss-selector-parser": "^7.1.6",
+    "prettier": "^3.9.9",
+    "publint": "^0.3.25",
+    "rolldown": "^1.2.13",
+    "simple-git-hooks": "^2.14.0",
+    "sirv": "^3.0.2",
+    "sitemap": "^9.0.1",
+    "tinyglobby": "^0.2.17",
+    "tsdown": "^0.23.0",
+    "typescript": "^6.0.3",
+    "verkit": "^0.5.0",
+    "vitest": "^5.0.3",
+    "vue-sfc-transformer": "^0.3.0",
+    "vue-tsc": "^3.3.12",
+    "wait-on": "^9.5.1"
   },
   "peerDependencies": {
     "markdown-it-mathjax3": "^4",
@@ -165,17 +160,13 @@
     }
   },
   "scripts": {
-    "dev": "rimraf dist && pnpm dev:shared && pnpm dev:start",
-    "dev:start": "pnpm --stream '/^dev:(client|node|watch)$/'",
-    "dev:client": "tsc --sourcemap -w --preserveWatchOutput -p src/client",
-    "dev:node": "DEV=true pnpm build:node -w",
-    "dev:shared": "node scripts/copyShared",
-    "dev:watch": "node scripts/watchAndCopy",
-    "build": "pnpm build:prepare && pnpm build:client && pnpm build:node",
-    "build:prepare": "rimraf dist && node scripts/copyShared",
-    "build:client": "vue-tsc --noEmit -p src/client && tsc -p src/client && node scripts/copyClient",
-    "build:node": "tsc -p src/node --noEmit && rollup --config rollup.config.ts --configPlugin esbuild",
-    "test": "pnpm --aggregate-output --reporter=append-only '/^test:(unit|e2e|init)$/'",
+    "dev": "tsdown --watch --sourcemap",
+    "build": "tsdown && pnpm typecheck && node scripts/genWebTypes.ts && pnpm build:check",
+    "build:check": "publint && attw --pack . --profile esm-only",
+    "typecheck": "tsc -p tsconfig.shared.json && vue-tsc -p tsconfig.client.json && tsc -p tsconfig.node.json",
+    "test": "pnpm --aggregate-output --reporter=append-only '/^test:(types|unit|e2e|init|base)$/'",
+    "test:types": "tsc -p __tests__/unit && vue-tsc -p __tests__/e2e && tsc -p __tests__/init && tsc -p __tests__/base && vue-tsc -p docs",
+    "test:base": "pnpm -F=tests-base test",
     "test:unit": "vitest run -r __tests__/unit",
     "test:unit:watch": "vitest -r __tests__/unit",
     "test:e2e": "pnpm test:e2e-dev && pnpm test:e2e-build",
@@ -196,10 +187,10 @@
     "docs:preview": "pnpm -F=docs preview",
     "docs:lunaria:build": "pnpm -F=docs lunaria:build",
     "docs:lunaria:open": "pnpm -F=docs lunaria:open",
-    "format": "prettier --check --write .",
-    "format:fail": "prettier --check .",
-    "check": "pnpm format:fail && pnpm build && pnpm test",
+    "format": "prettier --experimental-cli --write .",
+    "format:fail": "prettier --experimental-cli --check .",
+    "check": "pnpm format:fail && pnpm build && git ls-files --error-unmatch THIRD-PARTY-NOTICES.md && git diff --exit-code -- THIRD-PARTY-NOTICES.md && pnpm test",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "release": "node scripts/release.js"
+    "release": "node scripts/release.ts"
   }
 }

package/template/.vitepress/config.js

@@ -1,7 +1,9 @@
 import { defineConfig } from 'vitepress'
 
 // https://vitepress.dev/reference/site-config
-export default defineConfig({
+export default defineConfig({<% if (srcDir) { %>
+  srcDir: <%= srcDir %>,
+  <% } %>
   title: <%= title %>,
   description: <%= description %><% if (defaultTheme) { %>,
   themeConfig: {

package/template/.vitepress/theme/style.css

@@ -24,7 +24,7 @@
  *
  *   The soft color must be semi transparent alpha channel. This is crucial
  *   because it allows adding multiple "soft" colors on top of each other
- *   to create a accent, such as when having inline code block inside
+ *   to create an accent, such as when having inline code block inside
  *   custom containers.
  *
  * - `default`: The color used purely for subtle indication without any
@@ -106,13 +106,13 @@
   --vp-home-hero-image-filter: blur(44px);
 }
 
-@media (min-width: 640px) {
+@media (min-width: 40rem) {
   :root {
     --vp-home-hero-image-filter: blur(56px);
   }
 }
 
-@media (min-width: 960px) {
+@media (min-width: 60rem) {
   :root {
     --vp-home-hero-image-filter: blur(68px);
   }
@@ -128,14 +128,6 @@
   --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
   --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
 }
-
-/**
- * Component: Algolia
- * -------------------------------------------------------------------------- */
-
-.DocSearch {
-  --docsearch-primary-color: var(--vp-c-brand-1) !important;
-}
 <% } else { %>
 html {
   font-family: Arial, Helvetica;

package/theme.d.ts

@@ -1,7 +1,8 @@
 // so that users can do `import DefaultTheme from 'vitepress/theme'`
 
+import type { EnhanceAppContext } from 'vitepress'
 import type { DefineComponent } from 'vue'
-import type { EnhanceAppContext } from './dist/client/index.js'
+
 import type { DefaultTheme } from './types/default-theme.js'
 
 export type { DefaultTheme } from './types/default-theme.js'
@@ -12,25 +13,31 @@ declare const theme: {
 }
 
 export default theme
-export declare const useSidebar: () => DefaultTheme.DocSidebar
-export declare const useLocalNav: () => DefaultTheme.DocLocalNav
-
-// TODO: add props for these
-export declare const VPBadge: DefineComponent
-export declare const VPButton: DefineComponent
-export declare const VPDocAsideSponsors: DefineComponent
-export declare const VPFeatures: DefineComponent
-export declare const VPHomeContent: DefineComponent
-export declare const VPHomeFeatures: DefineComponent
-export declare const VPHomeHero: DefineComponent
-export declare const VPHomeSponsors: DefineComponent
-export declare const VPImage: DefineComponent
-export declare const VPLink: DefineComponent
-export declare const VPNavBarSearch: DefineComponent
-export declare const VPSocialLink: DefineComponent
-export declare const VPSocialLinks: DefineComponent
-export declare const VPSponsors: DefineComponent
-export declare const VPTeamMembers: DefineComponent
-export declare const VPTeamPage: DefineComponent
-export declare const VPTeamPageSection: DefineComponent
-export declare const VPTeamPageTitle: DefineComponent
+
+export declare const useLayout: () => DefaultTheme.Layout
+
+export declare const VPBadge: typeof import('./dist/client/theme-default/components/VPBadge.vue').default
+export declare const VPButton: typeof import('./dist/client/theme-default/components/VPButton.vue').default
+export declare const VPDocAsideSponsors: typeof import('./dist/client/theme-default/components/VPDocAsideSponsors.vue').default
+export declare const VPFeatures: typeof import('./dist/client/theme-default/components/VPFeatures.vue').default
+export declare const VPHomeContent: typeof import('./dist/client/theme-default/components/VPHomeContent.vue').default
+export declare const VPHomeFeatures: typeof import('./dist/client/theme-default/components/VPHomeFeatures.vue').default
+export declare const VPHomeHero: typeof import('./dist/client/theme-default/components/VPHomeHero.vue').default
+export declare const VPHomeSponsors: typeof import('./dist/client/theme-default/components/VPHomeSponsors.vue').default
+export declare const VPIcon: typeof import('./dist/client/theme-default/components/VPIcon.vue').default
+export declare const VPImage: typeof import('./dist/client/theme-default/components/VPImage.vue').default
+export declare const VPLink: typeof import('./dist/client/theme-default/components/VPLink.vue').default
+export declare const VPNavBarSearch: typeof import('./dist/client/theme-default/components/VPNavBarSearch.vue').default
+export declare const VPSocialLink: typeof import('./dist/client/theme-default/components/VPSocialLink.vue').default
+export declare const VPSocialLinks: typeof import('./dist/client/theme-default/components/VPSocialLinks.vue').default
+export declare const VPSponsors: typeof import('./dist/client/theme-default/components/VPSponsors.vue').default
+export declare const VPTeamMembers: typeof import('./dist/client/theme-default/components/VPTeamMembers.vue').default
+export declare const VPTeamPage: typeof import('./dist/client/theme-default/components/VPTeamPage.vue').default
+export declare const VPTeamPageSection: typeof import('./dist/client/theme-default/components/VPTeamPageSection.vue').default
+export declare const VPTeamPageTitle: typeof import('./dist/client/theme-default/components/VPTeamPageTitle.vue').default
+
+declare module 'vue' {
+  interface GlobalComponents {
+    Badge: typeof VPBadge
+  }
+}