refactor: move docs to package

vuejs · Jun 30, 2022 · 84b9760 · 84b9760
1 parent 0eab177
commit 84b9760
Show file tree

Hide file tree

Showing 85 changed files with 483 additions and 87 deletions.
diff --git a/netlify.toml b/netlify.toml
@@ -1,4 +1,7 @@
+[build.environment]
+NPM_FLAGS = "--version"
+
 [build]
-  ignore = "./scripts/docs-check.sh"
-  publish = "docs/.vitepress/dist"
-  command = "yarn run docs:build"
+command = "npx pnpm@7 i --store=node_modules/.pnpm-store && npx pnpm@7 run docs:build"
+ignore = "./scripts/docs-check.sh"
+publish = "packages/docs/.vitepress/dist"
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
     "release": "node scripts/release.mjs",
     "size": "pnpm run -r size",
     "build": "pnpm run -r build",
-    "docs:build": "pnpm run docs:api && pnpm run -r docs:build --filter ./packages/docs",
+    "docs:build": "pnpm run -r docs:build --filter ./packages/docs",
     "play": "pnpm run -r play",
     "build:size": "pnpm run -r build:size",
     "lint": "prettier -c --parser typescript \"packages/*/{src,__tests__,e2e}/**/*.[jt]s?(x)\"",
@@ -31,5 +31,14 @@
     "*.ts?(x)": [
       "prettier --parser=typescript --write"
     ]
+  },
+  "pnpm": {
+    "peerDependencyRules": {
+      "ignoreMissing": [
+        "react",
+        "@types/react",
+        "react-dom"
+      ]
+    }
   }
 }
