vitepress 1.0.0-draft.3 → 1.0.0-draft.6

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "vitepress",
-  "version": "1.0.0-draft.3",
-  "packageManager": "pnpm@7.0.1",
+  "version": "1.0.0-draft.6",
   "description": "Vite & Vue powered static site generator",
+  "type": "module",
+  "packageManager": "pnpm@7.0.1",
   "main": "dist/node/index.js",
-  "typings": "types/index.d.ts",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/node/index.js",
+      "require": "./dist/node-cjs/index.cjs"
+    },
+    "./dist/client/*": "./dist/client/*"
+  },
   "bin": {
     "vitepress": "bin/vitepress.js"
   },
@@ -31,18 +40,7 @@
     "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"
-    ]
+    "node": ">=14.6.0"
   },
   "dependencies": {
     "@docsearch/css": "^3.0.0",
@@ -50,16 +48,16 @@
     "@vitejs/plugin-vue": "^2.3.2",
     "@vueuse/core": "^8.5.0",
     "body-scroll-lock": "^4.0.0-beta.0",
-    "prismjs": "^1.25.0",
+    "shiki": "^0.10.1",
     "vite": "^2.9.7",
     "vue": "3.2.33"
   },
   "devDependencies": {
-    "@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",
+    "@rollup/plugin-replace": "^4.0.0",
     "@types/body-scroll-lock": "^3.1.0",
     "@types/compression": "^1.7.0",
     "@types/cross-spawn": "^6.0.2",
@@ -73,7 +71,7 @@
     "@types/minimist": "^1.2.2",
     "@types/node": "^15.6.1",
     "@types/polka": "^0.5.3",
-    "chalk": "^4.1.1",
+    "@types/prompts": "^2.0.14",
     "chokidar": "^3.5.1",
     "compression": "^1.7.4",
     "conventional-changelog-cli": "^2.1.1",
@@ -83,10 +81,9 @@
     "enquirer": "^2.3.6",
     "esbuild": "^0.14.0",
     "escape-html": "^1.0.3",
-    "execa": "^5.0.0",
+    "execa": "^6.1.0",
     "fast-glob": "^3.2.7",
     "fs-extra": "^10.0.0",
-    "globby": "^11.0.3",
     "gray-matter": "^4.0.3",
     "lint-staged": "^11.0.0",
     "lru-cache": "^6.0.0",
@@ -95,41 +92,52 @@
     "markdown-it-attrs": "^4.1.3",
     "markdown-it-container": "^3.0.0",
     "markdown-it-emoji": "^2.0.0",
-    "markdown-it-table-of-contents": "^0.6.0",
+    "markdown-it-toc-done-right": "^4.2.0",
     "micromatch": "^4.0.4",
     "minimist": "^1.2.5",
     "npm-run-all": "^4.1.5",
     "ora": "^5.4.0",
+    "picocolors": "^1.0.0",
     "polka": "^0.5.2",
     "prettier": "^2.3.0",
+    "prompts": "^2.4.2",
     "rimraf": "^3.0.2",
     "rollup": "^2.56.3",
+    "rollup-plugin-dts": "^4.2.2",
     "rollup-plugin-esbuild": "^4.8.2",
     "semver": "^7.3.5",
+    "simple-git-hooks": "^2.7.0",
     "sirv": "^1.0.12",
-    "typescript": "^4.6.4",
-    "vitest": "^0.10.4",
-    "yorkie": "^2.0.0"
+    "supports-color": "^9.2.2",
+    "typescript": "^4.7.2",
+    "vitest": "^0.10.4"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": [
+      "prettier --write --ignore-unknown"
+    ]
   },
   "scripts": {
-    "dev": "run-s dev-shared dev-start",
+    "dev": "rimraf dist && run-s dev-shared dev-start",
     "dev-start": "run-p dev-client dev-node dev-watch",
     "dev-client": "tsc -w -p src/client",
-    "dev-node": "tsc -w -p src/node",
+    "dev-node": "DEV=true pnpm run build-node -w",
     "dev-shared": "node scripts/copyShared",
     "dev-watch": "node scripts/watchAndCopy",
-    "build": "run-s build-prepare build-client build-node build-types",
-    "build-prepare": "rimraf -rf dist && node scripts/copyShared",
+    "build": "run-s build-prepare build-client build-node",
+    "build-prepare": "rimraf dist && node scripts/copyShared",
     "build-client": "tsc -p src/client && node scripts/copyClient",
-    "build-node": "rollup -c scripts/rollup.config.js",
-    "build-types": "run-s build-types-client build-types-node",
-    "build-types-client": "tsc -p src/client --declaration --emitDeclarationOnly --outDir dist/temp && api-extractor run -c api-extractor.client.json && rimraf dist/temp",
-    "build-types-node": "tsc -p src/node --declaration --emitDeclarationOnly --outDir dist/temp && api-extractor run -c api-extractor.node.json && rimraf dist/temp",
-    "lint": "run-s lint:js lint:ts",
-    "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",
+    "build-node": "rollup --config rollup.config.ts --configPlugin esbuild",
+    "format": "prettier --check --write .",
+    "format-fail": "prettier --check .",
+    "lint": "pnpm run format",
+    "lint-fail": "pnpm run format-fail",
+    "test": "vitest -r __tests__",
+    "test-run": "vitest run -r __tests__",
+    "check": "run-s lint test-run build",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
     "release": "node scripts/release.js",
     "docs": "run-p dev docs-dev",
@@ -138,7 +146,6 @@
     "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](https://vuepress.vuejs.org)' spiritual successor, built on top of [vite](https://github.com/vitejs/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/main/CHANGELOG.md).\n\n## Contribution\n\nPlease make sure to read the [Contributing Guide](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md) before making a pull request.\n\n## License\n\n[MIT](https://github.com/vuejs/vitepress/blob/main/LICENSE)\n\nCopyright (c) 2019-present, Yuxi (Evan) You\n"
+    "ci-docs": "run-s docs-build"
+  }
 }

