+
+
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index 7a01c18b..00000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# VuePress Documentation Contributing Guide
-
-## Overview
-
-VuePress documentation is powered by VuePress itself, which is built from the source code of this repository.
-
-All the markdown source files are placed in `docs` directory. We are maintaining two translations:
-
-- English (en-US) in `/` path
-- Chinese (zh-CN) in `/zh/` path
-
-We have two different deployments:
-
-- Release deployment powered by [Netlify](https://www.netlify.com). This deployment is built from the latest released version, so users will not see unreleased changes. The domain name is [https://vuepress.vuejs.org](https://vuepress.vuejs.org).
-- Developer deployment powered by [GitHub Pages](https://pages.github.com). This deployment is built from the latest commit, so developers could preview the latest changes. The domain name is [https://vuepress.github.io](https://vuepress.github.io).
diff --git a/CONTRIBUTING_zh.md b/CONTRIBUTING_zh.md
deleted file mode 100644
index 58bafe6a..00000000
--- a/CONTRIBUTING_zh.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# VuePress 文档贡献指南
-
-## 概览
-
-VuePress 的文档是由 VuePress 自己驱动的，是由该仓库中的源码构建而来。
-
-所有的 Markdown 源文件都放置在 `docs` 目录下。我们维护了两种翻译：
-
-- 英语 (en-US) 在 `/` 路径下
-- 中文 (zh-CN) 在 `/zh/` 路径下
-
-我们部署了两套站点：
-
-- 在 [Netlify](https://www.netlify.com) 部署的 Release 版本。该站点是从最新发布的版本中构建而来，因此用户不会看到未发布的改动。域名为 [https://vuepress.vuejs.org](https://vuepress.vuejs.org)。
-- 在 [GitHub Pages](https://pages.github.com) 部署的 Developer 版本。该站点是从最新的提交中构建而来，因此开发者可以预览最新的改动。域名为 [https://vuepress.github.io](https://vuepress.github.io)。
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index 44387d62..00000000
--- a/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018-present, VuePress Community
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
diff --git a/README.md b/README.md
deleted file mode 100644
index 551f0688..00000000
--- a/README.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# VuePress Documentation
-
-[](https://github.com/vuepress/docs/actions/workflows/check-docs.yml)
-[](https://github.com/vuepress/docs/actions/workflows/docs.yml)
-[](https://github.com/vuepress/docs/blob/main/LICENSE)
-
-VuePress documentation repository.
-
-## Deployments
-
-- Release deployment:
-- Developer deployment:
-
-## License
-
-[MIT](https://github.com/vuepress/docs/blob/main/LICENSE)
diff --git a/advanced/architecture.html b/advanced/architecture.html
new file mode 100644
index 00000000..a9e92dd8
--- /dev/null
+++ b/advanced/architecture.html
@@ -0,0 +1,41 @@
+
+
+
+
+
+
+
+
+
+ Architecture | VuePress
+
+
+
+
+
+
This approach requires you to determine which parts of your theme could be extended. It is more suitable for those common customizations like page footer or header.
You just need to provide slots in your layouts, and tell users how to make use of them:
This approach requires you to consider which components of your theme should be replaceable, and you also need to split components into a suitable granularity.
First, set alias for replaceable components of you theme:
import type { Theme } from 'vuepress/core'
+import { getDirname } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export const fooTheme = (options): Theme => ({
+ name: 'vuepress-theme-foo',
+ alias: {
+ // set alias for replaceable components
+ '@theme/Navbar.vue': path.resolve(__dirname, 'components/Navbar.vue'),
+ '@theme/Sidebar.vue': path.resolve(__dirname, 'components/Sidebar.vue'),
+ },
+})
Next, use those components via aliases in your theme:
Each Markdown file is first compiled into HTML, and then converted to a Vue SFC. In other words, you can write a Markdown file like a Vue SFC:
Blocks <script> and <style> are treated as Vue SFC blocks as they are. In other words, they are hoisted from the <template> block to the top-level of SFC.
Everything outside <script> and <style> will be compiled into HTML, and be treated as Vue SFC <template> block.
Warning
As Vue SFC can contain only one <script> element, you should avoid using more than one <script> in VuePress markdown.
As we know, VuePress plugin entries and theme entries are processed in Node side, but sometimes you might need to pass data to client side. For example, you want to generate different data when users use different options.
You can make use of useRoutes to get all routes information.
The return value of useRoutes is a Ref object containing all routes. The keys are route paths of each route, and the values are the corresponding route information.
There is a notFound field in the returned information, which is used to indicate whether a corresponding route exists for a given path. When the route does not exist, the notFound field would be true, the path field would be the normalized path, and the meta and loader fields would point to the default 404 page.
VuePress will generate a SSR application to pre-render pages during build. Generally speaking, if a code snippet is using Browser / DOM APIs before client app is mounted, we call it non-SSR-friendly.
We already provides a ClientOnly component to wrap non-SSR-friendly content.
In the enhance function, you can make use of the __VUEPRESS_SSR__ flag for that purpose.
You can take the setup function as part of the setup hook of the root component. Thus, all composition APIs are available here.
import { provide, ref } from 'vue'
+import { useRoute, useRouter } from 'vue-router'
+import { defineClientConfig } from 'vuepress/client'
+
+export default defineClientConfig({
+ setup() {
+ // get the current route location
+ const route = useRoute()
+ // get the vue-router instance
+ const router = useRouter()
+ // provide a value that can be injected by layouts, pages and other components
+ const count = ref(0)
+ provide('count', count)
+ },
+})
A plugin usually needs to allow user options, so we typically provide users with a function to receive options, and returns a Plugin Object or a Plugin Function. Then your plugin should be converted like this:
Set name to follow the naming convention, i.e. vuepress-plugin-xxx or @org/vuepress-plugin-xxx, which should be consistent with the name field of the Plugin Object.
Set keywords to include vuepress-plugin, so that users can search your plugin on NPM.
A VuePress theme is a special plugin, which should satisfy the Theme API. Like plugins, a theme should also be a Theme Object or a Theme Function, and could be wrapped with a function to receive options:
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+const fooTheme = (options) =>
+ // returns a theme object
+ ({
+ name: 'vuepress-theme-foo',
+
+ // path to the client config of your theme
+ clientConfigFile: path.resolve(__dirname, 'client.js'),
+
+ // set custom dev / build template
+ // if the template is not specified, the default template
+ templateBuild: path.resolve(__dirname, 'templates/build.html'),
+ templateDev: path.resolve(__dirname, 'templates/dev.html'),
+
+ // use plugins
+ plugins: [
+ // ...
+ ],
+
+ // other plugin APIs are also available
+ })
+
+const barTheme =
+ (options) =>
+ // returns a theme function
+ (app) => ({
+ name: 'vuepress-theme-bar',
+ // ...
+ })
import { defineClientConfig } from 'vuepress/client'
+import Layout from './layouts/Layout.vue'
+import NotFound from './layouts/NotFound.vue'
+
+export default defineClientConfig({
+ layouts: {
+ Layout,
+ NotFound,
+ },
+})
The layouts field declares the layouts provided by your theme. A theme must provide at least two layouts: Layout and NotFound. The former is to provide default layout for common pages, while the latter is to provide layout for 404-not-found page.
The Layout layout should contain the Content component to display the markdown content:
Set name to follow the naming convention: vuepress-theme-xxx or @org/vuepress-theme-xxx, which should be consistent with the name field of the Theme Object.
Set keywords to include vuepress-theme, so that users can search your theme on NPM.
+
+
+
diff --git a/assets/404.html-BxYlFJ7d.js b/assets/404.html-BxYlFJ7d.js
new file mode 100644
index 00000000..961dc8f3
--- /dev/null
+++ b/assets/404.html-BxYlFJ7d.js
@@ -0,0 +1 @@
+import{_ as e}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as o,b as n,o as r}from"./app-DVsngoLV.js";const a={};function p(s,t){return r(),o("div",null,t[0]||(t[0]=[n("p",null,"404 Not Found",-1)]))}const l=e(a,[["render",p]]),m=JSON.parse('{"path":"/404.html","title":"","lang":"en-US","frontmatter":{"layout":"NotFound","description":"404 Not Found","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"\\",\\"description\\":\\"404 Not Found\\"}"],["meta",{"property":"og:url","content":"https://vuejs.press/404.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:description","content":"404 Not Found"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}]]},"git":{},"readingTime":{"minutes":0.01,"words":3},"filePathRelative":null,"autoDesc":true}');export{l as comp,m as data};
diff --git a/assets/NpmBadge-Bgluwknq.js b/assets/NpmBadge-Bgluwknq.js
new file mode 100644
index 00000000..b5ab2e80
--- /dev/null
+++ b/assets/NpmBadge-Bgluwknq.js
@@ -0,0 +1 @@
+import{i as p,j as a,c as r,o as d,b as g}from"./app-DVsngoLV.js";import{_ as l}from"./plugin-vue_export-helper-DlAUqK2U.js";const m=["href","title"],i=["src","alt"],_=p({__name:"NpmBadge",props:{package:{},distTag:{default:"next"}},setup(s){const e=s,n=a(()=>`https://www.npmjs.com/package/${e.package}`),o=a(()=>e.distTag?`${e.package}@${e.distTag}`:e.package),c=a(()=>`https://badgen.net/npm/v/${e.package}/${e.distTag}?label=${encodeURIComponent(o.value)}`);return(t,k)=>(d(),r("a",{class:"npm-badge",href:n.value,title:t.package,target:"_blank",rel:"noopener noreferrer"},[g("img",{src:c.value,alt:t.package},null,8,i)],8,m))}}),b=l(_,[["__scopeId","data-v-95cd33a3"]]);export{b as default};
diff --git a/assets/adding-extra-pages.html-CeDS6Gl0.js b/assets/adding-extra-pages.html-CeDS6Gl0.js
new file mode 100644
index 00000000..d27b9c6d
--- /dev/null
+++ b/assets/adding-extra-pages.html-CeDS6Gl0.js
@@ -0,0 +1,26 @@
+import{_ as l}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as h,b as i,a as p,d as a,e as t,w as e,r as k,o as r}from"./app-DVsngoLV.js";const d={};function o(g,s){const n=k("RouteLink");return r(),h("div",null,[s[5]||(s[5]=i("h1",{id:"添加额外页面",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#添加额外页面"},[i("span",null,"添加额外页面")])],-1)),s[6]||(s[6]=i("p",null,"有时你可能希望在不创建 Markdown 文件的情况下添加一些额外的页面。",-1)),i("p",null,[s[2]||(s[2]=a("我们可以借助于 ")),t(n,{to:"/zh/reference/plugin-api.html"},{default:e(()=>s[0]||(s[0]=[a("插件 API")])),_:1}),s[3]||(s[3]=a(" 和 ")),t(n,{to:"/zh/reference/node-api.html"},{default:e(()=>s[1]||(s[1]=[a("Node API")])),_:1}),s[4]||(s[4]=a(" 来轻松实现。"))]),s[7]||(s[7]=p(`
`,3))])}const B=l(d,[["render",o]]),c=JSON.parse('{"path":"/zh/advanced/cookbook/adding-extra-pages.html","title":"添加额外页面","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:circle-plus","description":"添加额外页面 有时你可能希望在不创建 Markdown 文件的情况下添加一些额外的页面。 我们可以借助于 和 来轻松实现。 添加默认的主页 作为一个主题作者，你可能不想要求用户必须创建一个 /README.md 文件来作为主页，但是你希望提供一个默认的主页：","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"添加额外页面\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/advanced/cookbook/adding-extra-pages.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"添加额外页面"}],["meta",{"property":"og:description","content":"添加额外页面 有时你可能希望在不创建 Markdown 文件的情况下添加一些额外的页面。 我们可以借助于 和 来轻松实现。 添加默认的主页 作为一个主题作者，你可能不想要求用户必须创建一个 /README.md 文件来作为主页，但是你希望提供一个默认的主页："}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/cookbook/adding-extra-pages.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":2,"url":"https://github.com/meteorlxy"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":0.67,"words":200},"filePathRelative":"zh/advanced/cookbook/adding-extra-pages.md","autoDesc":true}');export{B as comp,c as data};
diff --git a/assets/adding-extra-pages.html-DZro9Kg7.js b/assets/adding-extra-pages.html-DZro9Kg7.js
new file mode 100644
index 00000000..2e3591b6
--- /dev/null
+++ b/assets/adding-extra-pages.html-DZro9Kg7.js
@@ -0,0 +1,26 @@
+import{_ as l}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as h,b as s,a as p,d as a,e as t,w as n,r as k,o as d}from"./app-DVsngoLV.js";const r={};function o(g,i){const e=k("RouteLink");return d(),h("div",null,[i[5]||(i[5]=s("h1",{id:"adding-extra-pages",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#adding-extra-pages"},[s("span",null,"Adding Extra Pages")])],-1)),i[6]||(i[6]=s("p",null,"Sometimes you might want to add some extra pages without creating a markdown file in the source directory.",-1)),s("p",null,[i[2]||(i[2]=a("With the help of ")),t(e,{to:"/reference/plugin-api.html"},{default:n(()=>i[0]||(i[0]=[a("Plugin API")])),_:1}),i[3]||(i[3]=a(" and ")),t(e,{to:"/reference/node-api.html"},{default:n(()=>i[1]||(i[1]=[a("Node API")])),_:1}),i[4]||(i[4]=a(", we can do that with ease."))]),i[7]||(i[7]=p(`
',9)),r("p",null,[e[1]||(e[1]=t("The above figure shows the core process of VuePress Node App and the hooks of ")),l(o,{to:"/reference/plugin-api.html"},{default:i(()=>e[0]||(e[0]=[t("Plugin API")])),_:1}),e[2]||(e[2]=t(":"))]),r("ul",null,[r("li",null,[e[14]||(e[14]=t("In the ")),e[15]||(e[15]=r("strong",null,"init",-1)),e[16]||(e[16]=t(" stage: ")),r("ul",null,[e[13]||(e[13]=r("li",null,"Theme and plugins will be loaded. That means all the plugins should be used before initialization.",-1)),r("li",null,[e[7]||(e[7]=t("As we are using markdown-it to parse the markdown file, so we need to create markdown-it instance before loading pages: ")),r("ul",null,[r("li",null,[l(o,{to:"/reference/plugin-api.html#extendsmarkdownoptions"},{default:i(()=>e[3]||(e[3]=[t("extendsMarkdownOptions")])),_:1}),e[4]||(e[4]=t(" hook will be processed to create markdown-it instance."))]),r("li",null,[l(o,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:i(()=>e[5]||(e[5]=[t("extendsMarkdown")])),_:1}),e[6]||(e[6]=t(" hook will be processed extends markdown-it instance."))])])]),r("li",null,[e[12]||(e[12]=t("Page files will be loaded: ")),r("ul",null,[r("li",null,[l(o,{to:"/reference/plugin-api.html#extendspageoptions"},{default:i(()=>e[8]||(e[8]=[t("extendsPageOptions")])),_:1}),e[9]||(e[9]=t(" hook will be processed to create pages."))]),r("li",null,[l(o,{to:"/reference/plugin-api.html#extendspage"},{default:i(()=>e[10]||(e[10]=[t("extendsPage")])),_:1}),e[11]||(e[11]=t(" hook will be processed to extends page object."))])])])])]),e[27]||(e[27]=r("li",null,[t("In the "),r("strong",null,"prepare"),t(" stage: "),r("ul",null,[r("li",null,"Temp files will be generated, so all hooks related to client files will be processed here.")])],-1)),r("li",null,[e[24]||(e[24]=t("In the ")),e[25]||(e[25]=r("strong",null,"dev / build",-1)),e[26]||(e[26]=t(" stage: ")),r("ul",null,[r("li",null,[e[23]||(e[23]=t("Bundler will be resolved: ")),r("ul",null,[r("li",null,[l(o,{to:"/reference/plugin-api.html#extendsbundleroptions"},{default:i(()=>e[17]||(e[17]=[t("extendsBundlerOptions")])),_:1}),e[18]||(e[18]=t(" hook will be processed to create bundler configuration."))]),r("li",null,[l(o,{to:"/reference/plugin-api.html#alias"},{default:i(()=>e[19]||(e[19]=[t("alias")])),_:1}),e[21]||(e[21]=t(" hook and ")),l(o,{to:"/reference/plugin-api.html#define"},{default:i(()=>e[20]||(e[20]=[t("define")])),_:1}),e[22]||(e[22]=t(" hook would be used in bundler configuration, so they will be processed here."))])])])])])])])}const b=a(g,[["render",f]]),k=JSON.parse('{"path":"/advanced/architecture.html","title":"Architecture","lang":"en-US","frontmatter":{"icon":"fa6-solid:folder-tree","description":"Architecture Overview vuepress-architecture-overview The above figure shows a brief overview of the VuePress architecture: Node App will generate temp files, including the pages...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Architecture\\",\\"image\\":[\\"https://vuejs.press/images/guide/vuepress-architecture-overview.png\\",\\"https://vuejs.press/images/guide/vuepress-core-process.png\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/architecture.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Architecture"}],["meta",{"property":"og:description","content":"Architecture Overview vuepress-architecture-overview The above figure shows a brief overview of the VuePress architecture: Node App will generate temp files, including the pages..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://vuejs.press/images/guide/vuepress-architecture-overview.png"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/architecture.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":2,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":1.01,"words":303},"filePathRelative":"advanced/architecture.md","autoDesc":true}');export{b as comp,k as data};
diff --git a/assets/assets.html-BidmvL9-.js b/assets/assets.html-BidmvL9-.js
new file mode 100644
index 00000000..026b7834
--- /dev/null
+++ b/assets/assets.html-BidmvL9-.js
@@ -0,0 +1,24 @@
+import{_ as h}from"./hero-BNkrhNQ6.js";import{_ as k}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as p,a as l,b as a,d as s,e as n,w as t,r,o as d}from"./app-DVsngoLV.js";const g={},o={class:"hint-container tip"},A={class:"hint-container tip"};function m(u,i){const e=r("RouteLink");return d(),p("div",null,[i[34]||(i[34]=l('
`,11)),a("div",A,[i[33]||(i[33]=a("p",{class:"hint-container-title"},"提示",-1)),a("p",null,[i[32]||(i[32]=s("配置参考： ")),n(e,{to:"/zh/reference/plugin-api.html#alias"},{default:t(()=>i[31]||(i[31]=[s("alias")])),_:1})])])])}const F=k(g,[["render",m]]),c=JSON.parse('{"path":"/zh/guide/assets.html","title":"静态资源","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:photo-film","description":"静态资源 相对路径 你可以在你的 Markdown 内容中使用相对路径来引用静态资源： 或 一般情况下，我们推荐你使用这种方式来引用图片，因为人们通常会把图片放在引用它的 Markdown 文件附近。 Public 文件 你可以把一些静态资源放在 Public 目录中，它们会被复制到最终生成的网站的根目录下。 默认的 Public 目录是 .vuepr...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"静态资源\\",\\"image\\":[\\"https://vuejs.press/images/hero.png\\",\\"https://vuejs.press/images/hero.png\\",\\"https://vuejs.press/images/hero.png\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/assets.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"静态资源"}],["meta",{"property":"og:description","content":"静态资源 相对路径 你可以在你的 Markdown 内容中使用相对路径来引用静态资源： 或 一般情况下，我们推荐你使用这种方式来引用图片，因为人们通常会把图片放在引用它的 Markdown 文件附近。 Public 文件 你可以把一些静态资源放在 Public 目录中，它们会被复制到最终生成的网站的根目录下。 默认的 Public 目录是 .vuepr..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://vuejs.press/images/hero.png"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/assets.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":4,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":2.44,"words":731},"filePathRelative":"zh/guide/assets.md","autoDesc":true}');export{F as comp,c as data};
diff --git a/assets/assets.html-CGIhIJTl.js b/assets/assets.html-CGIhIJTl.js
new file mode 100644
index 00000000..c8033561
--- /dev/null
+++ b/assets/assets.html-CGIhIJTl.js
@@ -0,0 +1,24 @@
+import{_ as h}from"./hero-BNkrhNQ6.js";import{_ as r}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as p,a as l,b as e,d as i,e as t,w as n,r as k,o as d}from"./app-DVsngoLV.js";const o={},g={class:"hint-container tip"},u={class:"hint-container tip"};function m(A,s){const a=k("RouteLink");return d(),p("div",null,[s[32]||(s[32]=l('
You can put some static assets inside public directory, and they will be copied to the root of the generated directory.
',9)),e("p",null,[s[1]||(s[1]=i("The default public directory is ")),s[2]||(s[2]=e("code",null,".vuepress/public",-1)),s[3]||(s[3]=i(", which can be changed by ")),t(a,{to:"/reference/config.html#public"},{default:n(()=>s[0]||(s[0]=[i("public")])),_:1}),s[4]||(s[4]=i(" option."))]),s[33]||(s[33]=l(`
It would be useful in some cases:
You may need to provide static assets that are not directly referenced in any of your Markdown files, for example, favicon and PWA icons.
You may need to serve some shared static assets, which may even be referenced outside your site, for example, logo images.
You may want to reference images using absolute URLs in your Markdown content.
Take our documentation source files as an example, we are putting the logo of VuePress inside the public directory:
└─ docs
+ ├─ .vuepress
+ | └─ public
+ | └─ images
+ | └─ hero.png # <- Logo file
+ └─ guide
+ └─ assets.md # <- Here we are
We can reference our logo in current page like this:
',10)),e("p",null,[s[6]||(s[6]=i("If your site is deployed to a non-root URL, for example, ")),s[7]||(s[7]=e("code",null,"https://foo.github.io/bar/",-1)),s[8]||(s[8]=i(", then the ")),t(a,{to:"/reference/config.html#base"},{default:n(()=>s[5]||(s[5]=[i("base")])),_:1}),s[9]||(s[9]=i(" should be set to ")),s[10]||(s[10]=e("code",null,"'/bar/'",-1)),s[11]||(s[11]=i(". Obviously, your public files would be served like ")),s[12]||(s[12]=e("code",null,"https://foo.github.io/bar/images/hero.png",-1)),s[13]||(s[13]=i(" after deployment."))]),s[34]||(s[34]=l('
In most cases, you don't need to worry about the reference path of those public files, as VuePress will automatically handle base for you:
<!-- you don't need to prepend `/bar/` to `/images/hero.png` manually -->\n\n
',2)),e("div",g,[s[21]||(s[21]=e("p",{class:"hint-container-title"},"Tips",-1)),e("p",null,[s[16]||(s[16]=i("When using ")),t(a,{to:"/reference/bundler/webpack.html"},{default:n(()=>s[14]||(s[14]=[i("webpack bundler")])),_:1}),s[17]||(s[17]=i(", you need to set ")),t(a,{to:"/reference/config.html#markdown-assets"},{default:n(()=>s[15]||(s[15]=[i("markdown.assets.absolutePathPrependBase")])),_:1}),s[18]||(s[18]=i(" to ")),s[19]||(s[19]=e("code",null,"true",-1)),s[20]||(s[20]=i(" to automatically prepend base to markdown images."))])]),e("p",null,[s[23]||(s[23]=i("However, sometimes you may have some dynamical links referencing public files, especially when you are authoring a custom theme. In such case, the ")),s[24]||(s[24]=e("code",null,"base",-1)),s[25]||(s[25]=i(" could not be handled automatically. To help with that, VuePress provides a ")),t(a,{to:"/reference/client-api.html#withbase"},{default:n(()=>s[22]||(s[22]=[i("withBase")])),_:1}),s[26]||(s[26]=i(" helper to prepend ")),s[27]||(s[27]=e("code",null,"base",-1)),s[28]||(s[28]=i(" for you:"))]),s[35]||(s[35]=l(`
<img src="@alias/image.png" alt="Image from path alias">
`,11)),e("div",u,[s[31]||(s[31]=e("p",{class:"hint-container-title"},"Tips",-1)),e("p",null,[s[30]||(s[30]=i("Config reference: ")),t(a,{to:"/reference/plugin-api.html#alias"},{default:n(()=>s[29]||(s[29]=[i("alias")])),_:1})])])])}const b=r(o,[["render",m]]),v=JSON.parse('{"path":"/guide/assets.html","title":"Assets","lang":"en-US","frontmatter":{"icon":"fa6-solid:photo-film","description":"Assets Relative URLs You can reference any assets using relative URLs in your Markdown content: or This is generally the suggested way to import images, as users usually place i...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Assets\\",\\"image\\":[\\"https://vuejs.press/images/hero.png\\",\\"https://vuejs.press/images/hero.png\\",\\"https://vuejs.press/images/hero.png\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/assets.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Assets"}],["meta",{"property":"og:description","content":"Assets Relative URLs You can reference any assets using relative URLs in your Markdown content: or This is generally the suggested way to import images, as users usually place i..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://vuejs.press/images/hero.png"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/assets.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":4,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":1.62,"words":486},"filePathRelative":"guide/assets.md","autoDesc":true}');export{b as comp,v as data};
diff --git a/assets/bundler.html-Cndzc5Ka.js b/assets/bundler.html-Cndzc5Ka.js
new file mode 100644
index 00000000..4f9ab901
--- /dev/null
+++ b/assets/bundler.html-Cndzc5Ka.js
@@ -0,0 +1,16 @@
+import{_ as d}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as o,a as h,e as n,b as i,w as t,d as e,r as k,o as u}from"./app-DVsngoLV.js";const m={};function g(c,s){const p=k("CodeTabs"),r=k("RouteLink");return u(),o("div",null,[s[11]||(s[11]=h('
VuePress supports using Webpack or Vite to dev and build sites. You can choose which bundler to use according to your preference, and no extra configuration is required.
When installing the vuepress package, no bundlers will be installed. You need to choose a bundler to install.
',4)),a(k,{id:"12",data:[{id:"pnpm"},{id:"yarn"},{id:"npm"}],"tab-id":"shell"},{title0:t(({value:n,isActive:l})=>e[0]||(e[0]=[s("pnpm")])),title1:t(({value:n,isActive:l})=>e[1]||(e[1]=[s("yarn")])),title2:t(({value:n,isActive:l})=>e[2]||(e[2]=[s("npm")])),tab0:t(({value:n,isActive:l})=>e[3]||(e[3]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#A0A1A7","--shiki-light-font-style":"italic","--shiki-dark":"#7F848E","--shiki-dark-font-style":"italic"}},"# install vite bundler")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"pnpm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," add"),i("span",{style:{"--shiki-light":"#986801","--shiki-dark":"#D19A66"}}," -D"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," vuepress@next"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," @vuepress/bundler-vite@next")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#A0A1A7","--shiki-light-font-style":"italic","--shiki-dark":"#7F848E","--shiki-dark-font-style":"italic"}},"# install webpack bundler")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"pnpm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," add"),i("span",{style:{"--shiki-light":"#986801","--shiki-dark":"#D19A66"}}," -D"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," vuepress@next"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," @vuepress/bundler-webpack@next")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"}),i("div",{class:"line-number"}),i("div",{class:"line-number"}),i("div",{class:"line-number"})])],-1)])),tab1:t(({value:n,isActive:l})=>e[4]||(e[4]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#A0A1A7","--shiki-light-font-style":"italic","--shiki-dark":"#7F848E","--shiki-dark-font-style":"italic"}},"# install vite bundler")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"yarn"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," add"),i("span",{style:{"--shiki-light":"#986801","--shiki-dark":"#D19A66"}}," -D"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," vuepress@next"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," @vuepress/bundler-vite@next")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#A0A1A7","--shiki-light-font-style":"italic","--shiki-dark":"#7F848E","--shiki-dark-font-style":"italic"}},"# install webpack bundler")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"yarn"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," add"),i("span",{style:{"--shiki-light":"#986801","--shiki-dark":"#D19A66"}}," -D"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," vuepress@next"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," @vuepress/bundler-webpack@next")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"}),i("div",{class:"line-number"}),i("div",{class:"line-number"}),i("div",{class:"line-number"})])],-1)])),tab2:t(({value:n,isActive:l})=>e[5]||(e[5]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#A0A1A7","--shiki-light-font-style":"italic","--shiki-dark":"#7F848E","--shiki-dark-font-style":"italic"}},"# install vite bundler")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"npm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," install"),i("span",{style:{"--shiki-light":"#986801","--shiki-dark":"#D19A66"}}," -D"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," vuepress@next"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," @vuepress/bundler-vite@next")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#A0A1A7","--shiki-light-font-style":"italic","--shiki-dark":"#7F848E","--shiki-dark-font-style":"italic"}},"# install webpack bundler")]),s(`
+`),i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"npm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," install"),i("span",{style:{"--shiki-light":"#986801","--shiki-dark":"#D19A66"}}," -D"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," vuepress@next"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," @vuepress/bundler-webpack@next")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"}),i("div",{class:"line-number"}),i("div",{class:"line-number"}),i("div",{class:"line-number"})])],-1)])),_:1}),e[12]||(e[12]=i("h2",{id:"use-a-bundler",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#use-a-bundler"},[i("span",null,"Use a Bundler")])],-1)),e[13]||(e[13]=i("p",null,"Generally, you could use a bundler without extra configuration, because we have already configured them properly to work with VuePress.",-1)),i("p",null,[e[7]||(e[7]=s("You can use a bundler via the ")),a(r,{to:"/reference/config.html#bundler"},{default:t(()=>e[6]||(e[6]=[s("bundler")])),_:1}),e[8]||(e[8]=s(" option:"))]),e[14]||(e[14]=h(`
When you need to customize the bundler, you can set the corresponding options:
`,2)),i("ul",null,[i("li",null,[a(r,{to:"/reference/bundler/vite.html"},{default:t(()=>e[9]||(e[9]=[s("Bundlers > Vite")])),_:1})]),i("li",null,[a(r,{to:"/reference/bundler/webpack.html"},{default:t(()=>e[10]||(e[10]=[s("Bundlers > Webpack")])),_:1})])])])}const A=p(c,[["render",g]]),v=JSON.parse('{"path":"/guide/bundler.html","title":"Bundler","lang":"en-US","frontmatter":{"icon":"fa6-solid:boxes-packing","description":"Bundler VuePress supports using Webpack or Vite to dev and build sites. You can choose which bundler to use according to your preference, and no extra configuration is required....","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Bundler\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/bundler.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Bundler"}],["meta",{"property":"og:description","content":"Bundler VuePress supports using Webpack or Vite to dev and build sites. You can choose which bundler to use according to your preference, and no extra configuration is required...."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/bundler.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":2,"url":"https://github.com/meteorlxy"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":3,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":0.66,"words":199},"filePathRelative":"guide/bundler.md","autoDesc":true}');export{A as comp,v as data};
diff --git a/assets/cli.html-BYnU5Row.js b/assets/cli.html-BYnU5Row.js
new file mode 100644
index 00000000..a761d7ac
--- /dev/null
+++ b/assets/cli.html-BYnU5Row.js
@@ -0,0 +1,43 @@
+import{_ as i}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as l,a as n,b as t,d as s,e as p,w as r,r as o,o as d}from"./app-DVsngoLV.js";const c={};function m(u,e){const a=o("RouteLink");return d(),l("div",null,[e[3]||(e[3]=n(`
Run vuepress --help to get following help messages:
Usage:
+ $ vuepress <command> [options]
+
+Commands:
+ dev [sourceDir] Start development server
+ build [sourceDir] Build to static site
+ info Display environment information
+
+For more info, run any command with the \`--help\` flag:
+ $ vuepress dev --help
+ $ vuepress build --help
+ $ vuepress info --help
+
+Options:
+ -v, --version Display version number
+ -h, --help Display this message
Start a development server to develop your VuePress site locally.
Usage:
+ $ vuepress dev [sourceDir]
+
+Options:
+ -c, --config <config> Set path to config file
+ -p, --port <port> Use specified port (default: 8080)
+ -t, --temp <temp> Set the directory of the temporary files
+ --host <host> Use specified host (default: 0.0.0.0)
+ --cache <cache> Set the directory of the cache files
+ --clean-temp Clean the temporary files before dev
+ --clean-cache Clean the cache files before dev
+ --open Open browser when ready
+ --debug Enable debug mode
+ --no-watch Disable watching page and config files (default: true)
+ -v, --version Display version number
+ -h, --help Display this message
Tips
Options set by CLI will override those options with the same name in your config file.
`,9)),t("p",null,[e[1]||(e[1]=s("Build your VuePress site to static files, which are ready for ")),p(a,{to:"/guide/deployment.html"},{default:r(()=>e[0]||(e[0]=[s("deployment")])),_:1}),e[2]||(e[2]=s("."))]),e[4]||(e[4]=n(`
Usage:
+ $ vuepress build [sourceDir]
+
+Options:
+ -c, --config <config> Set path to config file
+ -d, --dest <dest> Set the directory build output (default: .vuepress/dist)
+ -t, --temp <temp> Set the directory of the temporary files
+ --cache <cache> Set the directory of the cache files
+ --clean-temp Clean the temporary files before build
+ --clean-cache Clean the cache files before build
+ --debug Enable debug mode
+ -v, --version Display version number
+ -h, --help Display this message
Tips
Options set by CLI will override those options with the same name in your config file.
Outputs information about your system and dependencies.
This command would be helpful when you want to check your environment or report an issue.
`,5))])}const b=i(c,[["render",m]]),g=JSON.parse('{"path":"/reference/cli.html","title":"Command Line Interface","lang":"en-US","frontmatter":{"icon":"bi:terminal-fill","description":"Command Line Interface Run vuepress --help to get following help messages: Tips VuePress is using debug module. Set environment variable DEBUG=vuepress* to enable debug logs. de...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Command Line Interface\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/reference/cli.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Command Line Interface"}],["meta",{"property":"og:description","content":"Command Line Interface Run vuepress --help to get following help messages: Tips VuePress is using debug module. Set environment variable DEBUG=vuepress* to enable debug logs. de..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/cli.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":3,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":1.1,"words":330},"filePathRelative":"reference/cli.md","autoDesc":true}');export{b as comp,g as data};
diff --git a/assets/cli.html-xEorj72l.js b/assets/cli.html-xEorj72l.js
new file mode 100644
index 00000000..93136ef3
--- /dev/null
+++ b/assets/cli.html-xEorj72l.js
@@ -0,0 +1,43 @@
+import{_ as i}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as l,a as n,b as p,d as s,e as t,w as r,r as d,o as c}from"./app-DVsngoLV.js";const o={};function m(u,e){const a=d("RouteLink");return c(),l("div",null,[e[3]||(e[3]=n(`
Usage:
+ $ vuepress <command> [options]
+
+Commands:
+ dev [sourceDir] Start development server
+ build [sourceDir] Build to static site
+ info Display environment information
+
+For more info, run any command with the \`--help\` flag:
+ $ vuepress dev --help
+ $ vuepress build --help
+ $ vuepress info --help
+
+Options:
+ -v, --version Display version number
+ -h, --help Display this message
Usage:
+ $ vuepress dev [sourceDir]
+
+Options:
+ -c, --config <config> Set path to config file
+ -p, --port <port> Use specified port (default: 8080)
+ -t, --temp <temp> Set the directory of the temporary files
+ --host <host> Use specified host (default: 0.0.0.0)
+ --cache <cache> Set the directory of the cache files
+ --clean-temp Clean the temporary files before dev
+ --clean-cache Clean the cache files before dev
+ --open Open browser when ready
+ --debug Enable debug mode
+ --no-watch Disable watching page and config files (default: true)
+ -v, --version Display version number
+ -h, --help Display this message
Usage:
+ $ vuepress build [sourceDir]
+
+Options:
+ -c, --config <config> Set path to config file
+ -d, --dest <dest> Set the directory build output (default: .vuepress/dist)
+ -t, --temp <temp> Set the directory of the temporary files
+ --cache <cache> Set the directory of the cache files
+ --clean-temp Clean the temporary files before build
+ --clean-cache Clean the cache files before build
+ --debug Enable debug mode
+ -v, --version Display version number
+ -h, --help Display this message
`,4))])}const v=r(o,[["render",A]]),f=JSON.parse('{"path":"/zh/reference/client-api.html","title":"客户端 API","lang":"zh-CN","frontmatter":{"icon":"fa6-brands:chrome","description":"客户端 API 客户端 API 可以通过 vuepress/client 来引入。 组合式 API useClientData 详情： 返回所有客户端数据的 Ref 对象。 每个属性也可以通过下列的组合式 API 来访问。 示例： usePageData 详情： 返回当前页面数据的 Ref 对象。 参考： usePageFrontmatter 详情： ...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"客户端 API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/client-api.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"客户端 API"}],["meta",{"property":"og:description","content":"客户端 API 客户端 API 可以通过 vuepress/client 来引入。 组合式 API useClientData 详情： 返回所有客户端数据的 Ref 对象。 每个属性也可以通过下列的组合式 API 来访问。 示例： usePageData 详情： 返回当前页面数据的 Ref 对象。 参考： usePageFrontmatter 详情： ..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/client-api.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":7,"url":"https://github.com/meteorlxy"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":2,"url":"https://github.com/Mister-Hope"},{"name":"pengzhanbo","username":"pengzhanbo","email":"q942450674@outlook.com","commits":1,"url":"https://github.com/pengzhanbo"}]},"readingTime":{"minutes":2.61,"words":782},"filePathRelative":"zh/reference/client-api.md","autoDesc":true}');export{v as comp,f as data};
diff --git a/assets/client-api.html-D4ZKAx8U.js b/assets/client-api.html-D4ZKAx8U.js
new file mode 100644
index 00000000..a5ac9c16
--- /dev/null
+++ b/assets/client-api.html-D4ZKAx8U.js
@@ -0,0 +1,31 @@
+import{_ as h}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as d,a as t,b as i,e as a,w as l,d as e,r as p,o}from"./app-DVsngoLV.js";const k={},u={id:"resolvers",tabindex:"-1"},g={class:"header-anchor",href:"#resolvers"};function A(c,s){const n=p("RouteLink"),r=p("Badge");return o(),d("div",null,[s[43]||(s[43]=t(`
`,7)),i("ul",null,[s[3]||(s[3]=i("li",null,[i("p",null,"Details:"),i("p",null,"Returns the page data ref object of current page.")],-1)),i("li",null,[s[2]||(s[2]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[a(n,{to:"/reference/node-api.html#data"},{default:l(()=>s[0]||(s[0]=[e("Node API > Page Properties > data")])),_:1})]),i("li",null,[a(n,{to:"/reference/plugin-api.html#extendspage"},{default:l(()=>s[1]||(s[1]=[e("Plugin API > extendsPage")])),_:1})])])])]),s[44]||(s[44]=i("h3",{id:"usepagefrontmatter",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#usepagefrontmatter"},[i("span",null,"usePageFrontmatter")])],-1)),s[45]||(s[45]=i("ul",null,[i("li",null,[i("p",null,"Details:"),i("p",null,"Returns the frontmatter ref object of current page."),i("p",null,[e("The value is the "),i("code",null,"frontmatter"),e(" property of the page data.")])])],-1)),s[46]||(s[46]=i("h3",{id:"usepagehead",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#usepagehead"},[i("span",null,"usePageHead")])],-1)),i("ul",null,[i("li",null,[s[9]||(s[9]=i("p",null,"Details:",-1)),s[10]||(s[10]=i("p",null,"Returns the head config ref object of current page.",-1)),i("p",null,[s[6]||(s[6]=e("The value is obtained by merging and deduplicating ")),a(n,{to:"/reference/frontmatter.html#head"},{default:l(()=>s[4]||(s[4]=[e("head")])),_:1}),s[7]||(s[7]=e(" frontmatter and ")),a(n,{to:"/reference/config.html#head"},{default:l(()=>s[5]||(s[5]=[e("head")])),_:1}),s[8]||(s[8]=e(" config."))])])]),s[47]||(s[47]=t('
',5)),i("ul",null,[s[13]||(s[13]=i("li",null,[i("p",null,"Details:"),i("p",null,"Returns the routes ref object."),i("p",null,[e("The value is the "),i("code",null,"routes"),e(" property of the site data.")])],-1)),i("li",null,[s[12]||(s[12]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[a(n,{to:"/advanced/cookbook/resolving-routes.html"},{default:l(()=>s[11]||(s[11]=[e("Advanced > Cookbook > Resolving Routes")])),_:1})])])])]),s[48]||(s[48]=i("h3",{id:"useroutelocale",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#useroutelocale"},[i("span",null,"useRouteLocale")])],-1)),i("ul",null,[i("li",null,[s[17]||(s[17]=i("p",null,"Details:",-1)),s[18]||(s[18]=i("p",null,"Returns the locale path ref object of current route.",-1)),i("p",null,[s[15]||(s[15]=e("The value is one of the keys of the ")),a(n,{to:"/reference/config.html#locales"},{default:l(()=>s[14]||(s[14]=[e("locales")])),_:1}),s[16]||(s[16]=e(" config."))])])]),s[49]||(s[49]=t(`
`,8)),i("ul",null,[i("li",null,[s[22]||(s[22]=i("p",null,"Details:",-1)),i("p",null,[s[20]||(s[20]=e("Helper for creating ")),a(n,{to:"/reference/plugin-api.html#clientconfigfile"},{default:l(()=>s[19]||(s[19]=[e("clientConfigFile")])),_:1}),s[21]||(s[21]=e("."))])]),i("li",null,[s[24]||(s[24]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[a(n,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:l(()=>s[23]||(s[23]=[e("Advanced > Cookbook > Usage of Client Config")])),_:1})])])])]),s[50]||(s[50]=i("h3",{id:"resolveroute",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#resolveroute"},[i("span",null,"resolveRoute")])],-1)),i("ul",null,[s[27]||(s[27]=i("li",null,[i("p",null,"Details:"),i("p",null,"Parses the route of the given link.")],-1)),i("li",null,[s[26]||(s[26]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[a(n,{to:"/advanced/cookbook/resolving-routes.html"},{default:l(()=>s[25]||(s[25]=[e("Advanced > Cookbook > Resolving Routes")])),_:1})])])])]),s[51]||(s[51]=i("h3",{id:"resolveroutepath",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#resolveroutepath"},[i("span",null,"resolveRoutePath")])],-1)),i("ul",null,[s[30]||(s[30]=i("li",null,[i("p",null,"Details:"),i("p",null,"Parses the route path of the given link.")],-1)),i("li",null,[s[29]||(s[29]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[a(n,{to:"/advanced/cookbook/resolving-routes.html"},{default:l(()=>s[28]||(s[28]=[e("Advanced > Cookbook > Resolving Routes")])),_:1})])])])]),s[52]||(s[52]=i("h3",{id:"withbase",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#withbase"},[i("span",null,"withBase")])],-1)),i("ul",null,[i("li",null,[s[34]||(s[34]=i("p",null,"Details:",-1)),i("p",null,[s[32]||(s[32]=e("Prefix URL with site ")),a(n,{to:"/reference/config.html#base"},{default:l(()=>s[31]||(s[31]=[e("base")])),_:1}),s[33]||(s[33]=e("."))])]),i("li",null,[s[36]||(s[36]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[a(n,{to:"/guide/assets.html#base-helper"},{default:l(()=>s[35]||(s[35]=[e("Guide > Assets > Base Helper")])),_:1})])])])]),s[53]||(s[53]=t(`
resolvers will affect the basic functionality of VuePress. Please make sure you have fully understood its purpose before modifying it.
`,4))])}const m=h(k,[["render",A]]),f=JSON.parse('{"path":"/reference/client-api.html","title":"Client API","lang":"en-US","frontmatter":{"icon":"fa6-brands:chrome","description":"Client API Client API can be imported from vuepress/client. Composition API useClientData Details: Returns all the client data ref objects. Each property can also be accessed by...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Client API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/reference/client-api.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Client API"}],["meta",{"property":"og:description","content":"Client API Client API can be imported from vuepress/client. Composition API useClientData Details: Returns all the client data ref objects. Each property can also be accessed by..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/client-api.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":8,"url":"https://github.com/meteorlxy"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":2,"url":"https://github.com/Mister-Hope"},{"name":"pengzhanbo","username":"pengzhanbo","email":"q942450674@outlook.com","commits":1,"url":"https://github.com/pengzhanbo"}]},"readingTime":{"minutes":1.79,"words":536},"filePathRelative":"reference/client-api.md","autoDesc":true}');export{m as comp,f as data};
diff --git a/assets/components.html-DRn-dJE5.js b/assets/components.html-DRn-dJE5.js
new file mode 100644
index 00000000..7b6974c2
--- /dev/null
+++ b/assets/components.html-DRn-dJE5.js
@@ -0,0 +1,56 @@
+import{_ as t}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as e,a as n,b as i,d as a,e as h,w as k,r as p,o as d}from"./app-DVsngoLV.js";const r={};function o(c,s){const l=p("RouteLink");return d(),e("div",null,[s[3]||(s[3]=n(`
interface AutoLinkConfig {
+ /**
+ * Pattern to determine if the link should be active, which has higher priority than \`exact\`
+ */
+ activeMatch?: RegExp | string
+
+ /**
+ * The \`aria-label\` attribute
+ */
+ ariaLabel?: string
+
+ /**
+ * Whether the link should be active only if the url is an exact match
+ */
+ exact?: boolean
+
+ /**
+ * URL of the auto link
+ */
+ link: string
+
+ /**
+ * The \`rel\` attribute
+ */
+ rel?: string
+
+ /**
+ * The \`target\` attribute
+ */
+ target?: string
+
+ /**
+ * Text of the auto link
+ */
+ text: string
+}
This component will automatically render internal link as <RouteLink>, and render external link as <a>. It will also add necessary attributes correspondingly.
You can make use of the before and after slots to render content before and after the text. Also, you can use the default slot to render the text (default text is config.text).
This component is mainly for developing themes. Users won't need it in most cases. For theme authors, it's recommended to use this component to render links that could be either internal or external.
This component and its children will only be rendered in client-side. That means, it will not be rendered to HTML during build (SSR).
If a component is trying to access Browser / DOM APIs directly in setup(), an error will occur during build because those APIs are unavailable in Node.js environment. In such case, you could do either:
Modify the component to only access Browser / DOM APIs in onBeforeMount() or onMounted() hook.
Wrap the component with <ClientOnly>.
Tips
Since Vue 3.5, if you only want to avoid hydration mismatch, you can try the new data-allow-mismatch attribute instead of <ClientOnly> component.
`,15)),i("ul",null,[s[2]||(s[2]=i("li",null,[i("p",null,"Details:"),i("p",null,"This component will render the Markdown content of a page."),i("p",null,[n("If the "),i("code",null,"path"),n(" prop is not provided, it will render the page content of current route.")]),i("p",null,"This component is mainly for developing themes. You won't need it in most cases.")],-1)),i("li",null,[s[1]||(s[1]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[h(e,{to:"/reference/node-api.html#path"},{default:p(()=>s[0]||(s[0]=[n("Node API > Page Properties > path")])),_:1})])])])]),s[4]||(s[4]=a(`
<RouteLink to="/path/to/target-page.md">target page</RouteLink>
+<RouteLink active to="/path/to/current-page.md">current page</RouteLink>
Details:
This component will render a link to the target page.
If the active prop is set to true, the link will have an extra activeClass. Notice that the active status won't be updated automatically when the route changes.
This component is mainly for developing themes. Users won't need it in most cases. For theme authors, it's recommended to use this component to render internal links instead of the <RouterLink> component from vue-router.
`,4))])}const y=t(d,[["render",o]]),A=JSON.parse('{"path":"/reference/components.html","title":"Built-in Components","lang":"en-US","frontmatter":{"icon":"fa6-solid:puzzle-piece","description":"Built-in Components AutoLink Props: config Type: AutoLinkConfig Required: true Usage: Details: This component will automatically render internal link as , and render ...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Built-in Components\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/reference/components.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Built-in Components"}],["meta",{"property":"og:description","content":"Built-in Components AutoLink Props: config Type: AutoLinkConfig Required: true Usage: Details: This component will automatically render internal link as , and render ..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/components.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":6,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"张怀文","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":1.8,"words":539},"filePathRelative":"reference/components.md","autoDesc":true}');export{y as comp,A as data};
diff --git a/assets/config.html-5XTANjpy.js b/assets/config.html-5XTANjpy.js
new file mode 100644
index 00000000..4481f7fc
--- /dev/null
+++ b/assets/config.html-5XTANjpy.js
@@ -0,0 +1,15 @@
+import{_ as p}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as r,a as t,b as l,e as s,w as a,d as e,r as d,o}from"./app-DVsngoLV.js";const h={};function u(k,i){const n=d("RouteLink");return o(),r("div",null,[i[86]||(i[86]=t('
',9)),l("ul",null,[i[26]||(i[26]=l("li",null,[l("p",null,[e("类型： "),l("code",null,"string")])],-1)),i[27]||(i[27]=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"`${sourceDir}/.vuepress/public`")])],-1)),i[28]||(i[28]=l("li",null,[l("p",null,"详情："),l("p",null,"指定 Public 文件目录。")],-1)),l("li",null,[i[25]||(i[25]=l("p",null,"参考：",-1)),l("ul",null,[l("li",null,[s(n,{to:"/zh/guide/assets.html#public-%E6%96%87%E4%BB%B6"},{default:a(()=>i[24]||(i[24]=[e("指南 > 静态资源 > Public 文件")])),_:1})])])])]),i[95]||(i[95]=t('
",3)),l("li",null,[i[77]||(i[77]=l("p",null,"参考：",-1)),l("ul",null,[l("li",null,[s(n,{to:"/zh/guide/markdown.html#%E6%B7%BB%E5%8A%A0-v-pre"},{default:a(()=>i[76]||(i[76]=[e("指南 > Markdown > 语法扩展 > 代码块 > 添加 v-pre")])),_:1})])])])]),i[108]||(i[108]=l("h2",{id:"插件配置",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#插件配置"},[l("span",null,"插件配置")])],-1)),i[109]||(i[109]=l("h3",{id:"plugins",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#plugins"},[l("span",null,"plugins")])],-1)),l("ul",null,[i[81]||(i[81]=l("li",null,[l("p",null,[e("类型： "),l("code",null,"PluginConfig[]")])],-1)),i[82]||(i[82]=l("li",null,[l("p",null,"详情："),l("p",null,"要使用的插件。"),l("p",null,"该配置项接收一个数组，其中的每一个数组项是一个或一组插件。")],-1)),l("li",null,[i[80]||(i[80]=l("p",null,"参考：",-1)),l("ul",null,[l("li",null,[s(n,{to:"/zh/guide/plugin.html"},{default:a(()=>i[79]||(i[79]=[e("指南 > 插件")])),_:1})])])])]),i[110]||(i[110]=l("h2",{id:"插件-api",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#插件-api"},[l("span",null,"插件 API")])],-1)),i[111]||(i[111]=l("p",null,[e("用户配置文件同样可以作为一个 VuePress 插件，所以除了 "),l("code",null,"name"),e(" 和 "),l("code",null,"multiple"),e(" 配置项以外的所有插件 API 都可以在配置文件中使用。")],-1)),l("p",null,[i[84]||(i[84]=e("前往 ")),s(n,{to:"/zh/reference/plugin-api.html"},{default:a(()=>i[83]||(i[83]=[e("插件 API 参考")])),_:1}),i[85]||(i[85]=e(" 查看所有插件 API 。"))])])}const f=p(h,[["render",u]]),b=JSON.parse('{"path":"/zh/reference/config.html","title":"配置","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:gear","description":"配置 站点配置 base 类型： string 默认值： / 详情： 部署站点的基础路径。 如果你想让你的网站部署到一个子路径下，你将需要设置它。它的值应当总是以斜杠开始，并以斜杠结束。举例来说，如果你想将你的网站部署到 https://foo.github.io/bar/，那么 base 应该被设置成 \\"/bar/\\"。 base 将会作为前缀自动地插...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"配置\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/config.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"配置"}],["meta",{"property":"og:description","content":"配置 站点配置 base 类型： string 默认值： / 详情： 部署站点的基础路径。 如果你想让你的网站部署到一个子路径下，你将需要设置它。它的值应当总是以斜杠开始，并以斜杠结束。举例来说，如果你想将你的网站部署到 https://foo.github.io/bar/，那么 base 应该被设置成 \\"/bar/\\"。 base 将会作为前缀自动地插..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/config.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":6,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":2},{"name":"lebennington","username":"lebennington","email":"100212066+lebennington@users.noreply.github.com","commits":1,"url":"https://github.com/lebennington"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":8.16,"words":2447},"filePathRelative":"zh/reference/config.md","autoDesc":true}');export{f as comp,b as data};
diff --git a/assets/config.html-u1PoDrUn.js b/assets/config.html-u1PoDrUn.js
new file mode 100644
index 00000000..0b5e98f2
--- /dev/null
+++ b/assets/config.html-u1PoDrUn.js
@@ -0,0 +1,15 @@
+import{_ as o}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as p,a,b as e,e as s,w as t,d as i,r,o as d}from"./app-DVsngoLV.js";const u={};function h(k,l){const n=r("RouteLink");return d(),p("div",null,[l[90]||(l[90]=a('
You will need to set this if you plan to deploy your site under a sub path. It should always start and end with a slash. For example, if you plan to deploy your site to GitHub pages at https://foo.github.io/bar/, then you should set base to "/bar/".
The base is automatically prepended to the URLs that start with / in other options, so you only need to specify it once. (Except for attrs of head)
Notice that base should be an absolute URL pathname starting and ending with / .
',3)),e("li",null,[l[2]||(l[2]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/assets.html#base-helper"},{default:t(()=>l[0]||(l[0]=[i("Guide > Assets > Base Helper")])),_:1})]),e("li",null,[s(n,{to:"/guide/deployment.html"},{default:t(()=>l[1]||(l[1]=[i("Guide > Deployment")])),_:1})])])])]),l[91]||(l[91]=e("h3",{id:"lang",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#lang"},[e("span",null,"lang")])],-1)),e("ul",null,[l[7]||(l[7]=a("
Type: string
Default: en-US
Details:
Language for the site.
This will be the lang attribute of the <html> tag in the rendered HTML.
This will be the content attribute of <meta name="description" /> tag in the rendered HTML, which will be overrode by the description field of page frontmatter.
',3)),e("li",null,[l[16]||(l[16]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/i18n.html"},{default:t(()=>l[15]||(l[15]=[i("Guide > I18n")])),_:1})])])])]),l[95]||(l[95]=e("h2",{id:"theme-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme-config"},[e("span",null,"Theme Config")])],-1)),l[96]||(l[96]=e("h3",{id:"theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme"},[e("span",null,"theme")])],-1)),e("ul",null,[l[21]||(l[21]=e("li",null,[e("p",null,[i("Type: "),e("code",null,"Theme")])],-1)),l[22]||(l[22]=e("li",null,[e("p",null,"Details:"),e("p",null,"Set the theme of your site."),e("p",null,"If this option is not set, the default theme will be used.")],-1)),e("li",null,[l[20]||(l[20]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/theme.html"},{default:t(()=>l[18]||(l[18]=[i("Guide > Theme")])),_:1})]),l[19]||(l[19]=e("li",null,[e("a",{href:"https://ecosystem.vuejs.press/themes/default/config.html",target:"_blank",rel:"noopener noreferrer"},"Default Theme > Config")],-1))])])]),l[97]||(l[97]=e("h2",{id:"bundler-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bundler-config"},[e("span",null,"Bundler Config")])],-1)),l[98]||(l[98]=e("h3",{id:"bundler",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bundler"},[e("span",null,"bundler")])],-1)),e("ul",null,[l[27]||(l[27]=a("
Type: Bundler
Details:
Set the bundler of your site.
If this option is not set, the default bundler will be used:
With vuepress or vuepress-vite, the default bundler is vite.
With vuepress-webpack, the default bundler is webpack.
',9)),e("ul",null,[l[30]||(l[30]=e("li",null,[e("p",null,[i("Type: "),e("code",null,"string")])],-1)),l[31]||(l[31]=e("li",null,[e("p",null,[i("Default: "),e("code",null,"`${sourceDir}/.vuepress/public`")])],-1)),l[32]||(l[32]=e("li",null,[e("p",null,"Details:"),e("p",null,"Specify the directory for public files.")],-1)),e("li",null,[l[29]||(l[29]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/assets.html#public-files"},{default:t(()=>l[28]||(l[28]=[i("Guide > Assets > Public Files")])),_:1})])])])]),l[100]||(l[100]=a('
This would be helpful for developers. Also, we are using debug package for debug logging, which can be enabled via DEBUG=vuepress* environment variable.
A function to control what files should have <link rel="prefetch"> resource hints generated. Set to true or false to enable or disable for all files.
If you set it to true, all files that required by other pages will be prefetched. This is good for small sites, which will speed up the navigation, but it might not be a good idea if you have lots of pages in your site.
`,3)),e("ul",null,[l[42]||(l[42]=e("li",null,[e("p",null,"Details:"),e("p",null,[i("Options for "),e("a",{href:"https://github.com/valeriangalliat/markdown-it-anchor",target:"_blank",rel:"noopener noreferrer"},"markdown-it-anchor"),i(".")]),e("p",null,[i("Set to "),e("code",null,"false"),i(" to disable this plugin.")])],-1)),e("li",null,[l[41]||(l[41]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/markdown.html#header-anchors"},{default:t(()=>l[40]||(l[40]=[i("Guide > Markdown > Syntax Extensions > Header Anchors")])),_:1})])])])]),l[103]||(l[103]=a('
',7)),e("ul",null,[l[45]||(l[45]=e("li",null,[e("p",null,[i("Type: "),e("code",null,"EmojiPluginOptions | false")])],-1)),l[46]||(l[46]=e("li",null,[e("p",null,"Details:"),e("p",null,[i("Options for "),e("a",{href:"https://github.com/markdown-it/markdown-it-emoji",target:"_blank",rel:"noopener noreferrer"},"markdown-it-emoji"),i(".")]),e("p",null,[i("Set to "),e("code",null,"false"),i(" to disable this plugin.")])],-1)),e("li",null,[l[44]||(l[44]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/markdown.html#emoji"},{default:t(()=>l[43]||(l[43]=[i("Guide > Markdown > Syntax Extensions > Emoji")])),_:1})])])])]),l[104]||(l[104]=e("h3",{id:"markdown-frontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-frontmatter"},[e("span",null,"markdown.frontmatter")])],-1)),e("ul",null,[l[50]||(l[50]=e("li",null,[e("p",null,[i("Type: "),e("code",null,"FrontmatterPluginOptions | false")])],-1)),l[51]||(l[51]=e("li",null,[e("p",null,"Details:"),e("p",null,[i("Options for "),e("a",{href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-frontmatter",target:"_blank",rel:"noopener noreferrer"},"@mdit-vue/plugin-frontmatter"),i(".")]),e("p",null,[i("Set to "),e("code",null,"false"),i(" to disable this plugin.")])],-1)),e("li",null,[l[49]||(l[49]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/page.html#frontmatter"},{default:t(()=>l[47]||(l[47]=[i("Guide > Page > Frontmatter")])),_:1})]),e("li",null,[s(n,{to:"/reference/node-api.html#frontmatter"},{default:t(()=>l[48]||(l[48]=[i("Node API > Page Properties > frontmatter")])),_:1})])])])]),l[105]||(l[105]=a(`
Caution
You should not configure it unless you understand what it is for.
`,4)),e("ul",null,[l[54]||(l[54]=e("li",null,[e("p",null,"Details:"),e("p",null,[i("Options for "),e("a",{href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-headers",target:"_blank",rel:"noopener noreferrer"},"@mdit-vue/plugin-headers"),i(".")]),e("p",null,[i("Set to "),e("code",null,"false"),i(" to disable this plugin.")])],-1)),e("li",null,[l[53]||(l[53]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/reference/node-api.html#headers"},{default:t(()=>l[52]||(l[52]=[i("Node API > Page Properties > headers")])),_:1})])])])]),l[106]||(l[106]=e("h3",{id:"markdown-importcode",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-importcode"},[e("span",null,"markdown.importCode")])],-1)),e("ul",null,[l[57]||(l[57]=e("li",null,[e("p",null,[i("Type: "),e("code",null,"ImportCodePluginOptions | false")])],-1)),l[58]||(l[58]=e("li",null,[e("p",null,"Details:"),e("p",null,"Options for VuePress built-in markdown-it import-code plugin."),e("p",null,[i("Set to "),e("code",null,"false"),i(" to disable this plugin.")])],-1)),e("li",null,[l[56]||(l[56]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/markdown.html#import-code-blocks"},{default:t(()=>l[55]||(l[55]=[i("Guide > Markdown > Syntax Extensions > Import Code Blocks")])),_:1})])])])]),l[107]||(l[107]=a('
',3)),e("ul",null,[l[72]||(l[72]=e("li",null,[e("p",null,[i("Type: "),e("code",null,"SfcPluginOptions | false")])],-1)),l[73]||(l[73]=e("li",null,[e("p",null,"Details:"),e("p",null,[i("Options for "),e("a",{href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-sfc",target:"_blank",rel:"noopener noreferrer"},"@mdit-vue/plugin-sfc"),i(".")]),e("p",null,[i("Set to "),e("code",null,"false"),i(" to disable this plugin.")])],-1)),e("li",null,[l[71]||(l[71]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/advanced/cookbook/markdown-and-vue-sfc.html"},{default:t(()=>l[69]||(l[69]=[i("Cookbook > Markdown and Vue SFC")])),_:1})]),e("li",null,[s(n,{to:"/reference/node-api.html#sfcblocks"},{default:t(()=>l[70]||(l[70]=[i("Node API > Page Properties > sfcBlocks")])),_:1})])])])]),l[110]||(l[110]=a(`
Caution
You should not configure it unless you understand what it is for.
`,9)),e("ul",null,[l[76]||(l[76]=e("li",null,[e("p",null,"Details:"),e("p",null,[i("Options for "),e("a",{href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc",target:"_blank",rel:"noopener noreferrer"},"@mdit-vue/plugin-toc"),i(".")]),e("p",null,[i("Set to "),e("code",null,"false"),i(" to disable this plugin.")])],-1)),e("li",null,[l[75]||(l[75]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/markdown.html#table-of-contents"},{default:t(()=>l[74]||(l[74]=[i("Guide > Markdown > Syntax Extensions > Table of Contents")])),_:1})])])])]),l[111]||(l[111]=e("h4",{id:"markdown-vpre-block",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-vpre-block"},[e("span",null,"markdown.vPre.block")])],-1)),e("ul",null,[l[79]||(l[79]=a("
Type: boolean
Default: true
Details:
Add v-pre directive to <pre> tag of code block or not.
Add v-pre directive to <code> tag of inline code or not.
",3)),e("li",null,[l[81]||(l[81]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/markdown.html#wrap-with-v-pre"},{default:t(()=>l[80]||(l[80]=[i("Guide > Markdown > Syntax Extensions > Code Blocks > Wrap with v-pre")])),_:1})])])])]),l[113]||(l[113]=e("h2",{id:"plugin-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugin-config"},[e("span",null,"Plugin Config")])],-1)),l[114]||(l[114]=e("h3",{id:"plugins",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugins"},[e("span",null,"plugins")])],-1)),e("ul",null,[l[85]||(l[85]=e("li",null,[e("p",null,[i("Type: "),e("code",null,"(Plugin | Plugin[])[]")])],-1)),l[86]||(l[86]=e("li",null,[e("p",null,"Details:"),e("p",null,"Plugins to use."),e("p",null,"This option accepts an array, each item of which could be a plugin or an array of plugins.")],-1)),e("li",null,[l[84]||(l[84]=e("p",null,"Also see:",-1)),e("ul",null,[e("li",null,[s(n,{to:"/guide/plugin.html"},{default:t(()=>l[83]||(l[83]=[i("Guide > Plugin")])),_:1})])])])]),l[115]||(l[115]=e("h2",{id:"plugin-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugin-api"},[e("span",null,"Plugin API")])],-1)),l[116]||(l[116]=e("p",null,[i("User config file also works as a VuePress plugin, so all of the Plugin APIs are available except the "),e("code",null,"name"),i(" and "),e("code",null,"multiple"),i(" options.")],-1)),e("p",null,[l[88]||(l[88]=i("Please check out ")),s(n,{to:"/reference/plugin-api.html"},{default:t(()=>l[87]||(l[87]=[i("Plugin API Reference")])),_:1}),l[89]||(l[89]=i(" for a full list of Plugin APIs."))])])}const m=o(u,[["render",h]]),b=JSON.parse('{"path":"/reference/config.html","title":"Config","lang":"en-US","frontmatter":{"icon":"fa6-solid:gear","description":"Config Site Config base Type: string Default: / Details: The base URL the site will be deployed at. You will need to set this if you plan to deploy your site under a sub path. I...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Config\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/reference/config.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Config"}],["meta",{"property":"og:description","content":"Config Site Config base Type: string Default: / Details: The base URL the site will be deployed at. You will need to set this if you plan to deploy your site under a sub path. I..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/config.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":6,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":2},{"name":"lebennington","username":"lebennington","email":"100212066+lebennington@users.noreply.github.com","commits":1,"url":"https://github.com/lebennington"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":5.45,"words":1635},"filePathRelative":"reference/config.md","autoDesc":true}');export{m as comp,b as data};
diff --git a/assets/configuration.html-B_xUzcn7.js b/assets/configuration.html-B_xUzcn7.js
new file mode 100644
index 00000000..f20df334
--- /dev/null
+++ b/assets/configuration.html-B_xUzcn7.js
@@ -0,0 +1,24 @@
+import{_ as r}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as p,a,b as s,d as e,e as l,w as t,r as o,o as h}from"./app-DVsngoLV.js";const d={},k={class:"hint-container tip"},c={class:"hint-container tip"};function g(u,i){const n=o("RouteLink");return h(),p("div",null,[i[13]||(i[13]=a('
The essential file for configuring a VuePress site is .vuepress/config.js, while TypeScript config file is also supported. You can use .vuepress/config.ts instead to get better types hint for VuePress config.
To be more specific, we have a convention for config file paths (in order of precedence):
In current working directory cwd:
vuepress.config.ts
vuepress.config.js
vuepress.config.mjs
In source directory sourceDir:
.vuepress/config.ts
.vuepress/config.js
.vuepress/config.mjs
',5)),s("p",null,[i[1]||(i[1]=e("You can also specify the config file via ")),i[2]||(i[2]=s("code",null,"--config",-1)),i[3]||(i[3]=e(" option of ")),l(n,{to:"/reference/cli.html"},{default:t(()=>i[0]||(i[0]=[e("CLI")])),_:1}),i[4]||(i[4]=e(":"))]),i[14]||(i[14]=a(`
`,3)),s("div",k,[i[8]||(i[8]=s("p",{class:"hint-container-title"},"Tips",-1)),s("p",null,[i[6]||(i[6]=e("Check out the ")),l(n,{to:"/reference/config.html"},{default:t(()=>i[5]||(i[5]=[e("Config Reference")])),_:1}),i[7]||(i[7]=e(" for a full list of VuePress config."))])]),i[15]||(i[15]=a(`
In most cases, the config file is sufficient to configure your VuePress site. However, sometimes users may want to add some client-side code directly. To help with this, VuePress also supports a client config file:
`,7)),s("div",c,[i[11]||(i[11]=s("p",{class:"hint-container-title"},"Tips",-1)),i[12]||(i[12]=s("p",null,"Unlike config file, client config file could not be specified via CLI options.",-1)),s("p",null,[i[10]||(i[10]=e("To learn more about client config file, see ")),l(n,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:t(()=>i[9]||(i[9]=[e("Advanced > Cookbook > Usage of Client Config")])),_:1})])])])}const v=r(d,[["render",g]]),y=JSON.parse('{"path":"/guide/configuration.html","title":"Configuration","lang":"en-US","frontmatter":{"icon":"fa6-solid:gear","description":"Configuration Config File The essential file for configuring a VuePress site is .vuepress/config.js, while TypeScript config file is also supported. You can use .vuepress/config...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Configuration\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/configuration.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Configuration"}],["meta",{"property":"og:description","content":"Configuration Config File The essential file for configuring a VuePress site is .vuepress/config.js, while TypeScript config file is also supported. You can use .vuepress/config..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/configuration.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":4,"url":"https://github.com/meteorlxy"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":0.92,"words":276},"filePathRelative":"guide/configuration.md","autoDesc":true}');export{v as comp,y as data};
diff --git a/assets/configuration.html-C67FYR2G.js b/assets/configuration.html-C67FYR2G.js
new file mode 100644
index 00000000..6bda7fce
--- /dev/null
+++ b/assets/configuration.html-C67FYR2G.js
@@ -0,0 +1,24 @@
+import{_ as p}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as r,a,b as e,d as i,e as l,w as t,r as h,o as d}from"./app-DVsngoLV.js";const k={},o={class:"hint-container tip"},c={class:"hint-container tip"};function g(u,s){const n=h("RouteLink");return d(),r("div",null,[s[14]||(s[14]=a('
`,5)),i("ol",null,[i("li",null,[i("p",null,[s[1]||(s[1]=e("Set the correct ")),l(n,{to:"/reference/config.html#base"},{default:t(()=>s[0]||(s[0]=[e("base")])),_:1}),s[2]||(s[2]=e(" config."))]),s[3]||(s[3]=a("
If you are deploying to https://<USERNAME>.github.io/, you can omit this step as base defaults to "/".
If you are deploying to https://<USERNAME>.github.io/<REPO>/, for example your repository is at https://github.com/<USERNAME>/<REPO>, then set base to "/<REPO>/".
",2))]),s[4]||(s[4]=i("li",null,[i("p",null,[e("Choose your preferred CI tools. Here we take "),i("a",{href:"https://github.com/features/actions",target:"_blank",rel:"noopener noreferrer"},"GitHub Actions"),e(" as an example.")]),i("p",null,[e("Create "),i("code",null,".github/workflows/docs.yml"),e(" to set up the workflow.")])],-1))]),s[11]||(s[11]=a(`Click to expand sample config
name: docs
+
+on:
+ # trigger deployment on every push to main branch
+ push:
+ branches: [main]
+ # trigger deployment manually
+ workflow_dispatch:
+
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ # fetch all commits to get last updated time or other git log info
+ fetch-depth: 0
+
+ - name: Setup pnpm
+ uses: pnpm/action-setup@v4
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v4
+ with:
+ # choose node.js version to use
+ node-version: 22
+ # cache deps for pnpm
+ cache: pnpm
+
+ - name: Install deps
+ run: pnpm install --frozen-lockfile
+
+ # run build script
+ - name: Build VuePress site
+ run: pnpm docs:build
+
+ # please check out the docs of the workflow for more details
+ # @see https://github.com/crazy-max/ghaction-github-pages
+ - name: Deploy to GitHub Pages
+ uses: crazy-max/ghaction-github-pages@v4
+ with:
+ # deploy to gh-pages branch
+ target_branch: gh-pages
+ # deploy the default output dir of VuePress
+ build_dir: docs/.vuepress/dist
+ env:
+ # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
+ GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
`,3)),i("ol",null,[i("li",null,[i("p",null,[s[6]||(s[6]=e("Set the correct ")),l(n,{to:"/reference/config.html#base"},{default:t(()=>s[5]||(s[5]=[e("base")])),_:1}),s[7]||(s[7]=e(" config."))]),s[8]||(s[8]=a("
If you are deploying to https://<USERNAME>.gitlab.io/, you can omit base as it defaults to "/".
If you are deploying to https://<USERNAME>.gitlab.io/<REPO>/, for example your repository is at https://gitlab.com/<USERNAME>/<REPO>, then set base to "/<REPO>/".
",2))]),s[9]||(s[9]=i("li",null,[i("p",null,[e("Create "),i("code",null,".gitlab-ci.yml"),e(" to set up "),i("a",{href:"https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/",target:"_blank",rel:"noopener noreferrer"},"GitLab CI"),e(" workflow.")])],-1))]),s[12]||(s[12]=a(`Click to expand sample config
# choose a docker image to use
+image: node:18-buster
+
+pages:
+ # trigger deployment on every push to main branch
+ only:
+ - main
+
+ # cache node_modules
+ cache:
+ key:
+ files:
+ - pnpm-lock.yaml
+ paths:
+ - .pnpm-store
+
+ # Install pnpm
+ before_script:
+ - curl -fsSL https://get.pnpm.io/install.sh | sh -
+ - pnpm config set store-dir .pnpm-store
+
+ # install dependencies and run build script
+ script:
+ - pnpm i --frozen-lockfile
+ - pnpm docs:build --dest public
+
+ artifacts:
+ paths:
+ - public
Go to Vercel, set up a new project from GitHub with the following settings:
FRAMEWORK PRESET:Other
BUILD COMMAND:pnpm docs:build
OUTPUT DIRECTORY:docs/.vuepress/dist
Hit the deploy button.
`,26))])}const y=p(o,[["render",k]]),m=JSON.parse('{"path":"/guide/deployment.html","title":"Deployment","lang":"en-US","frontmatter":{"icon":"fa6-solid:rocket","description":"Deployment The following guides are based on some shared assumptions: You are placing your Markdown source files inside the docs directory of your project; You are using the def...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Deployment\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/deployment.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Deployment"}],["meta",{"property":"og:description","content":"Deployment The following guides are based on some shared assumptions: You are placing your Markdown source files inside the docs directory of your project; You are using the def..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/deployment.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":3},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":3,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":2.47,"words":741},"filePathRelative":"guide/deployment.md","autoDesc":true}');export{y as comp,m as data};
diff --git a/assets/frontmatter.html-BvpLSt9a.js b/assets/frontmatter.html-BvpLSt9a.js
new file mode 100644
index 00000000..22976022
--- /dev/null
+++ b/assets/frontmatter.html-BvpLSt9a.js
@@ -0,0 +1,24 @@
+import{_ as r}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as d,b as i,a as t,d as l,e as n,w as a,r as p,o as h}from"./app-DVsngoLV.js";const o={};function k(u,s){const e=p("RouteLink");return h(),d("div",null,[s[34]||(s[34]=i("h1",{id:"frontmatter",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#frontmatter"},[i("span",null,"Frontmatter")])],-1)),s[35]||(s[35]=i("h2",{id:"date",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#date"},[i("span",null,"date")])],-1)),i("ul",null,[s[2]||(s[2]=i("li",null,[i("p",null,[l("类型： "),i("code",null,"string")])],-1)),s[3]||(s[3]=i("li",null,[i("p",null,"详情："),i("p",null,"页面的创建日期。"),i("p",null,[l("应按照 "),i("code",null,"yyyy-MM-dd"),l(" 的格式来指定日期，或者遵循 "),i("a",{href:"https://yaml.org/type/timestamp.html",target:"_blank",rel:"noopener noreferrer"},"YAML Timestamp Type"),l(" 。")])],-1)),i("li",null,[s[1]||(s[1]=i("p",null,"参考：",-1)),i("ul",null,[i("li",null,[n(e,{to:"/zh/reference/node-api.html#date"},{default:a(()=>s[0]||(s[0]=[l("Node API > Page 属性 > date")])),_:1})])])])]),s[36]||(s[36]=i("h2",{id:"description",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#description"},[i("span",null,"description")])],-1)),i("ul",null,[s[6]||(s[6]=i("li",null,[i("p",null,[l("类型： "),i("code",null,"string")])],-1)),s[7]||(s[7]=i("li",null,[i("p",null,"详情："),i("p",null,"页面的描述。"),i("p",null,[l("它将会覆盖站点配置中的 "),i("code",null,"description"),l(" 配置项。")])],-1)),i("li",null,[s[5]||(s[5]=i("p",null,"参考：",-1)),i("ul",null,[i("li",null,[n(e,{to:"/zh/reference/config.html#description"},{default:a(()=>s[4]||(s[4]=[l("配置 > description")])),_:1})])])])]),s[37]||(s[37]=t(`
`,7)),i("ul",null,[i("li",null,[s[25]||(s[25]=l("参考： ")),i("ul",null,[i("li",null,[n(e,{to:"/zh/reference/config.html#permalinkpattern"},{default:a(()=>s[21]||(s[21]=[l("配置 > permalinkPattern")])),_:1})]),s[23]||(s[23]=i("li",null,[i("a",{href:"#date"},"Frontmatter > date")],-1)),s[24]||(s[24]=i("li",null,[i("a",{href:"#permalink"},"Frontmatter > permalink")],-1)),i("li",null,[n(e,{to:"/zh/reference/node-api.html#permalink"},{default:a(()=>s[22]||(s[22]=[l("Node API > Page 属性 > permalink")])),_:1})])])])]),s[41]||(s[41]=i("h2",{id:"routemeta",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#routemeta"},[i("span",null,"routeMeta")])],-1)),i("ul",null,[s[28]||(s[28]=i("li",null,[i("p",null,[l("类型： "),i("code",null,"Record")])],-1)),s[29]||(s[29]=i("li",null,[i("p",null,"详情："),i("p",null,"附加到页面路由的自定义数据。")],-1)),i("li",null,[s[27]||(s[27]=i("p",null,"参考：",-1)),i("ul",null,[i("li",null,[n(e,{to:"/zh/reference/node-api.html#routeMeta"},{default:a(()=>s[26]||(s[26]=[l("Node API > Page 属性 > routeMeta")])),_:1})])])])]),s[42]||(s[42]=i("h2",{id:"title",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#title"},[i("span",null,"title")])],-1)),i("ul",null,[s[32]||(s[32]=i("li",null,[i("p",null,[l("类型： "),i("code",null,"string")])],-1)),s[33]||(s[33]=i("li",null,[i("p",null,"详情："),i("p",null,"页面的标题。"),i("p",null,[l("如果你不在 Frontmatter 中设置 "),i("code",null,"title"),l(" ，那么页面中第一个一级标题（即 "),i("code",null,"# title"),l("）的内容会被当作标题使用。")])],-1)),i("li",null,[s[31]||(s[31]=i("p",null,"参考：",-1)),i("ul",null,[i("li",null,[n(e,{to:"/zh/reference/node-api.html#title"},{default:a(()=>s[30]||(s[30]=[l("Node API > Page 属性 > title")])),_:1})])])])])])}const y=r(o,[["render",k]]),A=JSON.parse('{"path":"/zh/reference/frontmatter.html","title":"Frontmatter","lang":"zh-CN","frontmatter":{"icon":"fa-solid:bars","description":"Frontmatter date 类型： string 详情： 页面的创建日期。 应按照 yyyy-MM-dd 的格式来指定日期，或者遵循 YAML Timestamp Type 。 参考： description 类型： string 详情： 页面的描述。 它将会覆盖站点配置中的 description 配置项。 参考： head 类型： HeadC...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Frontmatter\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/frontmatter.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Frontmatter"}],["meta",{"property":"og:description","content":"Frontmatter date 类型： string 详情： 页面的创建日期。 应按照 yyyy-MM-dd 的格式来指定日期，或者遵循 YAML Timestamp Type 。 参考： description 类型： string 详情： 页面的描述。 它将会覆盖站点配置中的 description 配置项。 参考： head 类型： HeadC..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/frontmatter.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":5,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"张怀文","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":2.5,"words":750},"filePathRelative":"zh/reference/frontmatter.md","autoDesc":true}');export{y as comp,A as data};
diff --git a/assets/frontmatter.html-CA6RnZ0l.js b/assets/frontmatter.html-CA6RnZ0l.js
new file mode 100644
index 00000000..4c67281f
--- /dev/null
+++ b/assets/frontmatter.html-CA6RnZ0l.js
@@ -0,0 +1,24 @@
+import{_ as r}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as p,b as i,a as n,d as s,e as t,w as a,r as d,o}from"./app-DVsngoLV.js";const h={};function k(u,e){const l=d("RouteLink");return o(),p("div",null,[e[34]||(e[34]=i("h1",{id:"frontmatter",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#frontmatter"},[i("span",null,"Frontmatter")])],-1)),e[35]||(e[35]=i("h2",{id:"date",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#date"},[i("span",null,"date")])],-1)),i("ul",null,[e[2]||(e[2]=i("li",null,[i("p",null,[s("Type: "),i("code",null,"string")])],-1)),e[3]||(e[3]=i("li",null,[i("p",null,"Details:"),i("p",null,"Created date for the page."),i("p",null,[s("You should specify the date in the form of "),i("code",null,"yyyy-MM-dd"),s(", or follow the "),i("a",{href:"https://yaml.org/type/timestamp.html",target:"_blank",rel:"noopener noreferrer"},"YAML Timestamp Type"),s(".")])],-1)),i("li",null,[e[1]||(e[1]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[t(l,{to:"/reference/node-api.html#date"},{default:a(()=>e[0]||(e[0]=[s("Node API > Page Properties > date")])),_:1})])])])]),e[36]||(e[36]=i("h2",{id:"description",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#description"},[i("span",null,"description")])],-1)),i("ul",null,[e[6]||(e[6]=i("li",null,[i("p",null,[s("Type: "),i("code",null,"string")])],-1)),e[7]||(e[7]=i("li",null,[i("p",null,"Details:"),i("p",null,"Description for the page."),i("p",null,[s("This will override the "),i("code",null,"description"),s(" option in your site config.")])],-1)),i("li",null,[e[5]||(e[5]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[t(l,{to:"/reference/config.html#description"},{default:a(()=>e[4]||(e[4]=[s("Config > description")])),_:1})])])])]),e[37]||(e[37]=n(`
`,5)),i("ul",null,[i("li",null,[e[9]||(e[9]=s("Also see: ")),i("ul",null,[i("li",null,[t(l,{to:"/reference/config.html#head"},{default:a(()=>e[8]||(e[8]=[s("Config > head")])),_:1})])])])]),e[38]||(e[38]=i("h2",{id:"lang",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#lang"},[i("span",null,"lang")])],-1)),i("ul",null,[e[13]||(e[13]=i("li",null,[i("p",null,[s("Type: "),i("code",null,"string")])],-1)),e[14]||(e[14]=i("li",null,[i("p",null,"Details:"),i("p",null,"Language for the page."),i("p",null,[s("This will override the "),i("code",null,"lang"),s(" option in your site config.")])],-1)),i("li",null,[e[12]||(e[12]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[t(l,{to:"/reference/config.html#lang"},{default:a(()=>e[10]||(e[10]=[s("Config > lang")])),_:1})]),i("li",null,[t(l,{to:"/reference/node-api.html#lang"},{default:a(()=>e[11]||(e[11]=[s("Node API > Page Properties > lang")])),_:1})])])])]),e[39]||(e[39]=n(`
Layouts are provided by theme. If you don't specify this frontmatter, the default layout will be used. You should refer to the theme's own documentation to find what layouts it provides.
If the theme layouts cannot meet your needs, you can use a custom layout component.
Example:
Register a layout component in .vuepress/client.ts file:
`,7)),i("ul",null,[e[19]||(e[19]=i("li",null,[i("p",null,[s("Type: "),i("code",null,"string | null")])],-1)),e[20]||(e[20]=i("li",null,[i("p",null,"Details:"),i("p",null,"Permalink for the page."),i("p",null,"This will override the default route path that determined by the file path of the page."),i("p",null,[s("When it is set to "),i("code",null,"null"),s(", the permalink of the page will be disabled.")])],-1)),i("li",null,[e[18]||(e[18]=i("p",null,"Also see:",-1)),i("ul",null,[e[17]||(e[17]=i("li",null,[i("a",{href:"#permalinkpattern"},"Frontmatter > permalinkPattern")],-1)),i("li",null,[t(l,{to:"/guide/page.html#routing"},{default:a(()=>e[15]||(e[15]=[s("Guide > Page > Routing")])),_:1})]),i("li",null,[t(l,{to:"/reference/node-api.html#permalink"},{default:a(()=>e[16]||(e[16]=[s("Node API > Page Properties > permalink")])),_:1})])])])]),e[40]||(e[40]=n(`
Then the permalink of the page would be 2021/01/03/bar-baz.html.
`,7)),i("ul",null,[i("li",null,[e[25]||(e[25]=s("Also see: ")),i("ul",null,[i("li",null,[t(l,{to:"/reference/config.html#permalinkpattern"},{default:a(()=>e[21]||(e[21]=[s("Config > permalinkPattern")])),_:1})]),e[23]||(e[23]=i("li",null,[i("a",{href:"#date"},"Frontmatter > date")],-1)),e[24]||(e[24]=i("li",null,[i("a",{href:"#permalink"},"Frontmatter > permalink")],-1)),i("li",null,[t(l,{to:"/reference/node-api.html#permalink"},{default:a(()=>e[22]||(e[22]=[s("Node API > Page Properties > permalink")])),_:1})])])])]),e[41]||(e[41]=i("h2",{id:"routemeta",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#routemeta"},[i("span",null,"routeMeta")])],-1)),i("ul",null,[e[28]||(e[28]=i("li",null,[i("p",null,[s("Type: "),i("code",null,"Record")])],-1)),e[29]||(e[29]=i("li",null,[i("p",null,"Details:"),i("p",null,"Custom data to be attached to the page route.")],-1)),i("li",null,[e[27]||(e[27]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[t(l,{to:"/reference/node-api.html#routeMeta"},{default:a(()=>e[26]||(e[26]=[s("Node API > Page Properties > routeMeta")])),_:1})])])])]),e[42]||(e[42]=i("h2",{id:"title",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#title"},[i("span",null,"title")])],-1)),i("ul",null,[e[32]||(e[32]=i("li",null,[i("p",null,[s("Type: "),i("code",null,"string")])],-1)),e[33]||(e[33]=i("li",null,[i("p",null,"Details:"),i("p",null,"Title for the page."),i("p",null,[s("If you don't specify "),i("code",null,"title"),s(" in frontmatter, content of the first level-one header (i.e. "),i("code",null,"# title"),s(") will be used as the title.")])],-1)),i("li",null,[e[31]||(e[31]=i("p",null,"Also see:",-1)),i("ul",null,[i("li",null,[t(l,{to:"/reference/node-api.html#title"},{default:a(()=>e[30]||(e[30]=[s("Node API > Page Properties > title")])),_:1})])])])])])}const y=r(h,[["render",k]]),A=JSON.parse('{"path":"/reference/frontmatter.html","title":"Frontmatter","lang":"en-US","frontmatter":{"icon":"fa-solid:bars","description":"Frontmatter date Type: string Details: Created date for the page. You should specify the date in the form of yyyy-MM-dd, or follow the YAML Timestamp Type. Also see: description...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Frontmatter\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/reference/frontmatter.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Frontmatter"}],["meta",{"property":"og:description","content":"Frontmatter date Type: string Details: Created date for the page. You should specify the date in the form of yyyy-MM-dd, or follow the YAML Timestamp Type. Also see: description..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/frontmatter.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":5,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"张怀文","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":1.89,"words":566},"filePathRelative":"reference/frontmatter.md","autoDesc":true}');export{y as comp,A as data};
diff --git a/assets/getting-started.html-B-E2ElMp.js b/assets/getting-started.html-B-E2ElMp.js
new file mode 100644
index 00000000..73406ef5
--- /dev/null
+++ b/assets/getting-started.html-B-E2ElMp.js
@@ -0,0 +1,35 @@
+import{_ as k}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as o,a as r,e as t,b as s,w as a,d as e,r as p,o as g}from"./app-DVsngoLV.js";const c={};function u(b,i){const h=p("CodeTabs"),d=p("RouteLink");return g(),o("div",null,[i[18]||(i[18]=r('
VuePress v2 is currently in RC (Release Candidate) stage. It's ready to be used for building your site, but the config and API are not stable enough, which is possibly to have minor breaking changes. So make sure to read the changelog carefully each time you upgrade a RC version.
The docs directory is where you put your markdown files, and it will be used as the source directory of VuePress.
The docs/.vuepress directory, i.e. the .vuepress directory in the source directory, is where all VuePress-specific files will be placed. Currently there is only one config file in it. By default, the temp, cache and output directory will also be generated inside this directory. It is suggested to add them to your .gitignore file.
Then, run docs:dev script to start the dev server:
`,17)),l(r,{id:"169",data:[{id:"pnpm"},{id:"yarn"},{id:"npm"}],"tab-id":"shell"},{title0:a(({value:t,isActive:n})=>s[18]||(s[18]=[e("pnpm")])),title1:a(({value:t,isActive:n})=>s[19]||(s[19]=[e("yarn")])),title2:a(({value:t,isActive:n})=>s[20]||(s[20]=[e("npm")])),tab0:a(({value:t,isActive:n})=>s[21]||(s[21]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"pnpm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," docs:dev")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"})])],-1)])),tab1:a(({value:t,isActive:n})=>s[22]||(s[22]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"yarn"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," docs:dev")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"})])],-1)])),tab2:a(({value:t,isActive:n})=>s[23]||(s[23]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"npm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," run"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," docs:dev")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"})])],-1)])),_:1}),s[42]||(s[42]=i("p",null,[e("VuePress will start a hot-reloading development server at "),i("a",{href:"http://localhost:8080",target:"_blank",rel:"noopener noreferrer"},"http://localhost:8080"),e(". When you modify your markdown files, the content in the browser will be auto updated.")],-1)),s[43]||(s[43]=i("h3",{id:"build-your-site",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#build-your-site"},[i("span",null,"Build Your Site")])],-1)),s[44]||(s[44]=i("p",null,[e("To build your site, run "),i("code",null,"docs:build"),e(" script:")],-1)),l(r,{id:"189",data:[{id:"pnpm"},{id:"yarn"},{id:"npm"}],"tab-id":"shell"},{title0:a(({value:t,isActive:n})=>s[24]||(s[24]=[e("pnpm")])),title1:a(({value:t,isActive:n})=>s[25]||(s[25]=[e("yarn")])),title2:a(({value:t,isActive:n})=>s[26]||(s[26]=[e("npm")])),tab0:a(({value:t,isActive:n})=>s[27]||(s[27]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"pnpm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," docs:build")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"})])],-1)])),tab1:a(({value:t,isActive:n})=>s[28]||(s[28]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"yarn"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," docs:build")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"})])],-1)])),tab2:a(({value:t,isActive:n})=>s[29]||(s[29]=[i("div",{class:"language-bash line-numbers-mode","data-highlighter":"shiki","data-ext":"bash",style:{"--shiki-light":"#383A42","--shiki-dark":"#abb2bf","--shiki-light-bg":"#FAFAFA","--shiki-dark-bg":"#282c34"}},[i("pre",{class:"shiki shiki-themes one-light one-dark-pro vp-code"},[i("code",null,[i("span",{class:"line"},[i("span",{style:{"--shiki-light":"#4078F2","--shiki-dark":"#61AFEF"}},"npm"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," run"),i("span",{style:{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"}}," docs:build")])])]),i("div",{class:"line-numbers","aria-hidden":"true",style:{"counter-reset":"line-number 0"}},[i("div",{class:"line-number"})])],-1)])),_:1}),i("p",null,[s[31]||(s[31]=e("You will see the generated static files in the ")),s[32]||(s[32]=i("code",null,"docs/.vuepress/dist",-1)),s[33]||(s[33]=e(" directory. You can check out ")),l(d,{to:"/guide/deployment.html"},{default:a(()=>s[30]||(s[30]=[e("deployment")])),_:1}),s[34]||(s[34]=e(" for how to deploy them."))]),s[45]||(s[45]=i("h2",{id:"learn-more-about-vuepress",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#learn-more-about-vuepress"},[i("span",null,"Learn More about VuePress")])],-1)),s[46]||(s[46]=i("p",null,"By now, you should have a basic but functional VuePress site. But you may still need to read the subsequent guide to learn more about VuePress.",-1)),i("p",null,[s[36]||(s[36]=e("Next step, learn more about the ")),l(d,{to:"/guide/configuration.html"},{default:a(()=>s[35]||(s[35]=[e("configuration")])),_:1}),s[37]||(s[37]=e("."))])])}const y=p(g,[["render",c]]),A=JSON.parse(`{"path":"/guide/getting-started.html","title":"Getting Started","lang":"en-US","frontmatter":{"icon":"fa6-solid:lightbulb","description":"Getting Started Warning VuePress v2 is currently in RC (Release Candidate) stage. It's ready to be used for building your site, but the config and API are not stable enough, whi...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Getting Started\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-29T18:12:59.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/getting-started.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Getting Started"}],["meta",{"property":"og:description","content":"Getting Started Warning VuePress v2 is currently in RC (Release Candidate) stage. It's ready to be used for building your site, but the config and API are not stable enough, whi..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-29T18:12:59.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-29T18:12:59.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/getting-started.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1745950379000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":5,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":3,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":2.16,"words":649},"filePathRelative":"guide/getting-started.md","autoDesc":true}`);export{y as comp,A as data};
diff --git a/assets/hero-BNkrhNQ6.js b/assets/hero-BNkrhNQ6.js
new file mode 100644
index 00000000..d90d6d57
--- /dev/null
+++ b/assets/hero-BNkrhNQ6.js
@@ -0,0 +1 @@
+const o="/images/hero.png";export{o as _};
diff --git a/assets/i18n.html-CIS7iyFP.js b/assets/i18n.html-CIS7iyFP.js
new file mode 100644
index 00000000..a27399f4
--- /dev/null
+++ b/assets/i18n.html-CIS7iyFP.js
@@ -0,0 +1,39 @@
+import{_ as p}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as h,a,b as e,d as i,e as l,w as t,r,o as d}from"./app-DVsngoLV.js";const k={},o={class:"hint-container tip"};function c(g,s){const n=r("RouteLink");return d(),h("div",null,[s[8]||(s[8]=a(`
`,4)),e("p",null,[s[1]||(s[1]=i("Then, specify the ")),s[2]||(s[2]=e("code",null,"locales",-1)),s[3]||(s[3]=i(" option in your ")),l(n,{to:"/guide/configuration.html#config-file"},{default:t(()=>s[0]||(s[0]=[i("config file")])),_:1}),s[4]||(s[4]=i(":"))]),s[9]||(s[9]=a(`
export default {
+ locales: {
+ // The key is the path for the locale to be nested under.
+ // As a special case, the default locale can use '/' as its path.
+ '/': {
+ lang: 'en-US',
+ title: 'VuePress',
+ description: 'Vue-powered Static Site Generator',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ title: 'VuePress',
+ description: 'Vue 驱动的静态网站生成器',
+ },
+ },
+}
If a locale does not have a lang, title, description or head, VuePress will fallback to the root-level values. You can omit the root level config as long as they are provided in each locale.
VuePress does not restrict how themes provide multi-language support, so each theme may have different way to handle i18n, and some themes may not provide multi-language support at all. You'd better refer to the theme documentation for detailed guide.
If you are using default theme, the multi-language support is the same as above:
`,5))])}const B=p(k,[["render",c]]),y=JSON.parse('{"path":"/guide/i18n.html","title":"I18n","lang":"en-US","frontmatter":{"icon":"fa6-solid:language","description":"I18n Site I18n Config To take advantage of multi-language support in VuePress, you first need to use the following file and directory structure: Then, specify the locales option...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"I18n\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/i18n.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"I18n"}],["meta",{"property":"og:description","content":"I18n Site I18n Config To take advantage of multi-language support in VuePress, you first need to use the following file and directory structure: Then, specify the locales option..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/i18n.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":2,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":2},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":0.84,"words":252},"filePathRelative":"guide/i18n.md","autoDesc":true}');export{B as comp,y as data};
diff --git a/assets/i18n.html-Cz1yWZyl.js b/assets/i18n.html-Cz1yWZyl.js
new file mode 100644
index 00000000..63a1fbc3
--- /dev/null
+++ b/assets/i18n.html-Cz1yWZyl.js
@@ -0,0 +1,39 @@
+import{_ as p}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as h,a as n,b as a,d as i,e as l,w as t,r,o as d}from"./app-DVsngoLV.js";const k={},o={class:"hint-container tip"};function c(B,s){const e=r("RouteLink");return d(),h("div",null,[s[8]||(s[8]=n(`
We are introducing essential concepts in the Guide, but you may not know how to dig deeper.
We are listing APIs in the Reference, but you may not know how to take full advantage of them.
So here comes the Cookbook.
Each recipe will focus on one specific aspect, providing more detailed examples to show you the usages and possibilities of VuePress.
',5)]))}const d=t(a,[["render",i]]),l=JSON.parse(`{"path":"/advanced/cookbook/","title":"Introduction","lang":"en-US","frontmatter":{"icon":"fa6-solid:circle-info","description":"Introduction What's the Cookbook for? We are introducing essential concepts in the Guide, but you may not know how to dig deeper. We are listing APIs in the Reference, but you m...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Introduction\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/cookbook/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Introduction"}],["meta",{"property":"og:description","content":"Introduction What's the Cookbook for? We are introducing essential concepts in the Guide, but you may not know how to dig deeper. We are listing APIs in the Reference, but you m..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1,"url":"https://github.com/meteorlxy"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":0.24,"words":73},"filePathRelative":"advanced/cookbook/README.md","autoDesc":true}`);export{d as comp,l as data};
diff --git a/assets/index.html-Dcah2Vrx.js b/assets/index.html-Dcah2Vrx.js
new file mode 100644
index 00000000..58ecd49a
--- /dev/null
+++ b/assets/index.html-Dcah2Vrx.js
@@ -0,0 +1 @@
+import{_ as t}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as a,e as n,r as o,o as r}from"./app-DVsngoLV.js";const c={};function s(p,l){const e=o("Catalog");return r(),a("div",null,[n(e)])}const m=t(c,[["render",s]]),_=JSON.parse('{"path":"/zh/advanced/","title":"Advanced","lang":"en-US","frontmatter":{"title":"Advanced","article":false,"feed":false,"sitemap":false,"head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Advanced\\"}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/advanced/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Advanced"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}]]},"git":{},"readingTime":{"minutes":0,"words":1},"filePathRelative":null}');export{m as comp,_ as data};
diff --git a/assets/index.html-Dhfuxt_n.js b/assets/index.html-Dhfuxt_n.js
new file mode 100644
index 00000000..1b83e94f
--- /dev/null
+++ b/assets/index.html-Dhfuxt_n.js
@@ -0,0 +1 @@
+import{_ as t}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as r,e as n,r as o,o as a}from"./app-DVsngoLV.js";const l={};function s(c,p){const e=o("Catalog");return a(),r("div",null,[n(e)])}const d=t(l,[["render",s]]),f=JSON.parse('{"path":"/reference/bundler/","title":"Bundler","lang":"en-US","frontmatter":{"title":"Bundler","article":false,"feed":false,"sitemap":false,"head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Bundler\\"}"],["meta",{"property":"og:url","content":"https://vuejs.press/reference/bundler/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Bundler"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/bundler/"}]]},"git":{},"readingTime":{"minutes":0,"words":1},"filePathRelative":null}');export{d as comp,f as data};
diff --git a/assets/index.html-Do19UIZ3.js b/assets/index.html-Do19UIZ3.js
new file mode 100644
index 00000000..5270f828
--- /dev/null
+++ b/assets/index.html-Do19UIZ3.js
@@ -0,0 +1 @@
+import{_ as t}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as a,e as n,r as o,o as r}from"./app-DVsngoLV.js";const c={};function s(p,l){const e=o("Catalog");return r(),a("div",null,[n(e)])}const m=t(c,[["render",s]]),f=JSON.parse('{"path":"/advanced/","title":"Advanced","lang":"en-US","frontmatter":{"title":"Advanced","article":false,"feed":false,"sitemap":false,"head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Advanced\\"}"],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Advanced"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/"}]]},"git":{},"readingTime":{"minutes":0,"words":1},"filePathRelative":null}');export{m as comp,f as data};
diff --git a/assets/index.html-DxEsXlbe.js b/assets/index.html-DxEsXlbe.js
new file mode 100644
index 00000000..07354910
--- /dev/null
+++ b/assets/index.html-DxEsXlbe.js
@@ -0,0 +1 @@
+import{_ as e}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as t,o}from"./app-DVsngoLV.js";const i={};function a(r,n){return o(),t("div")}const m=e(i,[["render",a]]),c=JSON.parse('{"path":"/zh/","title":"首页","lang":"zh-CN","frontmatter":{"home":true,"icon":"fa6-solid:house","title":"首页","heroImage":"/images/hero.png","actions":[{"text":"快速上手","icon":"fa6-solid:lightbulb","link":"/zh/guide/getting-started.html","type":"primary"},{"text":"项目简介","icon":"fa6-solid:circle-info","link":"/zh/guide/introduction.html","type":"secondary"},{"text":"市场","icon":"fa6-solid:cart-shopping","link":"https://marketplace.vuejs.press/zh/","type":"secondary"}],"features":[{"title":"简洁至上","icon":"fa6-solid:star","details":"以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。"},{"title":"Vue 驱动","icon":"fa6-brands:vuejs","details":"享受 Vue 的开发体验，可以在 Markdown 中使用 Vue 组件，又可以使用 Vue 来开发自定义主题。"},{"title":"高性能","icon":"fa6-solid:bolt","details":"VuePress 会为每个页面预渲染生成静态的 HTML，同时，每个页面被加载的时候，将作为 SPA 运行。"},{"title":"主题","icon":"fa6-solid:palette","details":"提供了一个开箱即用的默认主题。你也可以挑选一个社区主题，或者创建一个你自己的主题。"},{"title":"插件","icon":"fa6-solid:plug","details":"灵活的插件API，使得插件可以为你的站点提供许多即插即用的功能。"},{"title":"打包工具","icon":"fa6-solid:boxes-packing","details":"推荐的打包工具是 Vite ，但也同样支持使用 Webpack 。选一个你喜欢的来使用吧！"}],"head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"首页\\"}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"首页"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":3,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":2},{"name":"Xinyu Liu","username":"","email":"meteor.lxy@foxmail.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":0.98,"words":294},"filePathRelative":"zh/README.md"}');export{m as comp,c as data};
diff --git a/assets/index.html-_e7kFd1H.js b/assets/index.html-_e7kFd1H.js
new file mode 100644
index 00000000..e8f3e284
--- /dev/null
+++ b/assets/index.html-_e7kFd1H.js
@@ -0,0 +1 @@
+import{_ as t}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as o,e as a,r as n,o as r}from"./app-DVsngoLV.js";const s={};function p(l,c){const e=n("Catalog");return r(),o("div",null,[a(e)])}const d=t(s,[["render",p]]),g=JSON.parse('{"path":"/guide/","title":"Guide","lang":"en-US","frontmatter":{"title":"Guide","article":false,"feed":false,"sitemap":false,"head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Guide\\"}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Guide"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/"}]]},"git":{},"readingTime":{"minutes":0,"words":1},"filePathRelative":null}');export{d as comp,g as data};
diff --git a/assets/index.html-itz1aZ3n.js b/assets/index.html-itz1aZ3n.js
new file mode 100644
index 00000000..eb2c9945
--- /dev/null
+++ b/assets/index.html-itz1aZ3n.js
@@ -0,0 +1 @@
+import{_ as t}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as n,e as r,r as o,o as a}from"./app-DVsngoLV.js";const s={};function l(c,p){const e=o("Catalog");return a(),n("div",null,[r(e)])}const d=t(s,[["render",l]]),f=JSON.parse('{"path":"/zh/reference/bundler/","title":"Bundler","lang":"en-US","frontmatter":{"title":"Bundler","article":false,"feed":false,"sitemap":false,"head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Bundler\\"}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/bundler/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Bundler"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}]]},"git":{},"readingTime":{"minutes":0,"words":1},"filePathRelative":null}');export{d as comp,f as data};
diff --git a/assets/introduction.html-CanvhM2y.js b/assets/introduction.html-CanvhM2y.js
new file mode 100644
index 00000000..3ab14bb2
--- /dev/null
+++ b/assets/introduction.html-CanvhM2y.js
@@ -0,0 +1 @@
+import{_ as r}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as t,a as o,o as a}from"./app-DVsngoLV.js";const s={};function n(i,e){return a(),t("div",null,e[0]||(e[0]=[o('
VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate a static site to host them.
The purpose of creating VuePress was to support the documentation of Vue.js and its sub-projects, but now it has been helping a large amount of users to build their documentation, blogs, and other static sites.
A VuePress site is in fact a single-page application (SPA) powered by Vue and Vue Router.
Routes are generated according to the relative path of your markdown files. Each Markdown file is compiled into HTML with markdown-it and then processed as the template of a Vue component. This allows you to directly use Vue inside your Markdown files and is great when you need to embed dynamic content.
During development, we start a normal dev-server, and serve the VuePress site as a normal SPA. If you’ve used Vue before, you will notice the familiar development experience when you are writing and developing with VuePress.
During build, we create a server-rendered version of the VuePress site and render the corresponding HTML by virtually visiting each route. This approach is inspired by Nuxt's nuxt generate command and other projects like Gatsby.
Nuxt is an outstanding Vue SSR framework, and it is capable of doing what VuePress does. But Nuxt is designed for building applications, while VuePress is more lightweight and focused on content-centric static sites.
VitePress is the little brother of VuePress. It's also created and maintained by our Vue.js team. It's even more lightweight and faster than VuePress. However, as a tradeoff, it's more opinionated and less configurable. For example, it does not support plugins. But VitePress is powerful enough to make your content online if you don't need advanced customizations.
It might not be an appropriate comparison, but you can take VuePress and VitePress as Laravel and Lumen.
Both are great projects and also Vue-powered. Except they are both fully runtime-driven and therefore not SEO-friendly. If you don’t care for SEO and don’t want to mess with installing dependencies, these are still great choices.
Hexo has been serving the Vue 2.x docs well. The biggest problem is that its theming system is static and string-based - we want to take advantage of Vue for both the layout and the interactivity. Also, Hexo’s Markdown rendering isn’t the most flexible to configure.
We’ve been using GitBook for most of our sub project docs. The primary problem with GitBook is that its development reload performance is intolerable with a large amount of files. The default theme also has a pretty limiting navigation structure, and the theming system is, again, not Vue based. The team behind GitBook is also more focused on turning it into a commercial product rather than an open-source tool.
',20)]))}const p=t(a,[["render",i]]),h=JSON.parse('{"path":"/guide/introduction.html","title":"Introduction","lang":"en-US","frontmatter":{"icon":"fa6-solid:circle-info","description":"Introduction VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Introduction\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/guide/introduction.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Introduction"}],["meta",{"property":"og:description","content":"Introduction VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown, then VuePress will help you to generate..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/introduction.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":2,"url":"https://github.com/meteorlxy"},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":1.74,"words":521},"filePathRelative":"guide/introduction.md","autoDesc":true}');export{p as comp,h as data};
diff --git a/assets/making-a-theme-extendable.html-CGR9U-du.js b/assets/making-a-theme-extendable.html-CGR9U-du.js
new file mode 100644
index 00000000..29f07300
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-CGR9U-du.js
@@ -0,0 +1,30 @@
+import{_ as e}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as t,b as i,a as l,d as a,e as h,w as k,r as p,o as r}from"./app-DVsngoLV.js";const d={};function g(B,s){const n=p("RouteLink");return r(),t("div",null,[s[3]||(s[3]=i("h1",{id:"开发一个可继承的主题",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#开发一个可继承的主题"},[i("span",null,"开发一个可继承的主题")])],-1)),s[4]||(s[4]=i("p",null,"有时用户可能希望对一个主题进行一些小改动，但是又不想 Fork 并修改整个项目。",-1)),i("p",null,[s[1]||(s[1]=a("借助于 ")),h(n,{to:"/zh/reference/theme-api.html"},{default:k(()=>s[0]||(s[0]=[a("主题 API")])),_:1}),s[2]||(s[2]=a(" ，你可以让用户继承你的主题，允许用户对你的主题进行改动。"))]),s[5]||(s[5]=l(`
`,12))])}const y=e(d,[["render",g]]),m=JSON.parse('{"path":"/zh/advanced/cookbook/making-a-theme-extendable.html","title":"开发一个可继承的主题","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:clone","description":"开发一个可继承的主题 有时用户可能希望对一个主题进行一些小改动，但是又不想 Fork 并修改整个项目。 借助于 ，你可以让用户继承你的主题，允许用户对你的主题进行改动。 你肯定已经知道了如何 继承默认主题 。接下来我们将介绍如何让你的主题像默认主题一样被用户继承。 布局插槽 这种方式需要你来决定主题的哪些部分是可以被扩展的，它更适合用于一些常见的自定义...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"开发一个可继承的主题\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/zh/advanced/cookbook/making-a-theme-extendable.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"开发一个可继承的主题"}],["meta",{"property":"og:description","content":"开发一个可继承的主题 有时用户可能希望对一个主题进行一些小改动，但是又不想 Fork 并修改整个项目。 借助于 ，你可以让用户继承你的主题，允许用户对你的主题进行改动。 你肯定已经知道了如何 继承默认主题 。接下来我们将介绍如何让你的主题像默认主题一样被用户继承。 布局插槽 这种方式需要你来决定主题的哪些部分是可以被扩展的，它更适合用于一些常见的自定义..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/cookbook/making-a-theme-extendable.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":3,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":1.37,"words":411},"filePathRelative":"zh/advanced/cookbook/making-a-theme-extendable.md","autoDesc":true}');export{y as comp,m as data};
diff --git a/assets/making-a-theme-extendable.html-DfbNOmbi.js b/assets/making-a-theme-extendable.html-DfbNOmbi.js
new file mode 100644
index 00000000..e5a0b610
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-DfbNOmbi.js
@@ -0,0 +1,30 @@
+import{_ as n}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as t,b as i,a as l,d as a,e as h,w as k,r as p,o as r}from"./app-DVsngoLV.js";const d={};function o(g,s){const e=p("RouteLink");return r(),t("div",null,[s[3]||(s[3]=i("h1",{id:"making-a-theme-extendable",tabindex:"-1"},[i("a",{class:"header-anchor",href:"#making-a-theme-extendable"},[i("span",null,"Making a Theme Extendable")])],-1)),s[4]||(s[4]=i("p",null,"Sometimes users might want make some minor changes to a theme, but they don't want to fork and modify the entire project.",-1)),i("p",null,[s[1]||(s[1]=a("With the help of ")),h(e,{to:"/reference/theme-api.html"},{default:k(()=>s[0]||(s[0]=[a("Theme API")])),_:1}),s[2]||(s[2]=a(", you can make your theme extendable, allowing users to make their own modifications easily."))]),s[5]||(s[5]=l(`
You must have known that how to extend default theme. Here we'll introduce how to make your own theme extendable like default theme.
This approach requires you to determine which parts of your theme could be extended. It is more suitable for those common customizations like page footer or header.
You just need to provide slots in your layouts, and tell users how to make use of them:
This approach requires you to consider which components of your theme should be replaceable, and you also need to split components into a suitable granularity.
First, set alias for replaceable components of you theme:
import type { Theme } from 'vuepress/core'
+import { getDirname } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export const fooTheme = (options): Theme => ({
+ name: 'vuepress-theme-foo',
+ alias: {
+ // set alias for replaceable components
+ '@theme/Navbar.vue': path.resolve(__dirname, 'components/Navbar.vue'),
+ '@theme/Sidebar.vue': path.resolve(__dirname, 'components/Sidebar.vue'),
+ },
+})
Next, use those components via aliases in your theme:
Then, users can replace specific components by overriding the alias when extending or using your theme.
`,12))])}const A=n(d,[["render",o]]),y=JSON.parse(`{"path":"/advanced/cookbook/making-a-theme-extendable.html","title":"Making a Theme Extendable","lang":"en-US","frontmatter":{"icon":"fa6-solid:clone","description":"Making a Theme Extendable Sometimes users might want make some minor changes to a theme, but they don't want to fork and modify the entire project. With the help of , you can ma...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Making a Theme Extendable\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-04-09T09:33:10.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/cookbook/making-a-theme-extendable.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Making a Theme Extendable"}],["meta",{"property":"og:description","content":"Making a Theme Extendable Sometimes users might want make some minor changes to a theme, but they don't want to fork and modify the entire project. With the help of , you can ma..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2025-04-09T09:33:10.000Z"}],["meta",{"property":"article:modified_time","content":"2025-04-09T09:33:10.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/making-a-theme-extendable.html"}]]},"git":{"createdTime":1701614677000,"updatedTime":1744191190000,"contributors":[{"name":"meteorlxy","username":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":3,"url":"https://github.com/meteorlxy"},{"name":"Mr.Hope","username":"","email":"mister-hope@outlook.com","commits":1},{"name":"Mister-Hope","username":"Mister-Hope","email":"mister-hope@outlook.com","commits":1,"url":"https://github.com/Mister-Hope"}]},"readingTime":{"minutes":0.92,"words":275},"filePathRelative":"advanced/cookbook/making-a-theme-extendable.md","autoDesc":true}`);export{A as comp,y as data};
diff --git a/assets/markdown-and-vue-sfc.html-CAGydog6.js b/assets/markdown-and-vue-sfc.html-CAGydog6.js
new file mode 100644
index 00000000..4792a1c8
--- /dev/null
+++ b/assets/markdown-and-vue-sfc.html-CAGydog6.js
@@ -0,0 +1,30 @@
+import{g as l,c as h,a as p,b as i,e as k,t as n,w as d,h as r,o}from"./app-DVsngoLV.js";const c="Vue in Markdown",u={__name:"markdown-and-vue-sfc.html",setup(B){const e=(t,s)=>r("div",{class:"red-div"},s.slots.default()),a=l(0);return(t,s)=>(o(),h("div",null,[s[1]||(s[1]=p(`
Each Markdown file is first compiled into HTML, and then converted to a Vue SFC. In other words, you can write a Markdown file like a Vue SFC:
Blocks <script> and <style> are treated as Vue SFC blocks as they are. In other words, they are hoisted from the <template> block to the top-level of SFC.
Everything outside <script> and <style> will be compiled into HTML, and be treated as Vue SFC <template> block.
Warning
As Vue SFC can contain only one <script> element, you should avoid using more than one <script> in VuePress markdown.
`,8)),i("p",null,[i("em",null,"Hello, "+n(c))]),k(e,null,{default:d(()=>[i("p",null,[i("em",null,"Current count is: "+n(a.value),1)])]),_:1}),i("p",null,[i("button",{onClick:s[0]||(s[0]=g=>a.value++)},"Click Me!")])]))}},y=JSON.parse('{"path":"/advanced/cookbook/markdown-and-vue-sfc.html","title":"Markdown and Vue SFC","lang":"en-US","frontmatter":{"icon":"fa6-brands:vuejs","description":"Markdown and Vue SFC Each Markdown file is first compiled into HTML, and then converted to a Vue SFC. In other words, you can write a Markdown file like a Vue SFC: Blocks r("div",{class:"red-div"},s.slots.default()),a=l(0);return(t,s)=>(o(),p("div",null,[s[1]||(s[1]=h(`
-
-```
-
-## Component Aliases
-
-This approach requires you to consider which components of your theme should be replaceable, and you also need to split components into a suitable granularity.
-
-First, set `alias` for replaceable components of you theme:
-
-```ts
-import type { Theme } from 'vuepress/core'
-import { getDirname } from 'vuepress/utils'
-
-const __dirname = getDirname(import.meta.url)
-
-export const fooTheme = (options): Theme => ({
- name: 'vuepress-theme-foo',
- alias: {
- // set alias for replaceable components
- '@theme/Navbar.vue': path.resolve(__dirname, 'components/Navbar.vue'),
- '@theme/Sidebar.vue': path.resolve(__dirname, 'components/Sidebar.vue'),
- },
-})
-```
-
-Next, use those components via aliases in your theme:
-
-```vue
-
-
-
-
-
-
-
-
-
-```
-
-Then, users can replace specific components by overriding the `alias` when extending or using your theme.
diff --git a/docs/advanced/cookbook/markdown-and-vue-sfc.md b/docs/advanced/cookbook/markdown-and-vue-sfc.md
deleted file mode 100644
index 4fec769f..00000000
--- a/docs/advanced/cookbook/markdown-and-vue-sfc.md
+++ /dev/null
@@ -1,80 +0,0 @@
-# Markdown and Vue SFC
-
-Each Markdown file is first compiled into HTML, and then converted to a Vue SFC. In other words, you can write a Markdown file like a Vue SFC:
-
-- Blocks `
-
-
-```
-
-**Output**
-
-_Hello, {{ msg }}_
-
-
-
-_Current count is: {{ count }}_
-
-
-
-
-
-
-
-
diff --git a/docs/advanced/cookbook/passing-data-to-client-code.md b/docs/advanced/cookbook/passing-data-to-client-code.md
deleted file mode 100644
index 39b919b4..00000000
--- a/docs/advanced/cookbook/passing-data-to-client-code.md
+++ /dev/null
@@ -1,66 +0,0 @@
-# Passing Data to Client Code
-
-As we know, VuePress plugin entries and theme entries are processed in Node side, but sometimes you might need to pass data to client side. For example, you want to generate different data when users use different options.
-
-## Use `define` Hook
-
-Plugin API provides a [define](../../reference/plugin-api.md#define) hook to define global constants for client code. You can make use of it to pass data to client.
-
-First, define some constants in `define` hook:
-
-```ts
-export default (options) => ({
- define: {
- __FOO__: options.foo || 'str',
- __OBJ__: {
- bar: options.bar || 123,
- },
- },
-})
-```
-
-Then use them in client code directly:
-
-```ts
-const foo = __FOO__
-const obj = __OBJ__
-```
-
-If you are using TypeScript in client code, you may need to declare the types of the global constants manually:
-
-```ts
-declare const __FOO__: string
-declare const __OBJ__: { bar: number }
-```
-
-## Write and Load Temp Files
-
-If you need to achieve some more complex features, you can write temp files and load them dynamically in client code.
-
-First, write a temp file `foo.js`, which will be generated in the [temp](../../reference/config.md#temp) directory:
-
-```ts
-export default (options) => ({
- async onPrepared(app) {
- // write temp file
- await app.writeTemp(
- 'foo.js',
- `export const foo = ${JSON.stringify(options.foo)}`,
- )
- },
-})
-```
-
-Then, load the temp file via `@temp` alias in client code:
-
-```ts
-import { foo } from '@temp/foo'
-```
-
-If you are using TypeScript in client code, you may need to declare the type of the temp module manually:
-
-```ts
-declare module '@temp/foo' {
- export const foo: string
-}
-```
diff --git a/docs/advanced/cookbook/resolving-routes.md b/docs/advanced/cookbook/resolving-routes.md
deleted file mode 100644
index 4f3d55b1..00000000
--- a/docs/advanced/cookbook/resolving-routes.md
+++ /dev/null
@@ -1,50 +0,0 @@
-# Resolving Routes
-
-## Getting all routes
-
-You can make use of [useRoutes](../../reference/client-api.md#useroutes) to get all routes information.
-
-The return value of `useRoutes` is a Ref object containing all routes. The keys are route paths of each route, and the values are the corresponding route information.
-
-```ts
-import { useRoutes } from 'vuepress/client'
-
-const routes = useRoutes()
-// {
-// '/': { meta: { title: 'Home' }, loader: HomePageLoader },
-// '/404.html': { meta: { title: 'Not Found' }, loader: NotFoundPageLoader },
-// ...
-// }
-
-const routePaths = computed(() => Object.keys(routes.value))
-// => ['/‘, '/404.html', '/foo/', '/bar/', ...]
-```
-
-## Resolving route path
-
-You can make use of [resolveRoutePath](../../reference/client-api.md#resolveroutepath) to resolve the route path of the given link.
-
-`resolveRoutePath` receives a link and an optional base path, and returns the resolved route path:
-
-```ts
-import { resolveRoutePath } from 'vuepress/client'
-
-const routePath = resolveRoutePath('/foo/') // => '/foo/'
-const routePath = resolveRoutePath('baz.html', '/foo/bar.html') // => '/foo/baz.html'
-```
-
-## Resolving route information
-
-You can make use of [resolveRoute](../../reference/client-api.md#resolveroute) to resolve route information for a given link.
-
-`resolveRoute` receives a link and an optional base path, and returns the resolved route information:
-
-```ts
-import { resolveRoute } from 'vuepress/client'
-
-const route = resolveRoute('/foo/') // => { notFound: false, path: '/foo/', meta: { title: 'Foo' }, loader: FooPageLoader }
-const route = resolveRoute('baz.html', '/foo/bar.html') // => { notFound: false, path: '/foo/baz.html', meta: { title: 'Baz' }, loader: BazPageLoader }
-const route = resolveRoute('/not-exist.html') // => { notFound: true, path: '/not-exist.html', meta: { title: 'Not Found' }, loader: NotFoundPageLoader }
-```
-
-There is a `notFound` field in the returned information, which is used to indicate whether a corresponding route exists for a given path. When the route does not exist, the `notFound` field would be `true`, the `path` field would be the normalized path, and the `meta` and `loader` fields would point to the default 404 page.
diff --git a/docs/advanced/cookbook/usage-of-client-config.md b/docs/advanced/cookbook/usage-of-client-config.md
deleted file mode 100644
index 56ca2fc0..00000000
--- a/docs/advanced/cookbook/usage-of-client-config.md
+++ /dev/null
@@ -1,174 +0,0 @@
-# Usage of Client Config
-
-You can make use of the [client config file](../../guide/configuration.md#client-config-file) directly in your project, or specify the file path in your plugin or theme via [clientConfigFile](../../reference/plugin-api.md#clientconfigfile) hook:
-
-```ts
-import { getDirname, path } from 'vuepress/utils'
-
-const __dirname = getDirname(import.meta.url)
-
-const pluginOrTheme = {
- clientConfigFile: path.resolve(__dirname, './path/to/clientConfig.ts'),
-}
-```
-
-Inside the client config file, `vuepress/client` provides a helper function [defineClientConfig](../../reference/client-api.md#defineclientconfig) to help you define the client config:
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-
-export default defineClientConfig({
- enhance({ app, router, siteData }) {},
- setup() {},
- layouts: {},
- rootComponents: [],
-})
-```
-
-## enhance
-
-The `enhance` function could be either synchronous or asynchronous. It accepts a context param with following properties:
-
-- `app` is the Vue application instance that created by [createApp](https://vuejs.org/api/application.html#createapp).
-- `router` is the Vue Router instance that created by [createRouter](https://router.vuejs.org/api/#createrouter).
-- `siteData` is a ref of an object that generated from user config, including [base](../../reference/config.md#base), [lang](../../reference/config.md#lang), [title](../../reference/config.md#title), [description](../../reference/config.md#description), [head](../../reference/config.md#head) and [locales](../../reference/config.md#locales).
-
-The `enhance` function will be invoked after the client app is created. It's possible to implement any enhancements to the Vue application.
-
-### Register Vue Components
-
-You can register global Vue components via the [app.component](https://vuejs.org/api/application.html#app-component) method:
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-import MyComponent from './MyComponent.vue'
-
-export default defineClientConfig({
- enhance({ app }) {
- app.component('MyComponent', MyComponent)
- },
-})
-```
-
-### Use Non-SSR-Friendly Features
-
-VuePress will generate a SSR application to pre-render pages during build. Generally speaking, if a code snippet is using Browser / DOM APIs before client app is mounted, we call it non-SSR-friendly.
-
-We already provides a [ClientOnly](../../reference/components.md#clientonly) component to wrap non-SSR-friendly content.
-
-In the `enhance` function, you can make use of the [`__VUEPRESS_SSR__`](../../reference/client-api.md#ssr) flag for that purpose.
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-
-export default defineClientConfig({
- async enhance() {
- if (!__VUEPRESS_SSR__) {
- const nonSsrFriendlyModule = await import('non-ssr-friendly-module')
- // ...
- }
- },
-})
-```
-
-### Use Router Methods
-
-You can make use of the [Router Methods](https://router.vuejs.org/api/#router-methods) that provided by vue-router. For example, add navigation guard:
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-
-export default defineClientConfig({
- enhance({ router }) {
- router.beforeEach((to) => {
- console.log('before navigation')
- })
-
- router.afterEach((to) => {
- console.log('after navigation')
- })
- },
-})
-```
-
-::: warning
-It's not recommended to use `addRoute` method to add dynamic routes here, because those routes will **NOT** be pre-rendered in build mode.
-
-But you can still do that if you understand the drawback.
-:::
-
-## setup
-
-The `setup` function would be invoked inside the [setup](https://vuejs.org/api/composition-api-setup.html) hook of the client vue app.
-
-### Use Composition API
-
-You can take the `setup` function as part of the [setup](https://vuejs.org/api/composition-api-setup.html) hook of the root component. Thus, all composition APIs are available here.
-
-```ts
-import { provide, ref } from 'vue'
-import { useRoute, useRouter } from 'vue-router'
-import { defineClientConfig } from 'vuepress/client'
-
-export default defineClientConfig({
- setup() {
- // get the current route location
- const route = useRoute()
- // get the vue-router instance
- const router = useRouter()
- // provide a value that can be injected by layouts, pages and other components
- const count = ref(0)
- provide('count', count)
- },
-})
-```
-
-### Use Non-SSR-Friendly Features
-
-In the `setup` function, the [`__VUEPRESS_SSR__`](../../reference/client-api.md#ssr) flag is also available.
-
-Another way to use non-ssr-friendly features is to put them inside the [onMounted](https://vuejs.org/api/composition-api-lifecycle.html#onmounted) hook:
-
-```ts
-import { onMounted } from 'vue'
-import { defineClientConfig } from 'vuepress/client'
-
-export default defineClientConfig({
- setup() {
- onMounted(() => {
- // use DOM API after mounted
- document.querySelector('#app')
- })
- },
-})
-```
-
-## layouts
-
-The `layouts` options is to set layout components. After layout components are registered here, users can use it via [layout](../../reference/frontmatter.md#layout) frontmatter.
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-import MyLayout from './layouts/MyLayout.vue'
-
-export default defineClientConfig({
- layouts: {
- MyLayout,
- },
-})
-```
-
-## rootComponents
-
-The `rootComponents` is a components array to be placed directly into the root node of the client vue app.
-
-Typical usage of this option is to put some global UI components, like global popup or so:
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-import GlobalPopup from './components/GlobalPopup.vue'
-
-export default defineClientConfig({
- rootComponents: [GlobalPopup],
-})
-```
diff --git a/docs/advanced/plugin.md b/docs/advanced/plugin.md
deleted file mode 100644
index f3aac5a2..00000000
--- a/docs/advanced/plugin.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# Writing a Plugin
-
-::: tip
-Before reading this guide, you'd better learn the VuePress [architecture](./architecture.md) first.
-:::
-
-## Create a Plugin
-
-A plugin should be a plain JavaScript object that satisfies the [Plugin API](../reference/plugin-api.md), which is called a _Plugin Object_:
-
-```ts
-const fooPlugin = {
- name: 'vuepress-plugin-foo',
- // ...
-}
-```
-
-A plugin could also be a function that receives the [app instance](../reference/node-api.md#app) as the param and returns a _Plugin Object_, which is called a _Plugin Function_:
-
-```ts
-const barPlugin = (app) => ({
- name: 'vuepress-plugin-bar',
- // ...
-})
-```
-
-A plugin usually needs to allow user options, so we typically provide users with a function to receive options, and returns a _Plugin Object_ or a _Plugin Function_. Then your plugin should be converted like this:
-
-```ts
-const fooPlugin = (options) => ({
- name: 'vuepress-plugin-foo',
- // ...
-})
-
-const barPlugin = (options) => (app) => ({
- name: 'vuepress-plugin-bar',
- // ...
-})
-```
-
-## Publish to NPM
-
-After creating a plugin, you should follow some conventions in the [package.json](https://docs.npmjs.com/cli/v8/configuring-npm/package-json) file before publishing it to NPM:
-
-```json
-{
- "name": "vuepress-plugin-foo",
- "keywords": ["vuepress-plugin"]
-}
-```
-
-- Set `name` to follow the naming convention, i.e. `vuepress-plugin-xxx` or `@org/vuepress-plugin-xxx`, which should be consistent with the [name](../reference/plugin-api.md#name) field of the _Plugin Object_.
-- Set `keywords` to include `vuepress-plugin`, so that users can search your plugin on NPM.
diff --git a/docs/advanced/theme.md b/docs/advanced/theme.md
deleted file mode 100644
index 9ceae09a..00000000
--- a/docs/advanced/theme.md
+++ /dev/null
@@ -1,95 +0,0 @@
-# Writing a Theme
-
-::: tip
-Before reading this guide, you'd better learn the guide of [Writing a Plugin](./plugin.md) first.
-:::
-
-## Create a Theme
-
-A VuePress theme is a special plugin, which should satisfy the [Theme API](../reference/theme-api.md). Like plugins, a theme should also be a _Theme Object_ or a _Theme Function_, and could be wrapped with a function to receive options:
-
-```ts
-import { getDirname, path } from 'vuepress/utils'
-
-const __dirname = getDirname(import.meta.url)
-
-const fooTheme = (options) =>
- // returns a theme object
- ({
- name: 'vuepress-theme-foo',
-
- // path to the client config of your theme
- clientConfigFile: path.resolve(__dirname, 'client.js'),
-
- // set custom dev / build template
- // if the template is not specified, the default template
- templateBuild: path.resolve(__dirname, 'templates/build.html'),
- templateDev: path.resolve(__dirname, 'templates/dev.html'),
-
- // use plugins
- plugins: [
- // ...
- ],
-
- // other plugin APIs are also available
- })
-
-const barTheme =
- (options) =>
- // returns a theme function
- (app) => ({
- name: 'vuepress-theme-bar',
- // ...
- })
-```
-
-Then, create theme's client config file `client.js` :
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-import Layout from './layouts/Layout.vue'
-import NotFound from './layouts/NotFound.vue'
-
-export default defineClientConfig({
- layouts: {
- Layout,
- NotFound,
- },
-})
-```
-
-The `layouts` field declares the layouts provided by your theme. A theme must provide at least two layouts: `Layout` and `NotFound`. The former is to provide default layout for common pages, while the latter is to provide layout for 404-not-found page.
-
-The `Layout` layout should contain the [Content](../reference/components.md#content) component to display the markdown content:
-
-```vue
-
-
-
-
-
-```
-
-The `NotFound` layout will be used for the `404.html` page:
-
-```vue
-
-
404 Not Found
-
-```
-
-You can provide more layouts, and users can change layout via [layout](../reference/frontmatter.md#layout) frontmatter.
-
-## Publish to NPM
-
-Also, there are some conventions for theme in [package.json](https://docs.npmjs.com/cli/v8/configuring-npm/package-json):
-
-```json
-{
- "name": "vuepress-theme-foo",
- "keywords": ["vuepress-theme"]
-}
-```
-
-- Set `name` to follow the naming convention: `vuepress-theme-xxx` or `@org/vuepress-theme-xxx`, which should be consistent with the [name](../reference/theme-api.md#name) field of the _Theme Object_.
-- Set `keywords` to include `vuepress-theme`, so that users can search your theme on NPM.
diff --git a/docs/guide/assets.md b/docs/guide/assets.md
deleted file mode 100644
index 93618ad1..00000000
--- a/docs/guide/assets.md
+++ /dev/null
@@ -1,126 +0,0 @@
-# Assets
-
-## Relative URLs
-
-You can reference any assets using relative URLs in your Markdown content:
-
-```md
-
-```
-
-or
-
-```md
-
-```
-
-This is generally the suggested way to import images, as users usually place images near the Markdown file that references them.
-
-## Public Files
-
-You can put some static assets inside public directory, and they will be copied to the root of the generated directory.
-
-The default public directory is `.vuepress/public`, which can be changed by [public](../reference/config.md#public) option.
-
-It would be useful in some cases:
-
-- You may need to provide static assets that are not directly referenced in any of your Markdown files, for example, favicon and PWA icons.
-- You may need to serve some shared static assets, which may even be referenced outside your site, for example, logo images.
-- You may want to reference images using absolute URLs in your Markdown content.
-
-Take our documentation source files as an example, we are putting the logo of VuePress inside the public directory:
-
-```bash
-└─ docs
- ├─ .vuepress
- | └─ public
- | └─ images
- | └─ hero.png # <- Logo file
- └─ guide
- └─ assets.md # <- Here we are
-```
-
-We can reference our logo in current page like this:
-
-**Input**
-
-```md
-
-```
-
-**Output**
-
-
-
-### Base Helper
-
-If your site is deployed to a non-root URL, for example, `https://foo.github.io/bar/`, then the [base](../reference/config.md#base) should be set to `'/bar/'`. Obviously, your public files would be served like `https://foo.github.io/bar/images/hero.png` after deployment.
-
-In most cases, you don't need to worry about the reference path of those public files, as VuePress will automatically handle `base` for you:
-
-```md
-
-
-
-```
-
-::: tip
-When using [webpack bundler](../reference/bundler/webpack.md), you need to set [markdown.assets.absolutePathPrependBase](../reference/config.md#markdown-assets) to `true` to automatically prepend base to markdown images.
-:::
-
-However, sometimes you may have some dynamical links referencing public files, especially when you are authoring a custom theme. In such case, the `base` could not be handled automatically. To help with that, VuePress provides a [withBase](../reference/client-api.md#withbase) helper to prepend `base` for you:
-
-```vue
-
-
-
-
-
-```
-
-You can also access the helper by `$withBase` directly:
-
-```md
-
-```
-
-## Packages and Path Aliases
-
-Although it is not a common usage, you can reference images from dependent packages:
-
-```bash
-npm install -D package-name
-```
-
-Since markdown image syntax regards image links as relative paths by default, you need to use `` tag:
-
-```md
-
-```
-
-The path aliases that set in config file are also supported:
-
-```ts
-import { getDirname, path } from 'vuepress/utils'
-
-const __dirname = getDirname(import.meta.url)
-
-export default {
- alias: {
- '@alias': path.resolve(__dirname, './path/to/some/dir'),
- },
-}
-```
-
-```md
-
-```
-
-::: tip
-Config reference: [alias](../reference/plugin-api.md#alias)
-:::
diff --git a/docs/guide/bundler.md b/docs/guide/bundler.md
deleted file mode 100644
index 443e46a0..00000000
--- a/docs/guide/bundler.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# Bundler
-
-VuePress supports using [Webpack](https://webpack.js.org/) or [Vite](https://vite.dev/) to dev and build sites. You can choose which bundler to use according to your preference, and no extra configuration is required.
-
-## Install a Bundler
-
-When installing the [vuepress](https://www.npmjs.com/package/vuepress) package, no bundlers will be installed. You need to choose a bundler to install.
-
-::: code-tabs#shell
-
-@tab pnpm
-
-```bash
-# install vite bundler
-pnpm add -D vuepress@next @vuepress/bundler-vite@next
-# install webpack bundler
-pnpm add -D vuepress@next @vuepress/bundler-webpack@next
-```
-
-@tab yarn
-
-```bash
-# install vite bundler
-yarn add -D vuepress@next @vuepress/bundler-vite@next
-# install webpack bundler
-yarn add -D vuepress@next @vuepress/bundler-webpack@next
-```
-
-@tab npm
-
-```bash
-# install vite bundler
-npm install -D vuepress@next @vuepress/bundler-vite@next
-# install webpack bundler
-npm install -D vuepress@next @vuepress/bundler-webpack@next
-```
-
-:::
-
-## Use a Bundler
-
-Generally, you could use a bundler without extra configuration, because we have already configured them properly to work with VuePress.
-
-You can use a bundler via the [bundler](../reference/config.md#bundler) option:
-
-```ts
-import { viteBundler } from '@vuepress/bundler-vite'
-// import { webpackBundler } from '@vuepress/bundler-webpack'
-
-export default {
- bundler: viteBundler(),
- // bundler: webpackBundler(),
-}
-```
-
-When you need to customize the bundler, you can set the corresponding options:
-
-- [Bundlers > Vite](../reference/bundler/vite.md)
-- [Bundlers > Webpack](../reference/bundler/webpack.md)
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
deleted file mode 100644
index a750472f..00000000
--- a/docs/guide/configuration.md
+++ /dev/null
@@ -1,86 +0,0 @@
-# Configuration
-
-## Config File
-
-The essential file for configuring a VuePress site is `.vuepress/config.js`, while TypeScript config file is also supported. You can use `.vuepress/config.ts` instead to get better types hint for VuePress config.
-
-To be more specific, we have a convention for config file paths (in order of precedence):
-
-- In current working directory `cwd`:
- - `vuepress.config.ts`
- - `vuepress.config.js`
- - `vuepress.config.mjs`
-- In source directory `sourceDir`:
- - `.vuepress/config.ts`
- - `.vuepress/config.js`
- - `.vuepress/config.mjs`
-
-You can also specify the config file via `--config` option of [CLI](../reference/cli.md):
-
-```bash
-vuepress dev docs --config my-config.ts
-```
-
-A basic config file looks like this:
-
-```ts
-import { viteBundler } from '@vuepress/bundler-vite'
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- bundler: viteBundler(),
- theme: defaultTheme(),
-
- lang: 'en-US',
- title: 'Hello VuePress',
- description: 'Just playing around',
-})
-```
-
-::: tip
-Check out the [Config Reference](../reference/config.md) for a full list of VuePress config.
-:::
-
-## Client Config File
-
-In most cases, the config file is sufficient to configure your VuePress site. However, sometimes users may want to add some client-side code directly. To help with this, VuePress also supports a client config file:
-
-```
-├─ docs
-│ ├─ .vuepress
-│ │ ├─ client.js <--- client config file
-│ │ └─ config.js <--- config file
-│ └─ README.md
-├─ .gitignore
-└─ package.json
-```
-
-Similarly, we also have a convention for client config file paths (in order of precedence):
-
-- In current working directory `cwd`:
- - `vuepress.client.ts`
- - `vuepress.client.js`
- - `vuepress.client.mjs`
-- In source directory `sourceDir`:
- - `.vuepress/client.ts`
- - `.vuepress/client.js`
- - `.vuepress/client.mjs`
-
-A basic client config file looks like this:
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-
-export default defineClientConfig({
- enhance({ app, router, siteData }) {},
- setup() {},
- rootComponents: [],
-})
-```
-
-::: tip
-Unlike config file, client config file could not be specified via CLI options.
-
-To learn more about client config file, see [Advanced > Cookbook > Usage of Client Config](../advanced/cookbook/usage-of-client-config.md)
-:::
diff --git a/docs/guide/deployment.md b/docs/guide/deployment.md
deleted file mode 100644
index 7fe5feee..00000000
--- a/docs/guide/deployment.md
+++ /dev/null
@@ -1,233 +0,0 @@
-# Deployment
-
-The following guides are based on some shared assumptions:
-
-- You are placing your Markdown source files inside the `docs` directory of your project;
-- You are using the default build output location (`.vuepress/dist`);
-- You are using [pnpm](https://pnpm.io) as package manager, while npm and yarn are also supported;
-- VuePress is installed as a local dependency in your project, and you have setup the following script in `package.json`:
-
-```json
-{
- "scripts": {
- "docs:build": "vuepress build docs"
- }
-}
-```
-
-## GitHub Pages
-
-1. Set the correct [base](../reference/config.md#base) config.
-
- If you are deploying to `https://.github.io/`, you can omit this step as `base` defaults to `"/"`.
-
- If you are deploying to `https://.github.io//`, for example your repository is at `https://github.com//`, then set `base` to `"//"`.
-
-2. Choose your preferred CI tools. Here we take [GitHub Actions](https://github.com/features/actions) as an example.
-
- Create `.github/workflows/docs.yml` to set up the workflow.
-
-::: details Click to expand sample config
-
-```yaml
-name: docs
-
-on:
- # trigger deployment on every push to main branch
- push:
- branches: [main]
- # trigger deployment manually
- workflow_dispatch:
-
-jobs:
- docs:
- runs-on: ubuntu-latest
-
- steps:
- - uses: actions/checkout@v4
- with:
- # fetch all commits to get last updated time or other git log info
- fetch-depth: 0
-
- - name: Setup pnpm
- uses: pnpm/action-setup@v4
-
- - name: Setup Node.js
- uses: actions/setup-node@v4
- with:
- # choose node.js version to use
- node-version: 22
- # cache deps for pnpm
- cache: pnpm
-
- - name: Install deps
- run: pnpm install --frozen-lockfile
-
- # run build script
- - name: Build VuePress site
- run: pnpm docs:build
-
- # please check out the docs of the workflow for more details
- # @see https://github.com/crazy-max/ghaction-github-pages
- - name: Deploy to GitHub Pages
- uses: crazy-max/ghaction-github-pages@v4
- with:
- # deploy to gh-pages branch
- target_branch: gh-pages
- # deploy the default output dir of VuePress
- build_dir: docs/.vuepress/dist
- env:
- # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-
-:::
-
-::: tip
-Please refer to [GitHub Pages official guide](https://pages.github.com/) for more details.
-:::
-
-## GitLab Pages
-
-1. Set the correct [base](../reference/config.md#base) config.
-
- If you are deploying to `https://.gitlab.io/`, you can omit `base` as it defaults to `"/"`.
-
- If you are deploying to `https://.gitlab.io//`, for example your repository is at `https://gitlab.com//`, then set `base` to `"//"`.
-
-2. Create `.gitlab-ci.yml` to set up [GitLab CI](https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/) workflow.
-
-::: details Click to expand sample config
-
-```yaml
-# choose a docker image to use
-image: node:18-buster
-
-pages:
- # trigger deployment on every push to main branch
- only:
- - main
-
- # cache node_modules
- cache:
- key:
- files:
- - pnpm-lock.yaml
- paths:
- - .pnpm-store
-
- # Install pnpm
- before_script:
- - curl -fsSL https://get.pnpm.io/install.sh | sh -
- - pnpm config set store-dir .pnpm-store
-
- # install dependencies and run build script
- script:
- - pnpm i --frozen-lockfile
- - pnpm docs:build --dest public
-
- artifacts:
- paths:
- - public
-```
-
-:::
-
-::: tip
-Please refer to [GitLab Pages official guide](https://docs.gitlab.com/ce/user/project/pages/#getting-started) for more details.
-:::
-
-## Google Firebase
-
-1. Make sure you have [firebase-tools](https://www.npmjs.com/package/firebase-tools) installed.
-
-2. Create `firebase.json` and `.firebaserc` at the root of your project with the following content:
-
-`firebase.json`:
-
-```json
-{
- "hosting": {
- "public": "./docs/.vuepress/dist",
- "ignore": []
- }
-}
-```
-
-`.firebaserc`:
-
-```json
-{
- "projects": {
- "default": ""
- }
-}
-```
-
-3. After running `pnpm docs:build`, deploy using the command `firebase deploy`.
-
-::: tip
-Please refer to [Firebase CLI official guide](https://firebase.google.com/docs/cli) for more details.
-:::
-
-## Heroku
-
-1. Install [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli).
-
-2. Create a Heroku account by [signing up](https://signup.heroku.com).
-
-3. Run `heroku login` and fill in your Heroku credentials:
-
-```bash
-heroku login
-```
-
-4. Create a file called `static.json` in the root of your project with the below content:
-
-`static.json`:
-
-```json
-{
- "root": "./docs/.vuepress/dist"
-}
-```
-
-This is the configuration of your site; read more at [heroku-buildpack-static](https://github.com/heroku/heroku-buildpack-static).
-
-## Kinsta
-
-See [Set Up VuePress on Kinsta](https://kinsta.com/docs/vuepress-application/).
-
-## Edgio
-
-See [Edgio Documentation > Framework Guides > VuePress](https://docs.edg.io/guides/vuepress).
-
-## Netlify
-
-1. On [Netlify](https://netlify.com), set up a new project from GitHub with the following settings:
- - **Build Command:** `pnpm docs:build`
- - **Publish directory:** `docs/.vuepress/dist`
-
-2. Set [Environment variables](https://docs.netlify.com/configure-builds/environment-variables) to choose node version:
- - `NODE_VERSION`: 20
-
-3. Hit the deploy button.
-
-::: note
-
-You should disable Pretty URLs in the "Site Configuration" → "Build & Deploy" → "Post processing".
-
-:::
-
-## Vercel
-
-1. Go to [Vercel](https://vercel.com), set up a new project from GitHub with the following settings:
- - **FRAMEWORK PRESET:** `Other`
- - **BUILD COMMAND:** `pnpm docs:build`
- - **OUTPUT DIRECTORY:** `docs/.vuepress/dist`
-
-2. Hit the deploy button.
-
-## CloudRay
-
-See [Deploy Your VuePress Site With CloudRay](https://cloudray.io/articles/how-to-deploy-your-vuepress-site)
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
deleted file mode 100644
index 9a231c80..00000000
--- a/docs/guide/getting-started.md
+++ /dev/null
@@ -1,252 +0,0 @@
-# Getting Started
-
-::: warning
-VuePress v2 is currently in RC (Release Candidate) stage. It's ready to be used for building your site, but the config and API are not stable enough, which is possibly to have minor breaking changes. So make sure to read the [changelog](https://github.com/vuepress/core/blob/main/CHANGELOG.md) carefully each time you upgrade a RC version.
-:::
-
-## Try It Online
-
-You can try VuePress directly in your browser on [StackBlitz](https://stackblitz.com/fork/vuepress).
-
-## Installation
-
-### Prerequisites
-
-- [Node.js v20.9.0+](https://nodejs.org/)
-- Package manager like [pnpm](https://pnpm.io), [yarn](https://classic.yarnpkg.com/en/), [npm](https://www.npmjs.com), etc.
-
-::: tip
-
-- When using [pnpm](https://pnpm.io/), you need to install `vue` as peer-dependencies.
-- When using [yarn 2+](https://yarnpkg.com/), you need to set `nodeLinker: 'node-modules'` in your [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) file.
-
-:::
-
-### Project Setup
-
-#### Setup via CLI
-
-You can use [create-vuepress](https://www.npmjs.com/package/create-vuepress) to generate a template directly.
-
-::: code-tabs#shell
-
-@tab pnpm
-
-```bash
-pnpm create vuepress vuepress-starter
-```
-
-@tab yarn
-
-```bash
-yarn create vuepress vuepress-starter
-```
-
-@tab npm
-
-```bash
-npm init vuepress vuepress-starter
-```
-
-:::
-
-#### Setup Manually
-
-This section will help you build a basic VuePress documentation site from ground up.
-
-- Create and change into a new directory
-
-```bash
-mkdir vuepress-starter
-cd vuepress-starter
-```
-
-- Initialize your project
-
-::: code-tabs#shell
-
-@tab pnpm
-
-```bash
-git init
-pnpm init
-```
-
-@tab yarn
-
-```bash
-git init
-yarn init
-```
-
-@tab npm
-
-```bash
-git init
-npm init
-```
-
-:::
-
-- Install VuePress
-
-::: code-tabs#shell
-
-@tab pnpm
-
-```bash
-# install vuepress and vue
-pnpm add -D vuepress@next vue
-# install bundler and theme
-pnpm add -D @vuepress/bundler-vite@next @vuepress/theme-default@next
-```
-
-@tab yarn
-
-```bash
-# install vuepress
-yarn add -D vuepress@next
-# install bundler and theme
-yarn add -D @vuepress/bundler-vite@next @vuepress/theme-default@next
-```
-
-@tab npm
-
-```bash
-# install vuepress
-npm install -D vuepress@next
-# install bundler and theme
-npm install -D @vuepress/bundler-vite@next @vuepress/theme-default@next
-```
-
-:::
-
-- Create `docs` directory and `docs/.vuepress` directory
-
-```bash
-mkdir docs
-mkdir docs/.vuepress
-```
-
-- Create the VuePress config file `docs/.vuepress/config.js`
-
-```ts
-import { viteBundler } from '@vuepress/bundler-vite'
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- bundler: viteBundler(),
- theme: defaultTheme(),
-})
-```
-
-- Create your first document
-
-```bash
-echo '# Hello VuePress' > docs/README.md
-```
-
-## Directory Structure
-
-After the setup, the minimal structure of your project should look like this:
-
-```
-├─ docs
-│ ├─ .vuepress
-│ │ └─ config.js
-│ └─ README.md
-└─ package.json
-```
-
-The `docs` directory is where you put your markdown files, and it will be used as the source directory of VuePress.
-
-The `docs/.vuepress` directory, i.e. the `.vuepress` directory in the source directory, is where all VuePress-specific files will be placed. Currently there is only one config file in it. By default, the temp, cache and output directory will also be generated inside this directory. It is suggested to add them to your `.gitignore` file.
-
-::: details Example `.gitignore` file
-
-```
-# VuePress default temp directory
-.vuepress/.temp
-# VuePress default cache directory
-.vuepress/.cache
-# VuePress default build output directory
-.vuepress/dist
-```
-
-:::
-
-## Work with VuePress
-
-### Start Dev Server
-
-You can add some [scripts](https://classic.yarnpkg.com/en/docs/package-json#toc-scripts) to `package.json`:
-
-```json
-{
- "scripts": {
- "docs:dev": "vuepress dev docs",
- "docs:build": "vuepress build docs"
- }
-}
-```
-
-Then, run `docs:dev` script to start the dev server:
-
-::: code-tabs#shell
-
-@tab pnpm
-
-```bash
-pnpm docs:dev
-```
-
-@tab yarn
-
-```bash
-yarn docs:dev
-```
-
-@tab npm
-
-```bash
-npm run docs:dev
-```
-
-:::
-
-VuePress will start a hot-reloading development server at [http://localhost:8080](http://localhost:8080). When you modify your markdown files, the content in the browser will be auto updated.
-
-### Build Your Site
-
-To build your site, run `docs:build` script:
-
-::: code-tabs#shell
-
-@tab pnpm
-
-```bash
-pnpm docs:build
-```
-
-@tab yarn
-
-```bash
-yarn docs:build
-```
-
-@tab npm
-
-```bash
-npm run docs:build
-```
-
-:::
-
-You will see the generated static files in the `docs/.vuepress/dist` directory. You can check out [deployment](./deployment.md) for how to deploy them.
-
-## Learn More about VuePress
-
-By now, you should have a basic but functional VuePress site. But you may still need to read the subsequent guide to learn more about VuePress.
-
-Next step, learn more about the [configuration](./configuration.md).
diff --git a/docs/guide/i18n.md b/docs/guide/i18n.md
deleted file mode 100644
index bf572ef0..00000000
--- a/docs/guide/i18n.md
+++ /dev/null
@@ -1,78 +0,0 @@
-# I18n
-
-## Site I18n Config
-
-To take advantage of multi-language support in VuePress, you first need to use the following file and directory structure:
-
-```
-docs
-├─ README.md
-├─ foo.md
-├─ nested
-│ └─ README.md
-└─ zh
- ├─ README.md
- ├─ foo.md
- └─ nested
- └─ README.md
-```
-
-Then, specify the `locales` option in your [config file](./configuration.md#config-file):
-
-```ts
-export default {
- locales: {
- // The key is the path for the locale to be nested under.
- // As a special case, the default locale can use '/' as its path.
- '/': {
- lang: 'en-US',
- title: 'VuePress',
- description: 'Vue-powered Static Site Generator',
- },
- '/zh/': {
- lang: 'zh-CN',
- title: 'VuePress',
- description: 'Vue 驱动的静态网站生成器',
- },
- },
-}
-```
-
-If a locale does not have a `lang`, `title`, `description` or `head`, VuePress will fallback to the root-level values. You can omit the root level config as long as they are provided in each locale.
-
-::: tip
-Config reference: [locales](../reference/config.md#locales)
-:::
-
-## Theme I18n Config
-
-VuePress does not restrict how themes provide multi-language support, so each theme may have different way to handle i18n, and some themes may not provide multi-language support at all. You'd better refer to the theme documentation for detailed guide.
-
-If you are using default theme, the multi-language support is the same as above:
-
-```ts
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- theme: defaultTheme({
- locales: {
- '/': {
- selectLanguageName: 'English',
- },
- '/zh/': {
- selectLanguageName: '简体中文',
- },
- },
- }),
-})
-```
-
-::: tip
-
-Config reference:
-
-- [Default Theme > Config](https://ecosystem.vuejs.press/themes/default/config.html)
-- [Default Theme > Locale config](https://ecosystem.vuejs.press/themes/default/locale.html)
-
-:::
diff --git a/docs/guide/introduction.md b/docs/guide/introduction.md
deleted file mode 100644
index 9157eb6f..00000000
--- a/docs/guide/introduction.md
+++ /dev/null
@@ -1,25 +0,0 @@
-# Introduction
-
-VuePress is a markdown-centered static site generator (SSG). You can write your content (documentations, blogs, etc.) in [Markdown](https://en.wikipedia.org/wiki/Markdown), then VuePress will help you to generate a static site to host them.
-
-The purpose of creating VuePress was to support the documentation of Vue.js and its sub-projects, but now it has been helping a large amount of users to build their documentation, blogs, and other static sites.
-
-## How It Works
-
-A VuePress site is in fact a single-page application (SPA) powered by [Vue](https://vuejs.org/) and [Vue Router](https://router.vuejs.org).
-
-Routes are generated according to the relative path of your markdown files. Each Markdown file is compiled into HTML with [markdown-it](https://github.com/markdown-it/markdown-it) and then processed as the template of a Vue component. This allows you to directly use Vue inside your Markdown files and is great when you need to embed dynamic content.
-
-During development, we start a normal dev-server, and serve the VuePress site as a normal SPA. If you’ve used Vue before, you will notice the familiar development experience when you are writing and developing with VuePress.
-
-During build, we create a server-rendered version of the VuePress site and render the corresponding HTML by virtually visiting each route. This approach is inspired by [Nuxt](https://nuxtjs.org/)'s `nuxt generate` command and other projects like [Gatsby](https://www.gatsbyjs.org/).
-
-## VuePress and VitePress: The Connection
-
-VitePress can be seen as the younger sibling of VuePress. Both were originally created by Evan You, the author of Vue.js. Today, VitePress is maintained by the Vue.js team, while VuePress is maintained by the VuePress team.
-
-The history goes like this: VuePress v0 and v1 were built on top of Webpack. Later, when Evan created Vite, he started a new static site generator based on it — VitePress — reusing some ideas and code from VuePress. At the same time, the community forked the VuePress v2 branch, continued its development, and added support for both Webpack and Vite.
-
-At one point, we discussed merging the two projects under the VuePress brand. However, over time their goals and technical directions diverged. As a result, the Vue.js team chose to focus on VitePress, while the community — now the VuePress team — took over VuePress and continues to drive its development forward.
-
-As a user, you can choose either project depending on your needs. VitePress is tightly integrated with Vite. VuePress, on the other hand, is designed to support different bundlers: it supports Webpack and Vite today, and open to any other bundlers. In addition, VuePress has an official [ecosystem](https://ecosystem.vuejs.press/) project and provides a wide range of plugins, making it easier to build sites with features.
diff --git a/docs/guide/markdown.md b/docs/guide/markdown.md
deleted file mode 100644
index 3d24a946..00000000
--- a/docs/guide/markdown.md
+++ /dev/null
@@ -1,508 +0,0 @@
-# Markdown
-
-Make sure you already know Markdown well before reading this section. If not, please learn some [Markdown tutorials](https://commonmark.org/help/) first.
-
-## Syntax Extensions
-
-The Markdown content in VuePress will be parsed by [markdown-it](https://github.com/markdown-it/markdown-it), which supports [syntax extensions](https://github.com/markdown-it/markdown-it#syntax-extensions) via markdown-it plugins.
-
-This section will introduce built-in Markdown syntax extensions of VuePress.
-
-You can also configure those built-in extensions, load more markdown-it plugins and implement your own extensions via [markdown](../reference/config.md#markdown) option and [extendsMarkdown](../reference/plugin-api.md#extendsmarkdown) option.
-
-### Embedded
-
-Embedded by markdown-it:
-
-- [Tables](https://help.github.com/articles/organizing-information-with-tables/) (GFM)
-- [Strikethrough](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) (GFM)
-
-### Header Anchors
-
-You might have noticed that, a `#` anchor is displayed when you hover the mouse on the headers of each section. By clicking the `#` anchor, you can jump to the section directly.
-
-::: tip
-This header anchors extension is supported by [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor).
-
-Config reference: [markdown.anchor](../reference/config.md#markdown-anchor)
-:::
-
-### Links
-
-When using Markdown [link syntax](https://spec.commonmark.org/0.29/#link-reference-definitions), VuePress will implement some conversions for you.
-
-Take our documentation source files as an example:
-
-```bash
-└─ docs
- ├─ guide
- │ ├─ getting-started.md
- │ ├─ introduction.md
- │ └─ markdown.md # <- Here we are
- ├─ reference
- │ └─ config.md
- └─ README.md
-```
-
-**Raw Markdown**
-
-```md
-
-
-[Home](../README.md)
-[Config Reference](../reference/config.md)
-[Getting Started](./getting-started.md)
-
-
-
-[Guide > Introduction](/guide/introduction.md)
-[Config Reference > markdown.links](/reference/config.md#links)
-
-
-
-[GitHub](https://github.com)
-```
-
-**Converted to**
-
-```vue
-
- Home
- Config Reference
- Getting Started
- Guide > Introduction
-
- Config Reference > markdown.links
-
-
- GitHub
-
-
-```
-
-**Rendered as**
-
-[Home](../README.md)
-[Config Reference](../reference/config.md)
-[Getting Started](./getting-started.md)
-[Guide > Introduction](/guide/introduction.md)
-[Config Reference > markdown.links](/reference/config.md#links)
-[GitHub](https://github.com)
-
-**Explanation**
-
-- Internal links will be converted to [RouteLink](../reference/components.md#routelink) for SPA navigation.
-- Internal links to `.md` files will be converted to the [page route path](./page.md#routing), and both absolute path and relative path are supported.
-- External links will get `target="_blank" rel="noopener noreferrer"` attrs.
-
-**Suggestion**
-
-Try to use relative paths instead of absolute paths for internal links to markdown files.
-
-- Relative paths are a valid links to the target files, and they can navigate correctly when browsing the source files in your editor or repository.
-- Relative paths are consistent in different locales, so you don't need to change the locale path when translating your content.
-
-::: tip
-This links extension is supported by our built-in plugin.
-
-Config reference: [markdown.links](../reference/config.md#markdown-links)
-:::
-
-### Emoji :tada:
-
-You can add emoji to your Markdown content by typing `:EMOJICODE:`.
-
-For a full list of available emoji and codes, check out [emoji-cheat-sheet](https://github.com/ikatyang/emoji-cheat-sheet).
-
-**Input**
-
-```md
-VuePress 2 is out :tada: !
-```
-
-**Output**
-
-VuePress 2 is out :tada: !
-
-::: tip
-This emoji extension is supported by [markdown-it-emoji](https://github.com/markdown-it/markdown-it-emoji).
-
-Config reference: [markdown.emoji](../reference/config.md#markdown-emoji)
-:::
-
-### Table of Contents
-
-If you want to put the table of contents (TOC) of your current page inside your Markdown content, you can use the `[[toc]]` syntax.
-
-**Input**
-
-```md
-[[toc]]
-```
-
-**Output**
-
-[[toc]]
-
-The headers in TOC will link to the corresponding [header anchors](#header-anchors), so TOC won't work well if you disable header anchors.
-
-::: tip
-This toc extension is supported by [@mdit-vue/plugin-toc](https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc).
-
-Config reference: [markdown.toc](../reference/config.md#markdown-toc)
-:::
-
-### Code Blocks
-
-Following code blocks extensions are implemented during markdown parsing in Node side. That means, the code blocks won't be processed in client side.
-
-With [@vuepress/plugin-prismjs][prismjs] and [@vuepress/plugin-shiki][shiki], you can highlight code blocks with [Prism](https://prismjs.com/) or [Shiki](https://shiki.style/).
-
-#### Code Title
-
-You can specify the title of the code block by adding a `title` key-value mark in your fenced code blocks.
-
-**Input**
-
-````md
-```ts title=".vuepress/config.ts"
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- title: 'Hello, VuePress',
-
- theme: defaultTheme({
- logo: 'https://vuejs.org/images/logo.png',
- }),
-})
-```
-````
-
-**Output**
-
-```ts title=".vuepress/config.ts"
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- title: 'Hello, VuePress',
-
- theme: defaultTheme({
- logo: 'https://vuejs.org/images/logo.png',
- }),
-})
-```
-
-::: tip
-
-Code title is supported by highlight plugins by default. It can be used in combination with the other marks below. Please leave a space between them.
-
-:::
-
-#### Line Highlighting
-
-You can highlight specified lines of your code blocks by adding line ranges mark in your fenced code blocks.
-
-**Input**
-
-````md
-```ts{1,7-9}
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- title: 'Hello, VuePress',
-
- theme: defaultTheme({
- logo: 'https://vuejs.org/images/logo.png',
- }),
-})
-```
-````
-
-**Output**
-
-```ts{1,7-9}
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- title: 'Hello, VuePress',
-
- theme: defaultTheme({
- logo: 'https://vuejs.org/images/logo.png',
- }),
-})
-```
-
-Examples for line ranges mark:
-
-- Line ranges: `{5-8}`
-- Multiple single lines: `{4,7,9}`
-- Combined: `{4,7-13,16,23-27,40}`
-
-::: tip
-
-Line highlighting extension is supported by highlighter plugins.
-
-Config reference: [prism line highlighting](https://ecosystem.vuejs.press/plugins/markdown/prismjs.html#highlightlines) and [shiki highlighting](https://ecosystem.vuejs.press/plugins/markdown/shiki.html#highlightlines).
-
-:::
-
-#### Line Numbers
-
-You must have noticed that the number of lines is displayed on the left side of code blocks.
-
-You can add `:line-numbers` / `:no-line-numbers` mark in your fenced code blocks to override the value set in config.
-
-**Input**
-
-````md
-```ts
-// line-numbers is enabled by default
-const line2 = 'This is line 2'
-const line3 = 'This is line 3'
-```
-
-```ts:no-line-numbers
-// line-numbers is disabled
-const line2 = 'This is line 2'
-const line3 = 'This is line 3'
-```
-````
-
-**Output**
-
-```ts
-// line-numbers is enabled by default
-const line2 = 'This is line 2'
-const line3 = 'This is line 3'
-```
-
-```ts:no-line-numbers
-// line-numbers is disabled
-const line2 = 'This is line 2'
-const line3 = 'This is line 3'
-```
-
-::: tip
-
-Line numbers extension is supported by highlighter plugins.
-
-Config reference: [prism line numbers](https://ecosystem.vuejs.press/plugins/markdown/prismjs.html#linenumbers) and [shiki line numbers](https://ecosystem.vuejs.press/plugins/markdown/shiki.html#linenumbers).
-
-:::
-
-#### Wrap with v-pre
-
-As [template syntax is allowed in Markdown](#template-syntax), it would also work in code blocks, too.
-
-To avoid your code blocks being compiled by Vue, VuePress will add [v-pre](https://vuejs.org/api/built-in-directives.html#v-pre) directive to your code blocks by default, which can be disabled in config.
-
-You can add `:v-pre` / `:no-v-pre` mark in your fenced code blocks to override the value set in config.
-
-::: warning
-The template syntax characters, for example, the "Mustache" syntax (double curly braces) might be parsed by the syntax highlighter. Thus, as the following example, `:no-v-pre` might not work well in some languages.
-
-If you want to make Vue syntax work in those languages anyway, try to disable the default syntax highlighting and implement your own syntax highlighting in client side.
-:::
-
-**Input**
-
-````md
-```md
-
-
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-```
-
-```md:no-v-pre
-
-
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-```
-
-```js:no-v-pre
-// This won't be compiled correctly because of js syntax highlighting
-const onePlusTwoPlusThree = {{ 1 + 2 + 3 }}
-```
-````
-
-**Output**
-
-```md
-
-
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-```
-
-```md:no-v-pre
-
-
-1 + 2 + 3 = {{ 1 + 2 + 3 }}
-```
-
-
-
-```js
-// This won't be compiled correctly because of js syntax highlighting
-const onePlusTwoPlusThree = {{ 1 + 2 + 3 }}
-```
-
-::: tip
-
-This v-pre extension is supported by our built-in plugin.
-
-Config reference: [markdown.vPre.block](../reference/config.md#markdown-vpre-block)
-
-:::
-
-### Import Code Blocks
-
-You can import code blocks from files with following syntax:
-
-```md
-
-
-@[code](../foo.js)
-```
-
-If you want to partially import the file:
-
-```md
-
-
-@[code{1-10}](../foo.js)
-```
-
-The code language is inferred from the file extension, while it is recommended to specify it explicitly:
-
-```md
-
-
-@[code js](../foo.js)
-```
-
-In fact, the second part inside the `[]` will be treated as the mark of the code fence, so it supports all the syntax mentioned in the above [Code Blocks](#code-blocks) section:
-
-```md
-
-
-@[code js{2,4-5}](../foo.js)
-```
-
-Here is a complex example:
-
-- import line 3 to line 10 of the `'../foo.js'` file
-- specify the language as `'js'`
-- highlight line 3 of the imported code, i.e. line 5 of the `'../foo.js'` file
-- disable line numbers
-
-```md
-@[code{3-10} js{3}:no-line-numbers](../foo.js)
-```
-
-Notice that path aliases are not available in import code syntax. You can use following config to handle path alias yourself:
-
-```ts
-import { getDirname, path } from 'vuepress/utils'
-
-const __dirname = getDirname(import.meta.url)
-
-export default {
- markdown: {
- importCode: {
- handleImportPath: (str) =>
- str.replace(/^@src/, path.resolve(__dirname, 'path/to/src')),
- },
- },
-}
-```
-
-```md
-
-
-@[code](@src/foo.js)
-```
-
-::: tip
-This import code extension is supported by our built-in plugin.
-
-Config reference: [markdown.importCode](../reference/config.md#markdown-importcode)
-:::
-
-## Using Vue in Markdown
-
-This section will introduce some basic usage of Vue in Markdown.
-
-Check out [Cookbook > Markdown and Vue SFC](../advanced/cookbook/markdown-and-vue-sfc.md) for more details.
-
-### Template Syntax
-
-As we know:
-
-- HTML is allowed in Markdown.
-- Vue template syntax is compatible with HTML.
-
-That means, [Vue template syntax](https://vuejs.org/guide/essentials/template-syntax.html) is allowed in Markdown.
-
-**Input**
-
-```md
-One plus one equals: {{ 1 + 1 }}
-
- span: {{ i }}
-```
-
-**Output**
-
-One plus one equals: {{ 1 + 1 }}
-
- span: {{ i }}
-
-### Components
-
-You can use Vue components directly in Markdown.
-
-**Input**
-
-```md
-This is default theme built-in `` component
-```
-
-**Output**
-
-This is default theme built-in `` component
-
-::: tip
-Check out the [Built-in Components](../reference/components.md) for a full list of built-in components.
-
-Check out the [Default Theme > Built-in Components](https://ecosystem.vuejs.press/themes/default/components.html) for a full list of default theme built-in components.
-:::
-
-## Markdown Plugins
-
-You can explore more markdown plugins at [VuePress Marketplace](https://marketplace.vuejs.press/plugins/markdown.html).
-
-## Cautions
-
-### Non-Standard HTML Tags
-
-Non-standard HTML tags would not be recognized as native HTML tags by Vue template compiler. Instead, Vue will try to resolve those tags as Vue components, and obviously these components usually don't exist. For example:
-
-- Deprecated HTML tags such as [\
If your site is deployed to a non-root URL, for example, https://foo.github.io/bar/, then the base should be set to '/bar/'. Obviously, your public files would be served like https://foo.github.io/bar/images/hero.png after deployment.
In most cases, you don't need to worry about the reference path of those public files, as VuePress will automatically handle base for you:
<!-- you don't need to prepend `/bar/` to `/images/hero.png` manually -->
+
+
However, sometimes you may have some dynamical links referencing public files, especially when you are authoring a custom theme. In such case, the base could not be handled automatically. To help with that, VuePress provides a withBase helper to prepend base for you:
-```
-
-The path aliases that set in config file are also supported:
-
-```ts
-import { getDirname, path } from 'vuepress/utils'
-
-const __dirname = getDirname(import.meta.url)
-
-export default {
- alias: {
- '@alias': path.resolve(__dirname, './path/to/some/dir'),
- },
-}
-```
-
-```md
-
-```
-
-::: tip
-Config reference: [alias](../reference/plugin-api.md#alias)
-:::
diff --git a/docs/guide/bundler.md b/docs/guide/bundler.md
deleted file mode 100644
index 443e46a0..00000000
--- a/docs/guide/bundler.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# Bundler
-
-VuePress supports using [Webpack](https://webpack.js.org/) or [Vite](https://vite.dev/) to dev and build sites. You can choose which bundler to use according to your preference, and no extra configuration is required.
-
-## Install a Bundler
-
-When installing the [vuepress](https://www.npmjs.com/package/vuepress) package, no bundlers will be installed. You need to choose a bundler to install.
-
-::: code-tabs#shell
-
-@tab pnpm
-
-```bash
-# install vite bundler
-pnpm add -D vuepress@next @vuepress/bundler-vite@next
-# install webpack bundler
-pnpm add -D vuepress@next @vuepress/bundler-webpack@next
-```
-
-@tab yarn
-
-```bash
-# install vite bundler
-yarn add -D vuepress@next @vuepress/bundler-vite@next
-# install webpack bundler
-yarn add -D vuepress@next @vuepress/bundler-webpack@next
-```
-
-@tab npm
-
-```bash
-# install vite bundler
-npm install -D vuepress@next @vuepress/bundler-vite@next
-# install webpack bundler
-npm install -D vuepress@next @vuepress/bundler-webpack@next
-```
-
-:::
-
-## Use a Bundler
-
-Generally, you could use a bundler without extra configuration, because we have already configured them properly to work with VuePress.
-
-You can use a bundler via the [bundler](../reference/config.md#bundler) option:
-
-```ts
-import { viteBundler } from '@vuepress/bundler-vite'
-// import { webpackBundler } from '@vuepress/bundler-webpack'
-
-export default {
- bundler: viteBundler(),
- // bundler: webpackBundler(),
-}
-```
-
-When you need to customize the bundler, you can set the corresponding options:
-
-- [Bundlers > Vite](../reference/bundler/vite.md)
-- [Bundlers > Webpack](../reference/bundler/webpack.md)
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
deleted file mode 100644
index a750472f..00000000
--- a/docs/guide/configuration.md
+++ /dev/null
@@ -1,86 +0,0 @@
-# Configuration
-
-## Config File
-
-The essential file for configuring a VuePress site is `.vuepress/config.js`, while TypeScript config file is also supported. You can use `.vuepress/config.ts` instead to get better types hint for VuePress config.
-
-To be more specific, we have a convention for config file paths (in order of precedence):
-
-- In current working directory `cwd`:
- - `vuepress.config.ts`
- - `vuepress.config.js`
- - `vuepress.config.mjs`
-- In source directory `sourceDir`:
- - `.vuepress/config.ts`
- - `.vuepress/config.js`
- - `.vuepress/config.mjs`
-
-You can also specify the config file via `--config` option of [CLI](../reference/cli.md):
-
-```bash
-vuepress dev docs --config my-config.ts
-```
-
-A basic config file looks like this:
-
-```ts
-import { viteBundler } from '@vuepress/bundler-vite'
-import { defaultTheme } from '@vuepress/theme-default'
-import { defineUserConfig } from 'vuepress'
-
-export default defineUserConfig({
- bundler: viteBundler(),
- theme: defaultTheme(),
-
- lang: 'en-US',
- title: 'Hello VuePress',
- description: 'Just playing around',
-})
-```
-
-::: tip
-Check out the [Config Reference](../reference/config.md) for a full list of VuePress config.
-:::
-
-## Client Config File
-
-In most cases, the config file is sufficient to configure your VuePress site. However, sometimes users may want to add some client-side code directly. To help with this, VuePress also supports a client config file:
-
-```
-├─ docs
-│ ├─ .vuepress
-│ │ ├─ client.js <--- client config file
-│ │ └─ config.js <--- config file
-│ └─ README.md
-├─ .gitignore
-└─ package.json
-```
-
-Similarly, we also have a convention for client config file paths (in order of precedence):
-
-- In current working directory `cwd`:
- - `vuepress.client.ts`
- - `vuepress.client.js`
- - `vuepress.client.mjs`
-- In source directory `sourceDir`:
- - `.vuepress/client.ts`
- - `.vuepress/client.js`
- - `.vuepress/client.mjs`
-
-A basic client config file looks like this:
-
-```ts
-import { defineClientConfig } from 'vuepress/client'
-
-export default defineClientConfig({
- enhance({ app, router, siteData }) {},
- setup() {},
- rootComponents: [],
-})
-```
-
-::: tip
-Unlike config file, client config file could not be specified via CLI options.
-
-To learn more about client config file, see [Advanced > Cookbook > Usage of Client Config](../advanced/cookbook/usage-of-client-config.md)
-:::
diff --git a/docs/guide/deployment.md b/docs/guide/deployment.md
deleted file mode 100644
index 7fe5feee..00000000
--- a/docs/guide/deployment.md
+++ /dev/null
@@ -1,233 +0,0 @@
-# Deployment
-
-The following guides are based on some shared assumptions:
-
-- You are placing your Markdown source files inside the `docs` directory of your project;
-- You are using the default build output location (`.vuepress/dist`);
-- You are using [pnpm](https://pnpm.io) as package manager, while npm and yarn are also supported;
-- VuePress is installed as a local dependency in your project, and you have setup the following script in `package.json`:
-
-```json
-{
- "scripts": {
- "docs:build": "vuepress build docs"
- }
-}
-```
-
-## GitHub Pages
-
-1. Set the correct [base](../reference/config.md#base) config.
-
- If you are deploying to `https://
-+ 
-```
-
-### CLI Change
-
-#### eject command
-
-Removed.
-
-#### cache options
-
-- `-c, --cache [cache]`: changed to `--cache 