diff --git a/docs/.vitepress/components/HomeSponsors.vue → ...cs/.vitepress/components/HomeSponsors.vue b/docs/.vitepress/components/HomeSponsors.vue → ...cs/.vitepress/components/HomeSponsors.vue
diff --git a/...itepress/components/HomeSponsorsGroup.vue → ...itepress/components/HomeSponsorsGroup.vue b/...itepress/components/HomeSponsorsGroup.vue → ...itepress/components/HomeSponsorsGroup.vue
diff --git a/....vitepress/components/VueMasteryVideo.vue → ....vitepress/components/VueMasteryVideo.vue b/....vitepress/components/VueMasteryVideo.vue → ....vitepress/components/VueMasteryVideo.vue
diff --git a/...epress/components/VueSchool/BannerTop.vue → ...epress/components/VueSchool/BannerTop.vue b/...epress/components/VueSchool/BannerTop.vue → ...epress/components/VueSchool/BannerTop.vue
diff --git a/docs/.vitepress/components/VueSchoolLink.vue → ...s/.vitepress/components/VueSchoolLink.vue b/docs/.vitepress/components/VueSchoolLink.vue → ...s/.vitepress/components/VueSchoolLink.vue
diff --git a/docs/.vitepress/components/sponsors.json → .../docs/.vitepress/components/sponsors.json b/docs/.vitepress/components/sponsors.json → .../docs/.vitepress/components/sponsors.json
diff --git a/docs/.vitepress/config.ts → packages/docs/.vitepress/config.ts b/docs/.vitepress/config.ts → packages/docs/.vitepress/config.ts
diff --git a/docs/.vitepress/style.styl → packages/docs/.vitepress/style.styl b/docs/.vitepress/style.styl → packages/docs/.vitepress/style.styl
diff --git a/docs/.vitepress/theme/Layout.vue → packages/docs/.vitepress/theme/Layout.vue b/docs/.vitepress/theme/Layout.vue → packages/docs/.vitepress/theme/Layout.vue
diff --git a/docs/.vitepress/theme/dark-theme.ts → packages/docs/.vitepress/theme/dark-theme.ts b/docs/.vitepress/theme/dark-theme.ts → packages/docs/.vitepress/theme/dark-theme.ts
diff --git a/docs/.vitepress/theme/index.js → packages/docs/.vitepress/theme/index.js b/docs/.vitepress/theme/index.js → packages/docs/.vitepress/theme/index.js
diff --git a/docs/.vitepress/theme/sponsors.css → packages/docs/.vitepress/theme/sponsors.css b/docs/.vitepress/theme/sponsors.css → packages/docs/.vitepress/theme/sponsors.css
diff --git a/docs/api/index.md → packages/docs/api/index.md b/docs/api/index.md → packages/docs/api/index.md
diff --git a/docs/guide/advanced/composition-api.md → ...es/docs/guide/advanced/composition-api.md b/docs/guide/advanced/composition-api.md → ...es/docs/guide/advanced/composition-api.md
diff --git a/docs/guide/advanced/data-fetching.md → ...ages/docs/guide/advanced/data-fetching.md b/docs/guide/advanced/data-fetching.md → ...ages/docs/guide/advanced/data-fetching.md
diff --git a/docs/guide/advanced/dynamic-routing.md → ...es/docs/guide/advanced/dynamic-routing.md b/docs/guide/advanced/dynamic-routing.md → ...es/docs/guide/advanced/dynamic-routing.md
diff --git a/docs/guide/advanced/extending-router-link.md → ...s/guide/advanced/extending-router-link.md b/docs/guide/advanced/extending-router-link.md → ...s/guide/advanced/extending-router-link.md
diff --git a/docs/guide/advanced/lazy-loading.md → packages/docs/guide/advanced/lazy-loading.md b/docs/guide/advanced/lazy-loading.md → packages/docs/guide/advanced/lazy-loading.md
diff --git a/docs/guide/advanced/meta.md → packages/docs/guide/advanced/meta.md b/docs/guide/advanced/meta.md → packages/docs/guide/advanced/meta.md
diff --git a/docs/guide/advanced/navigation-failures.md → ...ocs/guide/advanced/navigation-failures.md b/docs/guide/advanced/navigation-failures.md → ...ocs/guide/advanced/navigation-failures.md
diff --git a/docs/guide/advanced/navigation-guards.md → .../docs/guide/advanced/navigation-guards.md b/docs/guide/advanced/navigation-guards.md → .../docs/guide/advanced/navigation-guards.md
diff --git a/docs/guide/advanced/scroll-behavior.md → ...es/docs/guide/advanced/scroll-behavior.md b/docs/guide/advanced/scroll-behavior.md → ...es/docs/guide/advanced/scroll-behavior.md
diff --git a/docs/guide/advanced/transitions.md → packages/docs/guide/advanced/transitions.md b/docs/guide/advanced/transitions.md → packages/docs/guide/advanced/transitions.md
diff --git a/docs/guide/essentials/dynamic-matching.md → ...docs/guide/essentials/dynamic-matching.md b/docs/guide/essentials/dynamic-matching.md → ...docs/guide/essentials/dynamic-matching.md
diff --git a/docs/guide/essentials/history-mode.md → ...ges/docs/guide/essentials/history-mode.md b/docs/guide/essentials/history-mode.md → ...ges/docs/guide/essentials/history-mode.md
diff --git a/docs/guide/essentials/named-routes.md → ...ges/docs/guide/essentials/named-routes.md b/docs/guide/essentials/named-routes.md → ...ges/docs/guide/essentials/named-routes.md
diff --git a/docs/guide/essentials/named-views.md → ...ages/docs/guide/essentials/named-views.md b/docs/guide/essentials/named-views.md → ...ages/docs/guide/essentials/named-views.md
diff --git a/docs/guide/essentials/navigation.md → packages/docs/guide/essentials/navigation.md b/docs/guide/essentials/navigation.md → packages/docs/guide/essentials/navigation.md
diff --git a/docs/guide/essentials/nested-routes.md → ...es/docs/guide/essentials/nested-routes.md b/docs/guide/essentials/nested-routes.md → ...es/docs/guide/essentials/nested-routes.md
diff --git a/docs/guide/essentials/passing-props.md → ...es/docs/guide/essentials/passing-props.md b/docs/guide/essentials/passing-props.md → ...es/docs/guide/essentials/passing-props.md
diff --git a/docs/guide/essentials/redirect-and-alias.md → ...cs/guide/essentials/redirect-and-alias.md b/docs/guide/essentials/redirect-and-alias.md → ...cs/guide/essentials/redirect-and-alias.md
diff --git a/...guide/essentials/route-matching-syntax.md → ...guide/essentials/route-matching-syntax.md b/...guide/essentials/route-matching-syntax.md → ...guide/essentials/route-matching-syntax.md
diff --git a/docs/guide/index.md → packages/docs/guide/index.md b/docs/guide/index.md → packages/docs/guide/index.md
diff --git a/docs/guide/migration/index.md → packages/docs/guide/migration/index.md b/docs/guide/migration/index.md → packages/docs/guide/migration/index.md
diff --git a/docs/index.md → packages/docs/index.md b/docs/index.md → packages/docs/index.md
diff --git a/docs/installation.md → packages/docs/installation.md b/docs/installation.md → packages/docs/installation.md
diff --git a/docs/introduction.md → packages/docs/introduction.md b/docs/introduction.md → packages/docs/introduction.md
diff --git a/packages/docs/package.json b/packages/docs/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "@vue/router-docs",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "docs": "vitepress dev .",
+    "docs:api": "node run-typedoc.js",
+    "docs:build": "vitepress build ."
+  },
+  "dependencies": {
+    "vitepress": "^0.20.0"
+  }
+}
diff --git a/.../public/Vue_Router_-_Getting_Started.jpeg → .../public/Vue_Router_-_Getting_Started.jpeg b/.../public/Vue_Router_-_Getting_Started.jpeg → .../public/Vue_Router_-_Getting_Started.jpeg
diff --git a/docs/public/images/vueschool/close.svg → ...es/docs/public/images/vueschool/close.svg b/docs/public/images/vueschool/close.svg → ...es/docs/public/images/vueschool/close.svg
diff --git a/docs/public/images/vueschool/vs-backpack.png → ...s/public/images/vueschool/vs-backpack.png b/docs/public/images/vueschool/vs-backpack.png → ...s/public/images/vueschool/vs-backpack.png
diff --git a/packages/docs/public/images/vueschool/vs-close.svg b/packages/docs/public/images/vueschool/vs-close.svg
diff --git a/packages/docs/public/images/vueschool/vs-fw-bg-small.svg b/packages/docs/public/images/vueschool/vs-fw-bg-small.svg
diff --git a/packages/docs/public/images/vueschool/vs-fw-bg.svg b/packages/docs/public/images/vueschool/vs-fw-bg.svg
diff --git a/docs/public/images/vueschool/vs-iso.svg → ...s/docs/public/images/vueschool/vs-iso.svg b/docs/public/images/vueschool/vs-iso.svg → ...s/docs/public/images/vueschool/vs-iso.svg
diff --git a/docs/public/images/vueschool/vs-logo.svg → .../docs/public/images/vueschool/vs-logo.svg b/docs/public/images/vueschool/vs-logo.svg → .../docs/public/images/vueschool/vs-logo.svg
diff --git a/docs/public/logo.png → packages/docs/public/logo.png b/docs/public/logo.png → packages/docs/public/logo.png
diff --git a/docs/public/service-worker.js → packages/docs/public/service-worker.js b/docs/public/service-worker.js → packages/docs/public/service-worker.js
@@ -10,6 +10,6 @@ self.addEventListener('activate', function (e) {
       return self.clients.matchAll()
     })
     .then(function (clients) {
-      clients.forEach((client) => client.navigate(client.url))
+      clients.forEach(client => client.navigate(client.url))
     })
 })