package/theme.d.ts

@@ -1,9 +1,14 @@
 // so that users can do `import DefaultTheme from 'vitepress/theme'`
 import { ComponentOptions } from 'vue'
 
-declare const defaultTheme: {
+export const VPHomeHero = ComponentOptions
+export const VPHomeFeatures = ComponentOptions
+export const VPHomeSponsors = ComponentOptions
+export const VPDocAsideSponsors = ComponentOptions
+
+declare const theme: {
   Layout: ComponentOptions
   NotFound: ComponentOptions
 }
 
-export default defaultTheme
+export default theme

package/types/default-theme.d.ts

@@ -82,6 +82,20 @@ export namespace DefaultTheme {
   export interface SidebarGroup {
     text: string
     items: SidebarItem[]
+
+    /**
+     * If `true`, toggle button is shown.
+     *
+     * @default false
+     */
+    collapsible?: boolean
+
+    /**
+     * If `true`, collapsible group is collapsed by default.
+     *
+     * @default false
+     */
+    collapsed?: boolean
   }
 
   export interface SidebarItem {
@@ -176,8 +190,7 @@ export namespace DefaultTheme {
   // carbon ads ----------------------------------------------------------------
 
   export interface CarbonAdsOptions {
-    carbon: string
-    custom?: string
+    code: string
     placement: string
   }
 }

package/types/shared.d.ts

@@ -5,6 +5,7 @@ export { DefaultTheme } from './default-theme'
 export interface PageData {
   relativePath: string
   title: string
+  titleTemplate?: string | boolean
   description: string
   headers: Header[]
   frontmatter: Record<string, any>
@@ -28,6 +29,7 @@ export interface SiteData<ThemeConfig = any> {
   lang: string
 
   title: string
+  titleTemplate?: string | boolean
   description: string
   head: HeadConfig[]
   appearance: boolean
@@ -64,6 +66,7 @@ export type HeadConfig =
 export interface LocaleConfig {
   lang: string
   title?: string
+  titleTemplate?: string | boolean
   description?: string
   head?: HeadConfig[]
   label?: string