diff --git a/...public/sponsors/fincliplogo_black_svg.svg → ...public/sponsors/fincliplogo_black_svg.svg b/...public/sponsors/fincliplogo_black_svg.svg → ...public/sponsors/fincliplogo_black_svg.svg
diff --git a/...public/sponsors/fincliplogo_white_svg.svg → ...public/sponsors/fincliplogo_white_svg.svg b/...public/sponsors/fincliplogo_white_svg.svg → ...public/sponsors/fincliplogo_white_svg.svg
diff --git a/...ublic/sponsors/passionate-people-dark.png → ...ublic/sponsors/passionate-people-dark.png b/...ublic/sponsors/passionate-people-dark.png → ...ublic/sponsors/passionate-people-dark.png
diff --git a/...blic/sponsors/passionate-people-light.png → ...blic/sponsors/passionate-people-light.png b/...blic/sponsors/passionate-people-light.png → ...blic/sponsors/passionate-people-light.png
diff --git a/docs/public/sponsors/vuejobs.png → packages/docs/public/sponsors/vuejobs.png b/docs/public/sponsors/vuejobs.png → packages/docs/public/sponsors/vuejobs.png
diff --git a/...ublic/sponsors/vuetify-logo-dark-text.svg → ...ublic/sponsors/vuetify-logo-dark-text.svg b/...ublic/sponsors/vuetify-logo-dark-text.svg → ...ublic/sponsors/vuetify-logo-dark-text.svg
diff --git a/...blic/sponsors/vuetify-logo-light-text.svg → ...blic/sponsors/vuetify-logo-light-text.svg b/...blic/sponsors/vuetify-logo-light-text.svg → ...blic/sponsors/vuetify-logo-light-text.svg
diff --git a/docs/zh/api/index.md → packages/docs/zh/api/index.md b/docs/zh/api/index.md → packages/docs/zh/api/index.md
diff --git a/docs/zh/guide/advanced/composition-api.md → ...docs/zh/guide/advanced/composition-api.md b/docs/zh/guide/advanced/composition-api.md → ...docs/zh/guide/advanced/composition-api.md
diff --git a/docs/zh/guide/advanced/data-fetching.md → ...s/docs/zh/guide/advanced/data-fetching.md b/docs/zh/guide/advanced/data-fetching.md → ...s/docs/zh/guide/advanced/data-fetching.md
diff --git a/docs/zh/guide/advanced/dynamic-routing.md → ...docs/zh/guide/advanced/dynamic-routing.md b/docs/zh/guide/advanced/dynamic-routing.md → ...docs/zh/guide/advanced/dynamic-routing.md
diff --git a/...h/guide/advanced/extending-router-link.md → ...h/guide/advanced/extending-router-link.md b/...h/guide/advanced/extending-router-link.md → ...h/guide/advanced/extending-router-link.md
diff --git a/docs/zh/guide/advanced/lazy-loading.md → ...es/docs/zh/guide/advanced/lazy-loading.md b/docs/zh/guide/advanced/lazy-loading.md → ...es/docs/zh/guide/advanced/lazy-loading.md
diff --git a/docs/zh/guide/advanced/meta.md → packages/docs/zh/guide/advanced/meta.md b/docs/zh/guide/advanced/meta.md → packages/docs/zh/guide/advanced/meta.md
diff --git a/.../zh/guide/advanced/navigation-failures.md → .../zh/guide/advanced/navigation-failures.md b/.../zh/guide/advanced/navigation-failures.md → .../zh/guide/advanced/navigation-failures.md
diff --git a/docs/zh/guide/advanced/navigation-guards.md → ...cs/zh/guide/advanced/navigation-guards.md b/docs/zh/guide/advanced/navigation-guards.md → ...cs/zh/guide/advanced/navigation-guards.md
diff --git a/docs/zh/guide/advanced/scroll-behavior.md → ...docs/zh/guide/advanced/scroll-behavior.md b/docs/zh/guide/advanced/scroll-behavior.md → ...docs/zh/guide/advanced/scroll-behavior.md
diff --git a/docs/zh/guide/advanced/transitions.md → ...ges/docs/zh/guide/advanced/transitions.md b/docs/zh/guide/advanced/transitions.md → ...ges/docs/zh/guide/advanced/transitions.md
diff --git a/docs/zh/guide/essentials/dynamic-matching.md → ...s/zh/guide/essentials/dynamic-matching.md b/docs/zh/guide/essentials/dynamic-matching.md → ...s/zh/guide/essentials/dynamic-matching.md
diff --git a/docs/zh/guide/essentials/history-mode.md → .../docs/zh/guide/essentials/history-mode.md b/docs/zh/guide/essentials/history-mode.md → .../docs/zh/guide/essentials/history-mode.md
diff --git a/docs/zh/guide/essentials/named-routes.md → .../docs/zh/guide/essentials/named-routes.md b/docs/zh/guide/essentials/named-routes.md → .../docs/zh/guide/essentials/named-routes.md
diff --git a/docs/zh/guide/essentials/named-views.md → ...s/docs/zh/guide/essentials/named-views.md b/docs/zh/guide/essentials/named-views.md → ...s/docs/zh/guide/essentials/named-views.md
diff --git a/docs/zh/guide/essentials/navigation.md → ...es/docs/zh/guide/essentials/navigation.md b/docs/zh/guide/essentials/navigation.md → ...es/docs/zh/guide/essentials/navigation.md
diff --git a/docs/zh/guide/essentials/nested-routes.md → ...docs/zh/guide/essentials/nested-routes.md b/docs/zh/guide/essentials/nested-routes.md → ...docs/zh/guide/essentials/nested-routes.md
diff --git a/docs/zh/guide/essentials/passing-props.md → ...docs/zh/guide/essentials/passing-props.md b/docs/zh/guide/essentials/passing-props.md → ...docs/zh/guide/essentials/passing-props.md
diff --git a/...zh/guide/essentials/redirect-and-alias.md → ...zh/guide/essentials/redirect-and-alias.md b/...zh/guide/essentials/redirect-and-alias.md → ...zh/guide/essentials/redirect-and-alias.md
diff --git a/...guide/essentials/route-matching-syntax.md → ...guide/essentials/route-matching-syntax.md b/...guide/essentials/route-matching-syntax.md → ...guide/essentials/route-matching-syntax.md
diff --git a/docs/zh/guide/index.md → packages/docs/zh/guide/index.md b/docs/zh/guide/index.md → packages/docs/zh/guide/index.md
diff --git a/docs/zh/guide/migration/index.md → packages/docs/zh/guide/migration/index.md b/docs/zh/guide/migration/index.md → packages/docs/zh/guide/migration/index.md
diff --git a/docs/zh/index.md → packages/docs/zh/index.md b/docs/zh/index.md → packages/docs/zh/index.md
diff --git a/docs/zh/installation.md → packages/docs/zh/installation.md b/docs/zh/installation.md → packages/docs/zh/installation.md
diff --git a/docs/zh/introduction.md → packages/docs/zh/introduction.md b/docs/zh/introduction.md → packages/docs/zh/introduction.md
diff --git a/packages/router/package.json b/packages/router/package.json
@@ -132,7 +132,6 @@
     "serve-handler": "^6.1.3",
     "typescript": "~4.7.3",
     "vite": "~2.9.10",
-    "vitepress": "^0.20.0",
     "vue": "^3.2.31",
     "vue-tsc": "^0.37.2",
     "yorkie": "^2.0.0"