+
+
+
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..37bebb6d
--- /dev/null
+++ b/advanced/architecture.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+ 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:
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.
Note
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.
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 setupopen in new window hook of the root component. Thus, all composition APIs are available here.
import{ defineClientConfig }from"@vuepress/client";
+import{ provide, ref }from"vue";
+import{ useRoute, useRouter }from"vue-router";
+
+exportdefaultdefineClientConfig({
+ 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);
+
+constfooTheme=(options)=>{
+ // returns a theme object
+ return{
+ 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 from `@vuepress/client` will be used
+ templateBuild: path.resolve(__dirname,"templates/build.html"),
+ templateDev: path.resolve(__dirname,"templates/dev.html"),
+
+ // use plugins
+ plugins:[
+ // ...
+ ],
+
+ // other plugin APIs are also available
+ };
+};
+
+constbarTheme=(options)=>{
+ // returns a theme function
+ return(app)=>{
+ return{
+ name:"vuepress-theme-bar",
+ // ...
+ };
+ };
+};
+
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-15746044.js b/assets/404.html-15746044.js
new file mode 100644
index 00000000..2e54f319
--- /dev/null
+++ b/assets/404.html-15746044.js
@@ -0,0 +1 @@
+import{_ as e,W as t,X as _}from"./framework-46b0e263.js";const c={};function r(n,o){return t(),_("div")}const a=e(c,[["render",r],["__file","404.html.vue"]]);export{a as default};
diff --git a/assets/404.html-c1720e4d.js b/assets/404.html-c1720e4d.js
new file mode 100644
index 00000000..c4855cee
--- /dev/null
+++ b/assets/404.html-c1720e4d.js
@@ -0,0 +1 @@
+const t=JSON.parse('{"key":"v-3706649a","path":"/404.html","title":"","lang":"en-US","frontmatter":{"layout":"NotFound","description":"","head":[["meta",{"property":"og:url","content":"https://vuejs.press/404.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"\\"}"]]},"headers":[],"git":{},"readingTime":{"minutes":0,"words":0},"filePathRelative":null,"autoDesc":true}');export{t as data};
diff --git a/assets/active-header-links.html-7f2d6108.js b/assets/active-header-links.html-7f2d6108.js
new file mode 100644
index 00000000..918af30b
--- /dev/null
+++ b/assets/active-header-links.html-7f2d6108.js
@@ -0,0 +1,11 @@
+import{_ as c,W as d,X as p,Y as a,$ as e,a0 as n,Z as o,a1 as i,D as s}from"./framework-46b0e263.js";const h={},u=e("h1",{id:"active-header-links",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#active-header-links","aria-hidden":"true"},"#"),n(" active-header-links")],-1),m=i(`
This plugin will listen to page scroll event. When the page scrolls to a certain header anchor, this plugin will change the route hash to that header anchor if there is a corresponding header link.
This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
Even if you click the link of the header anchor directly, the scrollTop might not be exactly equal to offsetTop of the header anchor, so we add an offset to avoid the error.
',4);function w(D,T){const l=s("NpmBadge"),r=s("ExternalLinkIcon"),t=s("RouterLink");return d(),p("div",null,[u,a(l,{package:"@vuepress/plugin-active-header-links"}),m,e("ul",null,[k,v,e("li",null,[f,g,e("p",null,[n("You don't need to specify this option unless you have changed the "),_,n(" option of "),e("a",b,[n("markdown-it-anchor"),a(r)]),n(" via "),a(t,{to:"/reference/config.html#markdown-anchor"},{default:o(()=>[n("markdown.anchor")]),_:1}),n(".")])]),e("li",null,[y,e("ul",null,[e("li",null,[a(t,{to:"/guide/markdown.html#header-anchors"},{default:o(()=>[n("Guide > Markdown > Syntax Extensions > Header Anchors")]),_:1})])])])]),x])}const N=c(h,[["render",w],["__file","active-header-links.html.vue"]]);export{N as default};
diff --git a/assets/active-header-links.html-91a347f7.js b/assets/active-header-links.html-91a347f7.js
new file mode 100644
index 00000000..918409e2
--- /dev/null
+++ b/assets/active-header-links.html-91a347f7.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3ba02eb8","path":"/reference/plugin/active-header-links.html","title":"active-header-links","lang":"en-US","frontmatter":{"description":"This plugin will listen to page scroll event. When the page scrolls to a certain header anchor, this plugin will change the route hash to that header anchor if there is a corres...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/active-header-links.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/active-header-links.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"active-header-links"}],["meta",{"property":"og:description","content":"This plugin will listen to page scroll event. When the page scrolls to a certain header anchor, this plugin will change the route hash to that header anchor if there is a corres..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"active-header-links\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"headerLinkSelector","slug":"headerlinkselector","link":"#headerlinkselector","children":[]},{"level":3,"title":"headerAnchorSelector","slug":"headeranchorselector","link":"#headeranchorselector","children":[]},{"level":3,"title":"delay","slug":"delay","link":"#delay","children":[]},{"level":3,"title":"offset","slug":"offset","link":"#offset","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.83,"words":248},"filePathRelative":"reference/plugin/active-header-links.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/active-header-links.html-a98aa233.js b/assets/active-header-links.html-a98aa233.js
new file mode 100644
index 00000000..f3c5697f
--- /dev/null
+++ b/assets/active-header-links.html-a98aa233.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-231b4d69","path":"/zh/reference/plugin/active-header-links.html","title":"active-header-links","lang":"zh-CN","frontmatter":{"description":"该插件会监听页面滚动事件。当页面滚动至某个 标题锚点 后，如果存在对应的 标题链接 ，那么该插件会将路由 Hash 更改为该 标题锚点 。 该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。 使用方法 配置项 headerLinkSelector 类型： string; 默认值： 'a.sidebar-item'; 详情...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/active-header-links.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/active-header-links.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"active-header-links"}],["meta",{"property":"og:description","content":"该插件会监听页面滚动事件。当页面滚动至某个 标题锚点 后，如果存在对应的 标题链接 ，那么该插件会将路由 Hash 更改为该 标题锚点 。 该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。 使用方法 配置项 headerLinkSelector 类型： string; 默认值： 'a.sidebar-item'; 详情..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"active-header-links\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"headerLinkSelector","slug":"headerlinkselector","link":"#headerlinkselector","children":[]},{"level":3,"title":"headerAnchorSelector","slug":"headeranchorselector","link":"#headeranchorselector","children":[]},{"level":3,"title":"delay","slug":"delay","link":"#delay","children":[]},{"level":3,"title":"offset","slug":"offset","link":"#offset","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.25,"words":374},"filePathRelative":"zh/reference/plugin/active-header-links.md","localizedDate":"2023年2月22日","autoDesc":true}`);export{e as data};
diff --git a/assets/active-header-links.html-bb25d530.js b/assets/active-header-links.html-bb25d530.js
new file mode 100644
index 00000000..09521555
--- /dev/null
+++ b/assets/active-header-links.html-bb25d530.js
@@ -0,0 +1,11 @@
+import{_ as r,W as d,X as p,Y as a,$ as e,a0 as n,Z as l,a1 as t,D as s}from"./framework-46b0e263.js";const u={},h=e("h1",{id:"active-header-links",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#active-header-links","aria-hidden":"true"},"#"),n(" active-header-links")],-1),m=t(`
',4);function y(L,E){const o=s("NpmBadge"),i=s("RouterLink"),c=s("ExternalLinkIcon");return d(),p("div",null,[h,a(o,{package:"@vuepress/plugin-active-header-links"}),m,e("ul",null,[k,v,e("li",null,[_,f,e("p",null,[n("你通常不需要设置该选项，除非你通过 "),a(i,{to:"/zh/reference/config.html#markdown-anchor"},{default:l(()=>[n("markdown.anchor")]),_:1}),n(" 修改了 "),e("a",b,[n("markdown-it-anchor"),a(c)]),n(" 的 "),g,n(" 选项。")])]),e("li",null,[x,e("ul",null,[e("li",null,[a(i,{to:"/zh/guide/markdown.html#%E6%A0%87%E9%A2%98%E9%94%9A%E7%82%B9"},{default:l(()=>[n("指南 > Markdown > 语法扩展 > 标题锚点")]),_:1})])])])]),w])}const N=r(u,[["render",y],["__file","active-header-links.html.vue"]]);export{N as default};
diff --git a/assets/adding-extra-pages.html-7488d932.js b/assets/adding-extra-pages.html-7488d932.js
new file mode 100644
index 00000000..0967ccdb
--- /dev/null
+++ b/assets/adding-extra-pages.html-7488d932.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5b617736","path":"/zh/advanced/cookbook/adding-extra-pages.html","title":"添加额外页面","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:circle-plus","description":"有时你可能希望在不创建 Markdown 文件的情况下添加一些额外的页面。 我们可以借助于 插件 API (../../reference/plugin-api.md) 和 Node API (../../reference/node-api.md) 来轻松实现。 添加默认的主页 作为一个主题作者，你可能不想要求用户必须创建一个 /README.md ...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/cookbook/adding-extra-pages.html"}],["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 文件的情况下添加一些额外的页面。 我们可以借助于 插件 API (../../reference/plugin-api.md) 和 Node API (../../reference/node-api.md) 来轻松实现。 添加默认的主页 作为一个主题作者，你可能不想要求用户必须创建一个 /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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"添加额外页面\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"添加默认的主页","slug":"添加默认的主页","link":"#添加默认的主页","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.68,"words":204},"filePathRelative":"zh/advanced/cookbook/adding-extra-pages.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/adding-extra-pages.html-85fbc8d4.js b/assets/adding-extra-pages.html-85fbc8d4.js
new file mode 100644
index 00000000..093d24a5
--- /dev/null
+++ b/assets/adding-extra-pages.html-85fbc8d4.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-2a57b498","path":"/advanced/cookbook/adding-extra-pages.html","title":"Adding Extra Pages","lang":"en-US","frontmatter":{"icon":"fa6-solid:circle-plus","description":"Sometimes you might want to add some extra pages without creating a markdown file in the source directory. With the help of Plugin API (../../reference/plugin-api.md) and Node A...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/adding-extra-pages.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/cookbook/adding-extra-pages.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Adding Extra Pages"}],["meta",{"property":"og:description","content":"Sometimes you might want to add some extra pages without creating a markdown file in the source directory. With the help of Plugin API (../../reference/plugin-api.md) and Node A..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Adding Extra Pages\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Add a Default Homepage","slug":"add-a-default-homepage","link":"#add-a-default-homepage","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.49,"words":146},"filePathRelative":"advanced/cookbook/adding-extra-pages.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/adding-extra-pages.html-9002b717.js b/assets/adding-extra-pages.html-9002b717.js
new file mode 100644
index 00000000..0f1c53a1
--- /dev/null
+++ b/assets/adding-extra-pages.html-9002b717.js
@@ -0,0 +1,27 @@
+import{_ as p,W as o,X as i,$ as a,a0 as n,Y as t,Z as e,a1 as c,D as l}from"./framework-46b0e263.js";const u={},d=a("h1",{id:"adding-extra-pages",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#adding-extra-pages","aria-hidden":"true"},"#"),n(" Adding Extra Pages")],-1),r=a("p",null,"Sometimes you might want to add some extra pages without creating a markdown file in the source directory.",-1),k=c(`
As a theme author, you may not require users to create a /README.md file as the homepage, but you want to provide a default one:
import{ createPage }from"@vuepress/core";
+
+exportdefault{
+ // all pages have been loaded after initialization
+ asynconInitialized(app){
+ // if the homepage does not exist
+ if(app.pages.every((page)=> page.path !=="/")){
+ // create a homepage
+ const homepage =awaitcreatePage(app,{
+ path:"/",
+ // set frontmatter
+ frontmatter:{
+ layout:"Layout",
+ },
+ // set markdown content
+ content:\`\\
+# Welcome to \${app.options.title}
+
+This is the default homepage
+\`,
+ });
+ // add it to \`app.pages\`
+ app.pages.push(homepage);
+ }
+ },
+};
+
`,3);function m(v,h){const s=l("RouterLink");return o(),i("div",null,[d,r,a("p",null,[n("With the help of "),t(s,{to:"/reference/plugin-api.html"},{default:e(()=>[n("Plugin API")]),_:1}),n(" and "),t(s,{to:"/reference/node-api.html"},{default:e(()=>[n("Node API")]),_:1}),n(", we can do that with ease.")]),k])}const b=p(u,[["render",m],["__file","adding-extra-pages.html.vue"]]);export{b as default};
diff --git a/assets/adding-extra-pages.html-d579a0d0.js b/assets/adding-extra-pages.html-d579a0d0.js
new file mode 100644
index 00000000..e78d5b6b
--- /dev/null
+++ b/assets/adding-extra-pages.html-d579a0d0.js
@@ -0,0 +1,27 @@
+import{_ as p,W as o,X as c,$ as s,a0 as n,Y as t,Z as e,a1 as i,D as l}from"./framework-46b0e263.js";const u={},r=s("h1",{id:"添加额外页面",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#添加额外页面","aria-hidden":"true"},"#"),n(" 添加额外页面")],-1),d=s("p",null,"有时你可能希望在不创建 Markdown 文件的情况下添加一些额外的页面。",-1),k=i(`
',9),f=l("strong",null,"init",-1),g=l("li",null,"Theme and plugins will be loaded. That means all the plugins should be used before initialization.",-1),m=l("li",null,[e("In the "),l("strong",null,"prepare"),e(" stage: "),l("ul",null,[l("li",null,"Temp files will be generated, so all hooks related to client files will be processed here.")])],-1),w=l("strong",null,"dev / build",-1);function _(b,k){const t=c("RouterLink");return s(),d("div",null,[h,l("p",null,[e("The above figure shows the core process of VuePress Node App and the hooks of "),n(t,{to:"/reference/plugin-api.html"},{default:o(()=>[e("Plugin API")]),_:1}),e(":")]),l("ul",null,[l("li",null,[e("In the "),f,e(" stage: "),l("ul",null,[g,l("li",null,[e("As we are using markdown-it to parse the markdown file, so we need to create markdown-it instance before loading pages: "),l("ul",null,[l("li",null,[n(t,{to:"/reference/plugin-api.html#extendsmarkdownoptions"},{default:o(()=>[e("extendsMarkdownOptions")]),_:1}),e(" hook will be processed to create markdown-it instance.")]),l("li",null,[n(t,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:o(()=>[e("extendsMarkdown")]),_:1}),e(" hook will be processed extends markdown-it instance.")])])]),l("li",null,[e("Page files will be loaded: "),l("ul",null,[l("li",null,[n(t,{to:"/reference/plugin-api.html#extendspageoptions"},{default:o(()=>[e("extendsPageOptions")]),_:1}),e(" hook will be processed to create pages.")]),l("li",null,[n(t,{to:"/reference/plugin-api.html#extendspage"},{default:o(()=>[e("extendsPage")]),_:1}),e(" hook will be processed to extends page object.")])])])])]),m,l("li",null,[e("In the "),w,e(" stage: "),l("ul",null,[l("li",null,[e("Bundler will be resolved: "),l("ul",null,[l("li",null,[n(t,{to:"/reference/plugin-api.html#extendsbundleroptions"},{default:o(()=>[e("extendsBundlerOptions")]),_:1}),e(" hook will be processed to create bundler configuration.")]),l("li",null,[n(t,{to:"/reference/plugin-api.html#alias"},{default:o(()=>[e("alias")]),_:1}),e(" hook and "),n(t,{to:"/reference/plugin-api.html#define"},{default:o(()=>[e("define")]),_:1}),e(" hook would be used in bundler configuration, so they will be processed here.")])])])])])])])}const A=r(p,[["render",_],["__file","architecture.html.vue"]]);export{A as default};
diff --git a/assets/architecture.html-bfe48eba.js b/assets/architecture.html-bfe48eba.js
new file mode 100644
index 00000000..6279e5a2
--- /dev/null
+++ b/assets/architecture.html-bfe48eba.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-b4ed4f1c","path":"/advanced/architecture.html","title":"Architecture","lang":"en-US","frontmatter":{"icon":"fa6-solid:folder-tree","description":"Overview vuepress-architecture-overview The above figure shows a brief overview of the VuePress architecture: Node App will generate temp files, including the pages, routes, etc...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/architecture.html"}],["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":"Overview vuepress-architecture-overview The above figure shows a brief overview of the VuePress architecture: Node App will generate temp files, including the pages, routes, etc..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Architecture\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Overview","slug":"overview","link":"#overview","children":[]},{"level":2,"title":"Core Process and Hooks","slug":"core-process-and-hooks","link":"#core-process-and-hooks","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.08,"words":323},"filePathRelative":"advanced/architecture.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/assets.html-1b1d6062.js b/assets/assets.html-1b1d6062.js
new file mode 100644
index 00000000..42c268db
--- /dev/null
+++ b/assets/assets.html-1b1d6062.js
@@ -0,0 +1,33 @@
+import{_ as p}from"./hero-8a9eb0cf.js";import{_ as i,W as l,X as c,$ as a,a0 as s,Y as e,Z as t,a1 as o,D as r}from"./framework-46b0e263.js";const u={},d=o(`
`,10),w={class:"hint-container tip"},x=a("p",{class:"hint-container-title"},"Tips",-1);function q(P,L){const n=r("RouterLink");return l(),c("div",null,[d,a("p",null,[s("The default public directory is "),m,s(", which can be changed by "),e(n,{to:"/reference/config.html#public"},{default:t(()=>[s("public")]),_:1}),s(" option.")]),k,a("p",null,[s("If your site is deployed to a non-root URL, for example, "),g,s(", then the "),e(n,{to:"/reference/config.html#base"},{default:t(()=>[s("base")]),_:1}),s(" should be set to "),v,s(". Obviously, your public files would be served like "),h,s(" after deployment.")]),b,a("p",null,[s("However, sometimes you may have some dynamical links referencing public files, especially when you are authoring a custom theme. In such case, the "),f,s(" could not be handled automatically. To help with that, VuePress provides a "),e(n,{to:"/reference/client-api.html#withbase"},{default:t(()=>[s("withBase")]),_:1}),s(" helper to prepend "),y,s(" for you:")]),_,a("div",w,[x,a("p",null,[s("Config reference: "),e(n,{to:"/reference/plugin-api.html#alias"},{default:t(()=>[s("alias")]),_:1})])])])}const I=i(u,[["render",q],["__file","assets.html.vue"]]);export{I as default};
diff --git a/assets/assets.html-2f37d46f.js b/assets/assets.html-2f37d46f.js
new file mode 100644
index 00000000..22dd6315
--- /dev/null
+++ b/assets/assets.html-2f37d46f.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3c32c2ca","path":"/guide/assets.html","title":"Assets","lang":"en-US","frontmatter":{"icon":"fa6-solid:photo-film","description":"Relative URLs You can reference any assets using relative URLs in your Markdown content: This is generally the suggested way to import images, as users usually place images near...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/assets.html"}],["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":"Relative URLs You can reference any assets using relative URLs in your Markdown content: This is generally the suggested way to import images, as users usually place images near..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://vuejs.press/"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2023-02-22T07:39:31.000Z"}],["meta",{"name":"twitter:card","content":"summary_large_image"}],["meta",{"name":"twitter:image:alt","content":"Assets"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Assets\\",\\"image\\":[\\"https://vuejs.press/\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Relative URLs","slug":"relative-urls","link":"#relative-urls","children":[]},{"level":2,"title":"Public Files","slug":"public-files","link":"#public-files","children":[{"level":3,"title":"Base Helper","slug":"base-helper","link":"#base-helper","children":[]}]},{"level":2,"title":"Packages and Path Aliases","slug":"packages-and-path-aliases","link":"#packages-and-path-aliases","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.55,"words":465},"filePathRelative":"guide/assets.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/assets.html-4d2615e1.js b/assets/assets.html-4d2615e1.js
new file mode 100644
index 00000000..7bdc5aa2
--- /dev/null
+++ b/assets/assets.html-4d2615e1.js
@@ -0,0 +1,33 @@
+import{_ as o}from"./hero-8a9eb0cf.js";import{_ as l,W as i,X as c,$ as n,a0 as s,Y as e,Z as t,a1 as p,D as u}from"./framework-46b0e263.js";const r={},d=p(`
`,8);function u(k,m){const n=i("NpmBadge");return e(),t("div",null,[l,o(n,{package:"@vuepress/plugin-back-to-top"}),r])}const b=s(d,[["render",u],["__file","back-to-top.html.vue"]]);export{b as default};
diff --git a/assets/back-to-top.html-5a088d40.js b/assets/back-to-top.html-5a088d40.js
new file mode 100644
index 00000000..82129ad6
--- /dev/null
+++ b/assets/back-to-top.html-5a088d40.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6c6e4840","path":"/zh/reference/plugin/back-to-top.html","title":"back-to-top","lang":"zh-CN","frontmatter":{"description":"该插件会给你的站点添加一个 返回顶部 按钮。当页面向下滚动时，该按钮会显示在页面的右下角，点击它就会滚动到页面顶部。 该插件已经集成到默认主题中。 使用方法 样式 你可以通过 CSS 变量来自定义 返回顶部 按钮的样式： code css (@vuepress/plugin-back-to-top/src/client/styles/vars.css)","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/back-to-top.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/back-to-top.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"back-to-top"}],["meta",{"property":"og:description","content":"该插件会给你的站点添加一个 返回顶部 按钮。当页面向下滚动时，该按钮会显示在页面的右下角，点击它就会滚动到页面顶部。 该插件已经集成到默认主题中。 使用方法 样式 你可以通过 CSS 变量来自定义 返回顶部 按钮的样式： code css (@vuepress/plugin-back-to-top/src/client/styles/vars.css)"}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"back-to-top\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"样式","slug":"样式","link":"#样式","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.47,"words":141},"filePathRelative":"zh/reference/plugin/back-to-top.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/back-to-top.html-5f6d8d82.js b/assets/back-to-top.html-5f6d8d82.js
new file mode 100644
index 00000000..050b1d01
--- /dev/null
+++ b/assets/back-to-top.html-5f6d8d82.js
@@ -0,0 +1,7 @@
+import{_ as s,W as n,X as t,Y as o,$ as a,a0 as i,a1 as c,D as p}from"./framework-46b0e263.js";const l={},d=a("h1",{id:"back-to-top",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#back-to-top","aria-hidden":"true"},"#"),i(" back-to-top")],-1),r=c(`
This plugin will add a back to top button to your site. The button will be displayed in the bottom right corner of the page when scrolling down. By clicking the button, the page will scroll to the top.
This plugin has been integrated into the default theme.
You can customize the style of the back to top button via CSS variables:
File not found
`,8);function u(h,k){const e=p("NpmBadge");return n(),t("div",null,[d,o(e,{package:"@vuepress/plugin-back-to-top"}),r])}const m=s(l,[["render",u],["__file","back-to-top.html.vue"]]);export{m as default};
diff --git a/assets/back-to-top.html-a351fd04.js b/assets/back-to-top.html-a351fd04.js
new file mode 100644
index 00000000..d3e490d7
--- /dev/null
+++ b/assets/back-to-top.html-a351fd04.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6474e88f","path":"/reference/plugin/back-to-top.html","title":"back-to-top","lang":"en-US","frontmatter":{"description":"This plugin will add a back to top button to your site. The button will be displayed in the bottom right corner of the page when scrolling down. By clicking the button, the page...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/back-to-top.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/back-to-top.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"back-to-top"}],["meta",{"property":"og:description","content":"This plugin will add a back to top button to your site. The button will be displayed in the bottom right corner of the page when scrolling down. By clicking the button, the page..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"back-to-top\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.36,"words":109},"filePathRelative":"reference/plugin/back-to-top.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/bundler.html-1e3cd6ec.js b/assets/bundler.html-1e3cd6ec.js
new file mode 100644
index 00000000..b7673abe
--- /dev/null
+++ b/assets/bundler.html-1e3cd6ec.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-75d28a04","path":"/zh/guide/bundler.html","title":"打包工具","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:boxes-packing","description":"VuePress 一直以来都在使用 Webpack (https://webpack.js.org/) 作为打包工具来进行网站的开发和构建。从 VuePress v2 开始，我们还支持使用其他的打包工具，并且现在使用 Vite (https://vitejs.dev/) 作为默认的打包工具。当然，你仍然可以选择使用 Webpack 。 选择一个打包工具...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/bundler.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/bundler.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"打包工具"}],["meta",{"property":"og:description","content":"VuePress 一直以来都在使用 Webpack (https://webpack.js.org/) 作为打包工具来进行网站的开发和构建。从 VuePress v2 开始，我们还支持使用其他的打包工具，并且现在使用 Vite (https://vitejs.dev/) 作为默认的打包工具。当然，你仍然可以选择使用 Webpack 。 选择一个打包工具..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"打包工具\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"选择一个打包工具","slug":"选择一个打包工具","link":"#选择一个打包工具","children":[]},{"level":2,"title":"配置打包工具","slug":"配置打包工具","link":"#配置打包工具","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.17,"words":350},"filePathRelative":"zh/guide/bundler.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/bundler.html-4a16a5de.js b/assets/bundler.html-4a16a5de.js
new file mode 100644
index 00000000..dca5da10
--- /dev/null
+++ b/assets/bundler.html-4a16a5de.js
@@ -0,0 +1,21 @@
+import{_ as u,W as d,X as v,$ as n,a0 as e,Y as s,Z as t,a1 as k,D as l}from"./framework-46b0e263.js";const b={},m=n("h1",{id:"打包工具",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#打包工具","aria-hidden":"true"},"#"),e(" 打包工具")],-1),h={href:"https://webpack.js.org/",target:"_blank",rel:"noopener noreferrer"},_={href:"https://vitejs.dev/",target:"_blank",rel:"noopener noreferrer"},f=n("h2",{id:"选择一个打包工具",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#选择一个打包工具","aria-hidden":"true"},"#"),e(" 选择一个打包工具")],-1),g={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},w={href:"https://www.npmjs.com/package/vuepress-webpack",target:"_blank",rel:"noopener noreferrer"},x=n("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[n("pre",{class:"language-bash"},[n("code",null,[n("span",{class:"token function"},"pnpm"),e(` uninstall vuepress
+`),n("span",{class:"token function"},"pnpm"),e(),n("span",{class:"token function"},"add"),e(),n("span",{class:"token parameter variable"},"-D"),e(` vuepress-webpack@next
+`)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),V=n("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[n("pre",{class:"language-bash"},[n("code",null,[n("span",{class:"token function"},"yarn"),e(` remove vuepress
+`),n("span",{class:"token function"},"yarn"),e(),n("span",{class:"token function"},"add"),e(),n("span",{class:"token parameter variable"},"-D"),e(` vuepress-webpack@next
+`)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),y=n("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[n("pre",{class:"language-bash"},[n("code",null,[n("span",{class:"token function"},"npm"),e(` uninstall vuepress
+`),n("span",{class:"token function"},"npm"),e(),n("span",{class:"token function"},"install"),e(),n("span",{class:"token parameter variable"},"-D"),e(` vuepress-webpack@next
+`)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),N={class:"hint-container tip"},j=n("p",{class:"hint-container-title"},"提示",-1),B={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},P={href:"https://www.npmjs.com/package/vuepress-vite",target:"_blank",rel:"noopener noreferrer"},C=n("h2",{id:"配置打包工具",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#配置打包工具","aria-hidden":"true"},"#"),e(" 配置打包工具")],-1),W=n("p",null,"一般情况下，你不要任何额外配置就可以使用打包工具，因为我们已经帮你配置好了它们。",-1),q=k(`
`,1);function A(D,E){const a=l("ExternalLinkIcon"),r=l("CodeTabs"),o=l("RouterLink");return d(),v("div",null,[m,n("p",null,[e("VuePress 一直以来都在使用 "),n("a",h,[e("Webpack"),s(a)]),e(" 作为打包工具来进行网站的开发和构建。从 VuePress v2 开始，我们还支持使用其他的打包工具，并且现在使用 "),n("a",_,[e("Vite"),s(a)]),e(" 作为默认的打包工具。当然，你仍然可以选择使用 Webpack 。")]),f,n("p",null,[e("在使用 "),n("a",g,[e("vuepress"),s(a)]),e(" 包时，会自动安装和使用 Vite 打包工具。")]),n("p",null,[e("如果你想改为使用 Webpack 打包工具，那么你可以移除它，改为安装 "),n("a",w,[e("vuepress-webpack"),s(a)]),e(" 包：")]),s(r,{id:"15",data:[{title:"PNPM"},{title:"YARN"},{title:"NPM"}],active:0,"tab-id":"shell"},{tab0:t(({title:p,value:c,isActive:i})=>[x]),tab1:t(({title:p,value:c,isActive:i})=>[V]),tab2:t(({title:p,value:c,isActive:i})=>[y]),_:1}),n("div",N,[j,n("p",null,[e("实际上， "),n("a",B,[e("vuepress"),s(a)]),e(" 包只是 "),n("a",P,[e("vuepress-vite"),s(a)]),e(" 包的一个封装而已。")])]),C,W,n("p",null,[e("通过 "),s(o,{to:"/zh/reference/config.html#bundler"},{default:t(()=>[e("bundler")]),_:1}),e(" 配置项，你可以对打包工具进行进阶配置：")]),q,n("p",null,[e("你可以参考 "),s(o,{to:"/zh/reference/bundler/vite.html"},{default:t(()=>[e("打包工具 > Vite")]),_:1}),e(" 和 "),s(o,{to:"/zh/reference/bundler/webpack.html"},{default:t(()=>[e("打包工具 > Webpack")]),_:1}),e(" 来查看对应打包工具的所有配置项。")])])}const z=u(b,[["render",A],["__file","bundler.html.vue"]]);export{z as default};
diff --git a/assets/bundler.html-f028d973.js b/assets/bundler.html-f028d973.js
new file mode 100644
index 00000000..f0a2692c
--- /dev/null
+++ b/assets/bundler.html-f028d973.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6f1f3595","path":"/guide/bundler.html","title":"Bundler","lang":"en-US","frontmatter":{"icon":"fa6-solid:boxes-packing","description":"VuePress has been using Webpack (https://webpack.js.org/) as the bundler to dev and build sites. Since VuePress v2, other bundlers are also supported, and now we are using Vite ...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/bundler.html"}],["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":"VuePress has been using Webpack (https://webpack.js.org/) as the bundler to dev and build sites. Since VuePress v2, other bundlers are also supported, and now we are using Vite ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Bundler\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Choose a Bundler","slug":"choose-a-bundler","link":"#choose-a-bundler","children":[]},{"level":2,"title":"Configure Bundler","slug":"configure-bundler","link":"#configure-bundler","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.82,"words":246},"filePathRelative":"guide/bundler.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/bundler.html-f9a502f3.js b/assets/bundler.html-f9a502f3.js
new file mode 100644
index 00000000..f9680426
--- /dev/null
+++ b/assets/bundler.html-f9a502f3.js
@@ -0,0 +1,21 @@
+import{_ as u,W as d,X as v,$ as e,a0 as n,Y as s,Z as t,a1 as b,D as r}from"./framework-46b0e263.js";const k={},h=e("h1",{id:"bundler",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bundler","aria-hidden":"true"},"#"),n(" Bundler")],-1),m={href:"https://webpack.js.org/",target:"_blank",rel:"noopener noreferrer"},_={href:"https://vitejs.dev/",target:"_blank",rel:"noopener noreferrer"},f=e("h2",{id:"choose-a-bundler",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#choose-a-bundler","aria-hidden":"true"},"#"),n(" Choose a Bundler")],-1),g={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},w={href:"https://www.npmjs.com/package/vuepress-webpack",target:"_blank",rel:"noopener noreferrer"},x=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"pnpm"),n(` remove vuepress
+`),e("span",{class:"token function"},"pnpm"),n(),e("span",{class:"token function"},"add"),n(),e("span",{class:"token parameter variable"},"-D"),n(` vuepress-webpack@next
+`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"}),e("div",{class:"line-number"})])],-1),y=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"yarn"),n(` remove vuepress
+`),e("span",{class:"token function"},"yarn"),n(),e("span",{class:"token function"},"add"),n(),e("span",{class:"token parameter variable"},"-D"),n(` vuepress-webpack@next
+`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"}),e("div",{class:"line-number"})])],-1),B=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"npm"),n(` uninstall vuepress
+`),e("span",{class:"token function"},"npm"),n(),e("span",{class:"token function"},"install"),n(),e("span",{class:"token parameter variable"},"-D"),n(` vuepress-webpack@next
+`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"}),e("div",{class:"line-number"})])],-1),V={class:"hint-container tip"},j=e("p",{class:"hint-container-title"},"Tips",-1),C={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},N={href:"https://www.npmjs.com/package/vuepress-vite",target:"_blank",rel:"noopener noreferrer"},P=e("h2",{id:"configure-bundler",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#configure-bundler","aria-hidden":"true"},"#"),n(" Configure Bundler")],-1),W=e("p",null,"Generally, you could use a bundler without extra configuration, because we have already configured them properly to work with VuePress.",-1),q=b(`
`,1);function A(D,E){const a=r("ExternalLinkIcon"),p=r("CodeTabs"),o=r("RouterLink");return d(),v("div",null,[h,e("p",null,[n("VuePress has been using "),e("a",m,[n("Webpack"),s(a)]),n(" as the bundler to dev and build sites. Since VuePress v2, other bundlers are also supported, and now we are using "),e("a",_,[n("Vite"),s(a)]),n(" as the default bundler. Of course, you can still choose to use Webpack.")]),f,e("p",null,[n("When using the "),e("a",g,[n("vuepress"),s(a)]),n(" package, Vite bundler is installed and used automatically.")]),e("p",null,[n("If you want to use Webpack bundler instead, you can remove it and install the "),e("a",w,[n("vuepress-webpack"),s(a)]),n(" package instead:")]),s(p,{id:"15",data:[{title:"PNPM"},{title:"YARN"},{title:"NPM"}],active:0,"tab-id":"shell"},{tab0:t(({title:l,value:c,isActive:i})=>[x]),tab1:t(({title:l,value:c,isActive:i})=>[y]),tab2:t(({title:l,value:c,isActive:i})=>[B]),_:1}),e("div",V,[j,e("p",null,[n("In fact, the "),e("a",C,[n("vuepress"),s(a)]),n(" package is just a wrapper of the "),e("a",N,[n("vuepress-vite"),s(a)]),n(" package.")])]),P,W,e("p",null,[n("You can configure bundler for advanced usage via the "),s(o,{to:"/reference/config.html#bundler"},{default:t(()=>[n("bundler")]),_:1}),n(" option:")]),q,e("p",null,[n("You can refer to "),s(o,{to:"/reference/bundler/vite.html"},{default:t(()=>[n("Bundlers > Vite")]),_:1}),n(" and "),s(o,{to:"/reference/bundler/webpack.html"},{default:t(()=>[n("Bundlers > Webpack")]),_:1}),n(" to check out all options of the corresponding bundler.")])])}const L=u(k,[["render",A],["__file","bundler.html.vue"]]);export{L as default};
diff --git a/assets/cli.html-13a56669.js b/assets/cli.html-13a56669.js
new file mode 100644
index 00000000..320044c2
--- /dev/null
+++ b/assets/cli.html-13a56669.js
@@ -0,0 +1,46 @@
+import{_ as p,W as o,X as c,Y as s,$ as a,a0 as e,Z as d,a1 as i,D as t}from"./framework-46b0e263.js";const u={},v=a("h1",{id:"命令行接口",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#命令行接口","aria-hidden":"true"},"#"),e(" 命令行接口")],-1),m={href:"https://www.npmjs.com/package/@vuepress/cli",target:"_blank",rel:"noopener noreferrer"},b={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},h=i(`
执行 vuepress --help 来获取下列帮助信息：
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
+
`,5);function x(D,S){const l=t("NpmBadge"),n=t("ExternalLinkIcon"),r=t("RouterLink");return o(),c("div",null,[v,s(l,{package:"@vuepress/cli"}),a("p",null,[e("VuePress 命令行接口是由 "),a("a",m,[e("@vuepress/cli"),s(n)]),e(" 包提供的。它包含在 "),a("a",b,[e("vuepress"),s(n)]),e(" 包之中，当然你也可以单独安装它。")]),h,a("div",k,[f,a("p",null,[e("VuePress 使用了 "),a("a",g,[e("debug"),s(n)]),e(" 模块。")]),_]),y,a("p",null,[e("将你的 VuePress 站点构建成静态文件，以便你进行后续"),s(r,{to:"/zh/guide/deployment.html"},{default:d(()=>[e("部署")]),_:1}),e("。")]),w])}const B=p(u,[["render",x],["__file","cli.html.vue"]]);export{B as default};
diff --git a/assets/cli.html-2761a139.js b/assets/cli.html-2761a139.js
new file mode 100644
index 00000000..c33fc973
--- /dev/null
+++ b/assets/cli.html-2761a139.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-a951be94","path":"/reference/cli.html","title":"Command Line Interface","lang":"en-US","frontmatter":{"icon":"bi:terminal-fill","description":"VuePress CLI is provided by @vuepress/cli (https://www.npmjs.com/package/@vuepress/cli) package. It is included by the vuepress (https://www.npmjs.com/package/vuepress) package,...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/cli.html"}],["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":"VuePress CLI is provided by @vuepress/cli (https://www.npmjs.com/package/@vuepress/cli) package. It is included by the vuepress (https://www.npmjs.com/package/vuepress) package,..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Command Line Interface\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"dev","slug":"dev","link":"#dev","children":[]},{"level":2,"title":"build","slug":"build","link":"#build","children":[]},{"level":2,"title":"info","slug":"info","link":"#info","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.24,"words":373},"filePathRelative":"reference/cli.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/cli.html-cfbcbfaf.js b/assets/cli.html-cfbcbfaf.js
new file mode 100644
index 00000000..3d994fd2
--- /dev/null
+++ b/assets/cli.html-cfbcbfaf.js
@@ -0,0 +1,46 @@
+import{_ as o,W as p,X as c,Y as n,$ as a,a0 as e,Z as d,a1 as i,D as t}from"./framework-46b0e263.js";const u={},v=a("h1",{id:"command-line-interface",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#command-line-interface","aria-hidden":"true"},"#"),e(" Command Line Interface")],-1),m={href:"https://www.npmjs.com/package/@vuepress/cli",target:"_blank",rel:"noopener noreferrer"},b={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},h=i(`
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
+
`,2),k={class:"hint-container tip"},f=a("p",{class:"hint-container-title"},"Tips",-1),g={href:"https://www.npmjs.com/package/debug",target:"_blank",rel:"noopener noreferrer"},_=a("p",null,[e("Set environment variable "),a("code",null,"DEBUG=vuepress*"),e(" to enable debug logs.")],-1),y=i(`
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.
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);function x(D,C){const l=t("NpmBadge"),s=t("ExternalLinkIcon"),r=t("RouterLink");return p(),c("div",null,[v,n(l,{package:"@vuepress/cli"}),a("p",null,[e("VuePress CLI is provided by "),a("a",m,[e("@vuepress/cli"),n(s)]),e(" package. It is included by the "),a("a",b,[e("vuepress"),n(s)]),e(" package, and you can also install it separately.")]),h,a("div",k,[f,a("p",null,[e("VuePress is using "),a("a",g,[e("debug"),n(s)]),e(" module.")]),_]),y,a("p",null,[e("Build your VuePress site to static files, which are ready for "),n(r,{to:"/guide/deployment.html"},{default:d(()=>[e("deployment")]),_:1}),e(".")]),w])}const B=o(u,[["render",x],["__file","cli.html.vue"]]);export{B as default};
diff --git a/assets/cli.html-e7d4e52b.js b/assets/cli.html-e7d4e52b.js
new file mode 100644
index 00000000..4dd749ac
--- /dev/null
+++ b/assets/cli.html-e7d4e52b.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-9beb15b6","path":"/zh/reference/cli.html","title":"命令行接口","lang":"zh-CN","frontmatter":{"icon":"bi:terminal-fill","description":"VuePress 命令行接口是由 @vuepress/cli (https://www.npmjs.com/package/@vuepress/cli) 包提供的。它包含在 vuepress (https://www.npmjs.com/package/vuepress) 包之中，当然你也可以单独安装它。 执行 vuepress --help 来获取下...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/cli.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/cli.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"命令行接口"}],["meta",{"property":"og:description","content":"VuePress 命令行接口是由 @vuepress/cli (https://www.npmjs.com/package/@vuepress/cli) 包提供的。它包含在 vuepress (https://www.npmjs.com/package/vuepress) 包之中，当然你也可以单独安装它。 执行 vuepress --help 来获取下..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"命令行接口\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"dev","slug":"dev","link":"#dev","children":[]},{"level":2,"title":"build","slug":"build","link":"#build","children":[]},{"level":2,"title":"info","slug":"info","link":"#info","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.51,"words":453},"filePathRelative":"zh/reference/cli.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/client-api.html-787be4ae.js b/assets/client-api.html-787be4ae.js
new file mode 100644
index 00000000..1e05661a
--- /dev/null
+++ b/assets/client-api.html-787be4ae.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-a84e51b8","path":"/reference/client-api.html","title":"Client API","lang":"en-US","frontmatter":{"icon":"fa6-brands:chrome","description":"Client API is provided by @vuepress/client (https://www.npmjs.com/package/@vuepress/client) package, which is used for developing client files. Composition API usePageData Detai...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/client-api.html"}],["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 is provided by @vuepress/client (https://www.npmjs.com/package/@vuepress/client) package, which is used for developing client files. Composition API usePageData Detai..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Client API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Composition API","slug":"composition-api","link":"#composition-api","children":[{"level":3,"title":"usePageData","slug":"usepagedata","link":"#usepagedata","children":[]},{"level":3,"title":"usePageFrontmatter","slug":"usepagefrontmatter","link":"#usepagefrontmatter","children":[]},{"level":3,"title":"usePageHead","slug":"usepagehead","link":"#usepagehead","children":[]},{"level":3,"title":"usePageHeadTitle","slug":"usepageheadtitle","link":"#usepageheadtitle","children":[]},{"level":3,"title":"usePageLang","slug":"usepagelang","link":"#usepagelang","children":[]},{"level":3,"title":"useRouteLocale","slug":"useroutelocale","link":"#useroutelocale","children":[]},{"level":3,"title":"useSiteData","slug":"usesitedata","link":"#usesitedata","children":[]},{"level":3,"title":"useSiteLocaleData","slug":"usesitelocaledata","link":"#usesitelocaledata","children":[]}]},{"level":2,"title":"Helpers","slug":"helpers","link":"#helpers","children":[{"level":3,"title":"defineClientConfig","slug":"defineclientconfig","link":"#defineclientconfig","children":[]},{"level":3,"title":"withBase","slug":"withbase","link":"#withbase","children":[]}]},{"level":2,"title":"Constants","slug":"constants","link":"#constants","children":[{"level":3,"title":"__VUEPRESS_VERSION__","slug":"vuepress-version","link":"#vuepress-version","children":[]},{"level":3,"title":"__VUEPRESS_BASE__","slug":"vuepress-base","link":"#vuepress-base","children":[]},{"level":3,"title":"__VUEPRESS_DEV__","slug":"vuepress-dev","link":"#vuepress-dev","children":[]},{"level":3,"title":"__VUEPRESS_SSR__","slug":"vuepress-ssr","link":"#vuepress-ssr","children":[]}]},{"level":2,"title":"Advanced","slug":"advanced","link":"#advanced","children":[{"level":3,"title":"resolvers","slug":"resolvers","link":"#resolvers","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.42,"words":425},"filePathRelative":"reference/client-api.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/client-api.html-79f0beda.js b/assets/client-api.html-79f0beda.js
new file mode 100644
index 00000000..5567b5bf
--- /dev/null
+++ b/assets/client-api.html-79f0beda.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-332177d5","path":"/zh/reference/client-api.html","title":"客户端 API","lang":"zh-CN","frontmatter":{"icon":"fa6-brands:chrome","description":"客户端 API 是由 @vuepress/client (https://www.npmjs.com/package/@vuepress/client) Package 提供的，用于开发客户端文件。 Composition API usePageData 详情：; 返回当前页面数据的 Ref 对象。 参考：; Node API > Page 属性 > ...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/client-api.html"}],["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 是由 @vuepress/client (https://www.npmjs.com/package/@vuepress/client) Package 提供的，用于开发客户端文件。 Composition API usePageData 详情：; 返回当前页面数据的 Ref 对象。 参考：; Node API > Page 属性 > ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"客户端 API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Composition API","slug":"composition-api","link":"#composition-api","children":[{"level":3,"title":"usePageData","slug":"usepagedata","link":"#usepagedata","children":[]},{"level":3,"title":"usePageFrontmatter","slug":"usepagefrontmatter","link":"#usepagefrontmatter","children":[]},{"level":3,"title":"usePageHead","slug":"usepagehead","link":"#usepagehead","children":[]},{"level":3,"title":"usePageHeadTitle","slug":"usepageheadtitle","link":"#usepageheadtitle","children":[]},{"level":3,"title":"usePageLang","slug":"usepagelang","link":"#usepagelang","children":[]},{"level":3,"title":"useRouteLocale","slug":"useroutelocale","link":"#useroutelocale","children":[]},{"level":3,"title":"useSiteData","slug":"usesitedata","link":"#usesitedata","children":[]},{"level":3,"title":"useSiteLocaleData","slug":"usesitelocaledata","link":"#usesitelocaledata","children":[]}]},{"level":2,"title":"工具函数","slug":"工具函数","link":"#工具函数","children":[{"level":3,"title":"defineClientConfig","slug":"defineclientconfig","link":"#defineclientconfig","children":[]},{"level":3,"title":"withBase","slug":"withbase","link":"#withbase","children":[]}]},{"level":2,"title":"常量","slug":"常量","link":"#常量","children":[{"level":3,"title":"__VUEPRESS_VERSION__","slug":"vuepress-version","link":"#vuepress-version","children":[]},{"level":3,"title":"__VUEPRESS_BASE__","slug":"vuepress-base","link":"#vuepress-base","children":[]},{"level":3,"title":"__VUEPRESS_DEV__","slug":"vuepress-dev","link":"#vuepress-dev","children":[]},{"level":3,"title":"__VUEPRESS_SSR__","slug":"vuepress-ssr","link":"#vuepress-ssr","children":[]}]},{"level":2,"title":"进阶能力","slug":"进阶能力","link":"#进阶能力","children":[{"level":3,"title":"resolvers","slug":"resolvers","link":"#resolvers","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.07,"words":620},"filePathRelative":"zh/reference/client-api.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/client-api.html-9d516b34.js b/assets/client-api.html-9d516b34.js
new file mode 100644
index 00000000..8bf1367a
--- /dev/null
+++ b/assets/client-api.html-9d516b34.js
@@ -0,0 +1,14 @@
+import{_ as r,W as u,X as d,Y as a,$ as e,a0 as n,Z as s,a1 as i,D as o}from"./framework-46b0e263.js";const h={},f=e("h1",{id:"client-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#client-api","aria-hidden":"true"},"#"),n(" Client API")],-1),g={href:"https://www.npmjs.com/package/@vuepress/client",target:"_blank",rel:"noopener noreferrer"},_=e("h2",{id:"composition-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#composition-api","aria-hidden":"true"},"#"),n(" Composition API")],-1),v=e("h3",{id:"usepagedata",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagedata","aria-hidden":"true"},"#"),n(" usePageData")],-1),k=e("li",null,[e("p",null,"Details:"),e("p",null,"Returns the page data ref object of current page.")],-1),m=e("p",null,"Also see:",-1),b=e("h3",{id:"usepagefrontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagefrontmatter","aria-hidden":"true"},"#"),n(" usePageFrontmatter")],-1),x=e("ul",null,[e("li",null,[e("p",null,"Details:"),e("p",null,"Returns the frontmatter ref object of current page."),e("p",null,[n("The value is the "),e("code",null,"frontmatter"),n(" property of the page data.")])])],-1),y=e("h3",{id:"usepagehead",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagehead","aria-hidden":"true"},"#"),n(" usePageHead")],-1),P=e("p",null,"Details:",-1),w=e("p",null,"Returns the head config ref object of current page.",-1),D=i('
resolvers will affect the basic functionality of VuePress. Please make sure you have fully understood its purpose before modifying it.
`,4);function F($,O){const l=o("NpmBadge"),p=o("ExternalLinkIcon"),t=o("RouterLink"),c=o("Badge");return u(),d("div",null,[f,a(l,{package:"@vuepress/client"}),e("p",null,[n("Client API is provided by "),e("a",g,[n("@vuepress/client"),a(p)]),n(" package, which is used for developing client files.")]),_,v,e("ul",null,[k,e("li",null,[m,e("ul",null,[e("li",null,[a(t,{to:"/reference/node-api.html#data"},{default:s(()=>[n("Node API > Page Properties > data")]),_:1})]),e("li",null,[a(t,{to:"/reference/plugin-api.html#extendspage"},{default:s(()=>[n("Plugin API > extendsPage")]),_:1})])])])]),b,x,y,e("ul",null,[e("li",null,[P,w,e("p",null,[n("The value is obtained by merging and deduplicating "),a(t,{to:"/reference/frontmatter.html#head"},{default:s(()=>[n("head")]),_:1}),n(" frontmatter and "),a(t,{to:"/reference/config.html#head"},{default:s(()=>[n("head")]),_:1}),n(" config.")])])]),D,e("ul",null,[e("li",null,[R,C,e("p",null,[n("The value is one of the keys of the "),a(t,{to:"/reference/config.html#locales"},{default:s(()=>[n("locales")]),_:1}),n(" config.")])])]),S,e("ul",null,[e("li",null,[T,e("p",null,[n("Helper for creating "),a(t,{to:"/reference/plugin-api.html#clientconfigfile"},{default:s(()=>[n("clientConfigFile")]),_:1}),n(".")])]),e("li",null,[A,e("ul",null,[e("li",null,[a(t,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:s(()=>[n("Advanced > Cookbook > Usage of Client Config")]),_:1})])])])]),j,e("ul",null,[e("li",null,[E,e("p",null,[n("Prefix URL with site "),a(t,{to:"/reference/config.html#base"},{default:s(()=>[n("base")]),_:1}),n(".")])]),e("li",null,[V,e("ul",null,[e("li",null,[a(t,{to:"/guide/assets.html#base-helper"},{default:s(()=>[n("Guide > Assets > Base Helper")]),_:1})])])])]),B,e("ul",null,[L,e("li",null,[q,e("p",null,[n("The "),a(t,{to:"/reference/config.html#base"},{default:s(()=>[n("base")]),_:1}),n(" option from config.")])])]),I,e("h3",N,[H,n(" resolvers "),a(c,{text:"experimental"})]),U])}const z=r(h,[["render",F],["__file","client-api.html.vue"]]);export{z as default};
diff --git a/assets/client-api.html-e1254874.js b/assets/client-api.html-e1254874.js
new file mode 100644
index 00000000..a9d0beeb
--- /dev/null
+++ b/assets/client-api.html-e1254874.js
@@ -0,0 +1,14 @@
+import{_ as u,W as d,X as r,Y as a,$ as e,a0 as n,Z as t,a1 as l,D as o}from"./framework-46b0e263.js";const h={},_=e("h1",{id:"客户端-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#客户端-api","aria-hidden":"true"},"#"),n(" 客户端 API")],-1),f={href:"https://www.npmjs.com/package/@vuepress/client",target:"_blank",rel:"noopener noreferrer"},k=e("h2",{id:"composition-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#composition-api","aria-hidden":"true"},"#"),n(" Composition API")],-1),g=e("h3",{id:"usepagedata",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagedata","aria-hidden":"true"},"#"),n(" usePageData")],-1),v=e("li",null,[e("p",null,"详情："),e("p",null,"返回当前页面数据的 Ref 对象。")],-1),m=e("p",null,"参考：",-1),b=e("h3",{id:"usepagefrontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagefrontmatter","aria-hidden":"true"},"#"),n(" usePageFrontmatter")],-1),x=e("ul",null,[e("li",null,[e("p",null,"详情："),e("p",null,"返回当前页面 Frontmatter 的 Ref 对象。"),e("p",null,[n("它的值是页面数据的 "),e("code",null,"frontmatter"),n(" 属性。")])])],-1),P=e("h3",{id:"usepagehead",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagehead","aria-hidden":"true"},"#"),n(" usePageHead")],-1),R=e("p",null,"详情：",-1),S=e("p",null,"返回当前页面 Head 配置的 Ref 对象。",-1),w=l('
`,7),x=n("div",{class:"language-bash","data-ext":"sh"},[n("pre",{class:"language-bash"},[n("code",null,[n("span",{class:"token function"},"pnpm"),a(),n("span",{class:"token function"},"install"),a(`
+`)])])],-1),C=n("div",{class:"language-bash","data-ext":"sh"},[n("pre",{class:"language-bash"},[n("code",null,[n("span",{class:"token function"},"yarn"),a(),n("span",{class:"token function"},"install"),a(`
+`)])])],-1),y=n("div",{class:"language-bash","data-ext":"sh"},[n("pre",{class:"language-bash"},[n("code",null,[n("span",{class:"token function"},"npm"),a(),n("span",{class:"token function"},"install"),a(`
+`)])])],-1),w={class:"hint-container warning"},P=n("p",{class:"hint-container-title"},"Note",-1),G=n("p",null,[a("You must add an empty line between the starting tag of "),n("code",null,""),a(" and the code fence, otherwise the code fence will not be parsed correctly by Markdown.")],-1),N=n("p",null,"All content must be valid Markdown first, and then a Vue SFC.",-1);function B(V,I){const d=o("NpmBadge"),e=o("Badge"),r=o("CodeTabs"),p=o("RouterLink");return m(),v("div",null,[b,s(d,{package:"@vuepress/theme-default"}),n("h2",h,[_,a(" Badge "),s(e,{text:"badge"})]),f,n("ul",null,[n("li",null,[a("VuePress - "),s(e,{type:"tip",text:"v2",vertical:"top"})]),n("li",null,[a("VuePress - "),s(e,{type:"warning",text:"v2",vertical:"middle"})]),n("li",null,[a("VuePress - "),s(e,{type:"danger",text:"v2",vertical:"bottom"})])]),q,s(r,{id:"179",data:[{title:"PNPM"},{title:"YARN"},{title:"NPM"}],active:2},{tab0:t(({title:l,value:c,isActive:i})=>[x]),tab1:t(({title:l,value:c,isActive:i})=>[C]),tab2:t(({title:l,value:c,isActive:i})=>[y]),_:1}),n("div",w,[P,G,N,n("p",null,[a("Learn more: "),s(p,{to:"/advanced/cookbook/markdown-and-vue-sfc.html"},{default:t(()=>[a("Cookbook > Markdown and Vue SFC")]),_:1})]),n("p",null,[a("Alternatively, you can use the "),s(p,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:t(()=>[a("custom containers")]),_:1}),a(".")])])])}const A=k(g,[["render",B],["__file","components.html.vue"]]);export{A as default};
diff --git a/assets/components.html-45ddf801.js b/assets/components.html-45ddf801.js
new file mode 100644
index 00000000..ca4a0757
--- /dev/null
+++ b/assets/components.html-45ddf801.js
@@ -0,0 +1,5 @@
+import{_ as i,W as c,X as p,Y as a,$ as n,a0 as e,Z as r,a1 as d,D as t}from"./framework-46b0e263.js";const u={},h=n("h1",{id:"built-in-components",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#built-in-components","aria-hidden":"true"},"#"),e(" Built-in Components")],-1),m=d(`
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.
`,7),g=n("p",null,"Details:",-1),k=n("p",null,"This component will render the Markdown content of a page.",-1),_={href:"https://router.vuejs.org/api/#name-2",target:"_blank",rel:"noopener noreferrer"},v=n("code",null,"pageKey",-1),f=n("p",null,"This component is mainly for developing themes. You won't need it in most cases.",-1),y=n("p",null,"Also see:",-1);function b(x,w){const s=t("NpmBadge"),o=t("ExternalLinkIcon"),l=t("RouterLink");return c(),p("div",null,[h,a(s,{package:"@vuepress/client"}),m,n("ul",null,[n("li",null,[g,k,n("p",null,[e("The page key is the "),n("a",_,[e("name"),a(o)]),e(" of the page route. If the "),v,e(" prop is not provided, it will render the page of current route.")]),f]),n("li",null,[y,n("ul",null,[n("li",null,[a(l,{to:"/reference/node-api.html#key"},{default:r(()=>[e("Node API > Page Properties > key")]),_:1})])])])])])}const B=i(u,[["render",b],["__file","components.html.vue"]]);export{B as default};
diff --git a/assets/components.html-478c036d.js b/assets/components.html-478c036d.js
new file mode 100644
index 00000000..e3341d8b
--- /dev/null
+++ b/assets/components.html-478c036d.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-55453034","path":"/reference/components.html","title":"Built-in Components","lang":"en-US","frontmatter":{"icon":"fa6-solid:puzzle-piece","description":"ClientOnly Usage:; Details:; 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...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/components.html"}],["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":"ClientOnly Usage:; Details:; 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..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Built-in Components\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"ClientOnly","slug":"clientonly","link":"#clientonly","children":[]},{"level":2,"title":"Content","slug":"content","link":"#content","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.6,"words":180},"filePathRelative":"reference/components.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/components.html-47cc2388.js b/assets/components.html-47cc2388.js
new file mode 100644
index 00000000..f09f722f
--- /dev/null
+++ b/assets/components.html-47cc2388.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-551922c5","path":"/zh/reference/default-theme/components.html","title":"内置组件","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:puzzle-piece","description":"Badge Props:; type; 类型： 'tip' 'warning' 'danger'; 默认值： 'tip'; text; 类型： string; 默认值： ''; vertical; 类型： 'top' 'middle' 'bottom' | undefined; 默认值： undefined; 示例：; 输入 输出 VuePress -...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/default-theme/components.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/default-theme/components.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"内置组件"}],["meta",{"property":"og:description","content":"Badge Props:; type; 类型： 'tip' 'warning' 'danger'; 默认值： 'tip'; text; 类型： string; 默认值： ''; vertical; 类型： 'top' 'middle' 'bottom' | undefined; 默认值： undefined; 示例：; 输入 输出 VuePress -..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"内置组件\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Badge","slug":"badge","link":"#badge","children":[]},{"level":2,"title":"CodeGroup","slug":"codegroup","link":"#codegroup","children":[]},{"level":2,"title":"CodeGroupItem","slug":"codegroupitem","link":"#codegroupitem","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.13,"words":340},"filePathRelative":"zh/reference/default-theme/components.md","localizedDate":"2023年2月22日","autoDesc":true}`);export{e as data};
diff --git a/assets/components.html-6dbfa22c.js b/assets/components.html-6dbfa22c.js
new file mode 100644
index 00000000..b1354a4a
--- /dev/null
+++ b/assets/components.html-6dbfa22c.js
@@ -0,0 +1,32 @@
+import{_ as k,W as v,X as g,Y as s,$ as n,a0 as a,Z as t,a1 as i,D as o}from"./framework-46b0e263.js";const m={},b=n("h1",{id:"内置组件",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#内置组件","aria-hidden":"true"},"#"),a(" 内置组件")],-1),h={id:"badge",tabindex:"-1"},_=n("a",{class:"header-anchor",href:"#badge","aria-hidden":"true"},"#",-1),q=i(`
",2),Fn=n("p",null,"参考：",-1),Hn=n("h3",{id:"themeplugins-externallinkicon",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-externallinkicon","aria-hidden":"true"},"#"),s(" themePlugins.externalLinkIcon")],-1),jn=n("li",null,[n("p",null,[s("类型： "),n("code",null,"boolean")])],-1),Zn=n("li",null,[n("p",null,[s("默认值： "),n("code",null,"true")])],-1),Kn=n("p",null,"详情：",-1),On=n("h3",{id:"themeplugins-git",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-git","aria-hidden":"true"},"#"),s(" themePlugins.git")],-1),Xn=n("li",null,[n("p",null,[s("类型： "),n("code",null,"boolean")])],-1),Yn=n("li",null,[n("p",null,[s("默认值： "),n("code",null,"true")])],-1),$n=n("p",null,"详情：",-1),Jn=n("h3",{id:"themeplugins-mediumzoom",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-mediumzoom","aria-hidden":"true"},"#"),s(" themePlugins.mediumZoom")],-1),Qn=n("li",null,[n("p",null,[s("类型： "),n("code",null,"boolean")])],-1),ns=n("li",null,[n("p",null,[s("默认值： "),n("code",null,"true")])],-1),ss=n("p",null,"详情：",-1),as=n("h3",{id:"themeplugins-nprogress",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-nprogress","aria-hidden":"true"},"#"),s(" themePlugins.nprogress")],-1),es=n("li",null,[n("p",null,[s("类型： "),n("code",null,"boolean")])],-1),ts=n("li",null,[n("p",null,[s("默认值： "),n("code",null,"true")])],-1),ls=n("p",null,"详情：",-1);function os(is,ps){const i=o("NpmBadge"),e=o("RouterLink"),p=o("ExternalLinkIcon");return u(),d("div",null,[h,a(i,{package:"@vuepress/theme-default"}),k,n("ul",null,[m,v,n("li",null,[b,g,_,n("p",null,[s("该配置项仅能在默认主题内生效，注意不要和 "),a(e,{to:"/zh/reference/config.html#locales"},{default:t(()=>[s("站点配置")]),_:1}),s(" 中的 "),f,s(" 混淆。")])]),n("li",null,[x,n("ul",null,[n("li",null,[a(e,{to:"/zh/guide/i18n.html"},{default:t(()=>[s("指南 > 多语言支持")]),_:1})])])])]),q,n("ul",null,[y,w,n("li",null,[E,L,n("p",null,[s("如果设置为 "),A,s(" ，则会根据 "),n("a",z,[s("prefers-color-scheme"),a(p)]),s(" 自动设置初始颜色模式。")])]),N]),T,n("ul",null,[n("li",null,[s("参考： "),n("ul",null,[n("li",null,[a(e,{to:"/zh/guide/assets.html#public-%E6%96%87%E4%BB%B6"},{default:t(()=>[s("指南 > 静态资源 > Public 文件")]),_:1})])])])]),B,n("ul",null,[R,n("li",null,[I,P,n("p",null,[s("如果你在站点配置中设置了多个 "),a(e,{to:"/zh/reference/config.html#locales"},{default:t(()=>[s("locales")]),_:1}),s(" ，那么 "),G,s(" 就会显示在导航栏中仓库按钮的旁边。")])])]),D,n("ul",null,[S,M,n("li",null,[U,C,n("p",null,[s("你可以通过页面的 "),a(e,{to:"/zh/reference/default-theme/frontmatter.html#sidebar"},{default:t(()=>[s("sidebar")]),_:1}),s(" frontmatter 来覆盖这个全局配置。")]),V]),W]),F,n("ul",null,[H,j,n("li",null,[Z,n("p",null,[s("最大值取决于你通过 "),a(e,{to:"/zh/reference/config.html#markdown-headers"},{default:t(()=>[s("markdown.headers.level")]),_:1}),s(" 提取了哪些级别的标题。")]),K,n("p",null,[s("你可以通过页面的 "),a(e,{to:"/zh/reference/default-theme/frontmatter.html#sidebardepth"},{default:t(()=>[s("sidebarDepth")]),_:1}),s(" frontmatter 来覆盖这个全局配置。")])])]),O,n("ul",null,[X,Y,n("li",null,[$,J,n("p",null,[s("你可以通过页面的 "),a(e,{to:"/zh/reference/default-theme/frontmatter.html#editlink"},{default:t(()=>[s("editLink")]),_:1}),s(" frontmatter 来覆盖这个全局配置。")])])]),Q,n("ul",null,[nn,sn,n("li",null,[an,en,n("p",null,[s("你可以通过页面的 "),a(e,{to:"/zh/reference/default-theme/frontmatter.html#lastupdated"},{default:t(()=>[s("lastUpdated")]),_:1}),s(" frontmatter 来覆盖这个全局配置。要注意的是，如果你已经将该选项设为了 "),tn,s(" ，那么这个功能会被完全禁用，并且无法在 locales 或页面 frontmatter 中启用。")])])]),ln,n("ul",null,[on,pn,n("li",null,[cn,un,n("p",null,[s("你可以通过页面的 "),a(e,{to:"/zh/reference/default-theme/frontmatter.html#contributors"},{default:t(()=>[s("contributors")]),_:1}),s(" frontmatter 来覆盖这个全局配置。要注意的是，如果你已经将该选项设为了 "),dn,s(" ，那么这个功能会被完全禁用，并且无法在 locales 或页面 frontmatter 中启用。")])])]),rn,n("ul",null,[hn,kn,n("li",null,[mn,n("p",null,[s("Tip "),a(e,{to:"/zh/reference/default-theme/markdown.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%B9%E5%99%A8"},{default:t(()=>[s("自定义容器")]),_:1}),s(" 的默认标题。")])])]),vn,n("ul",null,[bn,gn,n("li",null,[_n,n("p",null,[s("Warning "),a(e,{to:"/zh/reference/default-theme/markdown.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%B9%E5%99%A8"},{default:t(()=>[s("自定义容器")]),_:1}),s(" 的默认标题。")])])]),fn,n("ul",null,[xn,qn,n("li",null,[yn,n("p",null,[s("Danger "),a(e,{to:"/zh/reference/default-theme/markdown.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%B9%E5%99%A8"},{default:t(()=>[s("自定义容器")]),_:1}),s(" 的默认标题。")])])]),wn,n("ul",null,[En,Ln,n("li",null,[An,n("p",null,[a(e,{to:"/zh/reference/plugin/external-link-icon.html#externallinkicon"},{default:t(()=>[s("ExternalLinkIcon")]),_:1}),s(". 链接内的 "),zn,s(" 文字。")]),Nn]),Tn]),Bn,n("ul",null,[Rn,In,n("li",null,[Pn,n("p",null,[s("是否启用 "),a(e,{to:"/zh/reference/plugin/active-header-links.html"},{default:t(()=>[s("@vuepress/plugin-active-header-links")]),_:1}),s(" 。")])])]),Gn,n("ul",null,[Dn,Sn,n("li",null,[Mn,n("p",null,[s("是否启用 "),a(e,{to:"/zh/reference/plugin/back-to-top.html"},{default:t(()=>[s("@vuepress/plugin-back-to-top")]),_:1}),s(" 。")])])]),Un,n("ul",null,[Cn,n("li",null,[Vn,n("p",null,[s("是否启用由 "),a(e,{to:"/zh/reference/plugin/container.html"},{default:t(()=>[s("@vuepress/plugin-container")]),_:1}),s(" 支持的自定义容器。")]),Wn]),n("li",null,[Fn,n("ul",null,[n("li",null,[a(e,{to:"/zh/reference/default-theme/markdown.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%B9%E5%99%A8"},{default:t(()=>[s("默认主题 > Markdown > 自定义容器")]),_:1})])])])]),Hn,n("ul",null,[jn,Zn,n("li",null,[Kn,n("p",null,[s("是否启用 "),a(e,{to:"/zh/reference/plugin/external-link-icon.html"},{default:t(()=>[s("@vuepress/plugin-external-link-icon")]),_:1}),s(" 。")])])]),On,n("ul",null,[Xn,Yn,n("li",null,[$n,n("p",null,[s("是否启用 "),a(e,{to:"/zh/reference/plugin/git.html"},{default:t(()=>[s("@vuepress/plugin-git")]),_:1}),s(" 。")])])]),Jn,n("ul",null,[Qn,ns,n("li",null,[ss,n("p",null,[s("是否启用 "),a(e,{to:"/zh/reference/plugin/medium-zoom.html"},{default:t(()=>[s("@vuepress/plugin-medium-zoom")]),_:1}),s(" 。")])])]),as,n("ul",null,[es,ts,n("li",null,[ls,n("p",null,[s("是否启用 "),a(e,{to:"/zh/reference/plugin/nprogress.html"},{default:t(()=>[s("@vuepress/plugin-nprogress")]),_:1}),s(" 。")])])])])}const us=c(r,[["render",os],["__file","config.html.vue"]]);export{us as default};
diff --git a/assets/config.html-58974c3b.js b/assets/config.html-58974c3b.js
new file mode 100644
index 00000000..521731f0
--- /dev/null
+++ b/assets/config.html-58974c3b.js
@@ -0,0 +1,22 @@
+import{_ as r,W as p,X as u,Y as l,$ as e,Z as a,a0 as n,a1 as o,D as s}from"./framework-46b0e263.js";const c={},h=e("h1",{id:"config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#config","aria-hidden":"true"},"#"),n(" Config")],-1),f=e("h2",{id:"site-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#site-config","aria-hidden":"true"},"#"),n(" Site Config")],-1),m=e("h3",{id:"base",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#base","aria-hidden":"true"},"#"),n(" base")],-1),g=o("
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. 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 all the URLs that start with / in other options, so you only need to specify it once.
Notice that base should be an absolute URL pathname starting and ending with / .
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),q=e("p",null,"Also see:",-1),L=e("h2",{id:"theme-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme-config","aria-hidden":"true"},"#"),n(" Theme Config")],-1),O=e("h3",{id:"theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme","aria-hidden":"true"},"#"),n(" theme")],-1),B=e("li",null,[e("p",null,[n("Type: "),e("code",null,"Theme")])],-1),E=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),G=e("p",null,"Also see:",-1),M=e("h2",{id:"bundler-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bundler-config","aria-hidden":"true"},"#"),n(" Bundler Config")],-1),I=e("h3",{id:"bundler",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bundler","aria-hidden":"true"},"#"),n(" bundler")],-1),N=o("
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),V=e("li",null,[e("p",null,[n("Type: "),e("code",null,"string")])],-1),W=e("li",null,[e("p",null,[n("Default: "),e("code",null,"`${sourceDir}/.vuepress/public`")])],-1),R=e("li",null,[e("p",null,"Details:"),e("p",null,"Specify the directory for public files.")],-1),F=e("p",null,"Also see:",-1),Y=e("h3",{id:"debug",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#debug","aria-hidden":"true"},"#"),n(" debug")],-1),U=e("li",null,[e("p",null,[n("Type: "),e("code",null,"boolean")])],-1),$=e("li",null,[e("p",null,[n("Default: "),e("code",null,"false")])],-1),X=e("p",null,"Details:",-1),Z=e("p",null,"Enable debug mode or not.",-1),z={href:"https://github.com/visionmedia/debug",target:"_blank",rel:"noopener noreferrer"},J=e("code",null,"DEBUG=vuepress*",-1),K=o('
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),pe=e("p",null,"Details:",-1),ue={href:"https://github.com/valeriangalliat/markdown-it-anchor",target:"_blank",rel:"noopener noreferrer"},ce=e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")],-1),he=e("p",null,"Also see:",-1),fe=o('
',4),me=e("li",null,[e("p",null,[n("Type: "),e("code",null,"CodePluginOptions | false")])],-1),ge=e("li",null,[e("p",null,"Details:"),e("p",null,"Options for VuePress built-in markdown-it code plugin."),e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")])],-1),_e=e("p",null,"Also see:",-1),ke=e("h4",{id:"markdown-code-highlightlines",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-code-highlightlines","aria-hidden":"true"},"#"),n(" markdown.code.highlightLines")],-1),be=e("li",null,[e("p",null,[n("Type: "),e("code",null,"boolean")])],-1),we=e("li",null,[e("p",null,[n("Default: "),e("code",null,"true")])],-1),ve=e("li",null,[e("p",null,"Details:"),e("p",null,"Enable code line highlighting or not.")],-1),ye=e("p",null,"Also see:",-1),xe=e("h4",{id:"markdown-code-linenumbers",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-code-linenumbers","aria-hidden":"true"},"#"),n(" markdown.code.lineNumbers")],-1),De=o("
Type: boolean | number
Default: true
Details:
Configure code line numbers.
A boolean value is to enable line numbers or not.
A number value is the minimum number of lines to enable line numbers. For example, if you set it to 4, line numbers will only be enabled when your code block has at least 4 lines of code.
The wrapper is required by the highlightLines and lineNumbers. That means, if you disable preWrapper, the line highlighting and line numbers will also be disabled.
Add v-pre directive to <code> tag of inline code or not.
",3),Me=e("p",null,"Also see:",-1),Ie=e("h3",{id:"markdown-component",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-component","aria-hidden":"true"},"#"),n(" markdown.component")],-1),Ne=e("li",null,[e("p",null,[n("Type: "),e("code",null,"undefined | false")])],-1),je=e("p",null,"Details:",-1),He={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-component",target:"_blank",rel:"noopener noreferrer"},Ve=e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")],-1),We=e("div",{class:"hint-container danger"},[e("p",{class:"hint-container-title"},"Warning"),e("p",null,"You should not configure it unless you understand what it is for.")],-1),Re=e("h3",{id:"markdown-emoji",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-emoji","aria-hidden":"true"},"#"),n(" markdown.emoji")],-1),Fe=e("li",null,[e("p",null,[n("Type: "),e("code",null,"EmojiPluginOptions | false")])],-1),Ye=e("p",null,"Details:",-1),Ue={href:"https://github.com/markdown-it/markdown-it-emoji",target:"_blank",rel:"noopener noreferrer"},$e=e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")],-1),Xe=e("p",null,"Also see:",-1),Ze=e("h3",{id:"markdown-frontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-frontmatter","aria-hidden":"true"},"#"),n(" markdown.frontmatter")],-1),ze=e("li",null,[e("p",null,[n("Type: "),e("code",null,"FrontmatterPluginOptions | false")])],-1),Je=e("p",null,"Details:",-1),Ke={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-frontmatter",target:"_blank",rel:"noopener noreferrer"},Qe=e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")],-1),en=e("p",null,"Also see:",-1),nn=o(`
Warning
You should not configure it unless you understand what it is for.
`,4),ln=e("p",null,"Details:",-1),tn={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-headers",target:"_blank",rel:"noopener noreferrer"},an=e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")],-1),on=e("p",null,"Also see:",-1),sn=e("h3",{id:"markdown-importcode",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-importcode","aria-hidden":"true"},"#"),n(" markdown.importCode")],-1),dn=e("li",null,[e("p",null,[n("Type: "),e("code",null,"ImportCodePluginOptions | false")])],-1),rn=e("li",null,[e("p",null,"Details:"),e("p",null,"Options for VuePress built-in markdown-it import-code plugin."),e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")])],-1),pn=e("p",null,"Also see:",-1),un=o('
`,4),Sn=e("p",null,"Details:",-1),Cn={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc",target:"_blank",rel:"noopener noreferrer"},qn=e("p",null,[n("Set to "),e("code",null,"false"),n(" to disable this plugin.")],-1),Ln=e("p",null,"Also see:",-1),On=e("h2",{id:"plugin-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugin-config","aria-hidden":"true"},"#"),n(" Plugin Config")],-1),Bn=e("h3",{id:"plugins",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugins","aria-hidden":"true"},"#"),n(" plugins")],-1),En=e("li",null,[e("p",null,[n("Type: "),e("code",null,"(Plugin | Plugin[])[]")])],-1),Gn=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),Mn=e("p",null,"Also see:",-1),In=e("h2",{id:"plugin-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugin-api","aria-hidden":"true"},"#"),n(" Plugin API")],-1),Nn=e("p",null,[n("User config file also works as a VuePress plugin, so all of the Plugin APIs are available except the "),e("code",null,"name"),n(" and "),e("code",null,"multiple"),n(" options.")],-1);function jn(Hn,Vn){const d=s("NpmBadge"),t=s("RouterLink"),i=s("ExternalLinkIcon");return p(),u("div",null,[h,l(d,{package:"@vuepress/cli"}),l(d,{package:"@vuepress/core"}),f,m,e("ul",null,[g,e("li",null,[_,e("ul",null,[e("li",null,[l(t,{to:"/guide/assets.html#base-helper"},{default:a(()=>[n("Guide > Assets > Base Helper")]),_:1})]),e("li",null,[l(t,{to:"/guide/deployment.html"},{default:a(()=>[n("Guide > Deployment")]),_:1})])])])]),k,e("ul",null,[b,e("li",null,[w,e("ul",null,[v,e("li",null,[l(t,{to:"/reference/frontmatter.html#lang"},{default:a(()=>[n("Frontmatter > lang")]),_:1})])])])]),y,e("ul",null,[x,e("li",null,[D,e("ul",null,[T,e("li",null,[l(t,{to:"/reference/frontmatter.html#description"},{default:a(()=>[n("Frontmatter > description")]),_:1})])])])]),P,e("ul",null,[e("li",null,[n("Also see: "),e("ul",null,[A,e("li",null,[l(t,{to:"/reference/frontmatter.html#head"},{default:a(()=>[n("Frontmatter > head")]),_:1})])])])]),S,e("ul",null,[C,e("li",null,[q,e("ul",null,[e("li",null,[l(t,{to:"/guide/i18n.html"},{default:a(()=>[n("Guide > I18n")]),_:1})])])])]),L,O,e("ul",null,[B,E,e("li",null,[G,e("ul",null,[e("li",null,[l(t,{to:"/guide/theme.html"},{default:a(()=>[n("Guide > Theme")]),_:1})]),e("li",null,[l(t,{to:"/reference/default-theme/config.html"},{default:a(()=>[n("Default Theme > Config")]),_:1})])])])]),M,I,e("ul",null,[N,e("li",null,[j,e("ul",null,[e("li",null,[l(t,{to:"/guide/bundler.html"},{default:a(()=>[n("Guide > Bundler")]),_:1})]),e("li",null,[l(t,{to:"/reference/bundler/vite.html"},{default:a(()=>[n("Bundlers > Vite")]),_:1})]),e("li",null,[l(t,{to:"/reference/bundler/webpack.html"},{default:a(()=>[n("Bundlers > Webpack")]),_:1})])])])]),H,e("ul",null,[V,W,R,e("li",null,[F,e("ul",null,[e("li",null,[l(t,{to:"/guide/assets.html#public-files"},{default:a(()=>[n("Guide > Assets > Public Files")]),_:1})])])])]),Y,e("ul",null,[U,$,e("li",null,[X,Z,e("p",null,[n("This would be helpful for developers. Also, we are using "),e("a",z,[n("debug"),l(i)]),n(" package for debug logging, which can be enabled via "),J,n(" environment variable.")])])]),K,e("ul",null,[Q,e("li",null,[ee,e("ul",null,[e("li",null,[l(t,{to:"/reference/frontmatter.html#permalinkpattern"},{default:a(()=>[n("Frontmatter > permalinkPattern")]),_:1})])])])]),ne,e("ul",null,[le,te,e("li",null,[ae,oe,e("p",null,[n("It accepts all options of "),e("a",ie,[n("markdown-it"),l(i)]),n(", and the following additional options.")])]),e("li",null,[se,e("ul",null,[e("li",null,[e("a",de,[n("markdown-it > Init with presets and options"),l(i)])]),e("li",null,[l(t,{to:"/guide/markdown.html#syntax-extensions"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions")]),_:1})])])])]),re,e("ul",null,[e("li",null,[pe,e("p",null,[n("Options for "),e("a",ue,[n("markdown-it-anchor"),l(i)]),n(".")]),ce]),e("li",null,[he,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#header-anchors"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Header Anchors")]),_:1})])])])]),fe,e("ul",null,[me,ge,e("li",null,[_e,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#code-blocks"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Code Blocks")]),_:1})])])])]),ke,e("ul",null,[be,we,ve,e("li",null,[ye,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#line-highlighting"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Code Blocks > Line Highlighting")]),_:1})])])])]),xe,e("ul",null,[De,e("li",null,[Te,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#line-numbers"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Code Blocks > Line Numbers")]),_:1})])])])]),Pe,e("div",Ae,[Se,e("p",null,[n("You can disable it if you want to implement them in client side. For example, "),e("a",Ce,[n("Prismjs Line Highlight"),l(i)]),n(" or "),e("a",qe,[n("Prismjs Line Numbers"),l(i)]),n(".")])]),Le,e("ul",null,[Oe,e("li",null,[Be,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#wrap-with-v-pre"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Code Blocks > Wrap with v-pre")]),_:1})])])])]),Ee,e("ul",null,[Ge,e("li",null,[Me,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#wrap-with-v-pre"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Code Blocks > Wrap with v-pre")]),_:1})])])])]),Ie,e("ul",null,[Ne,e("li",null,[je,e("p",null,[n("Options for "),e("a",He,[n("@mdit-vue/plugin-component"),l(i)]),n(".")]),Ve])]),We,Re,e("ul",null,[Fe,e("li",null,[Ye,e("p",null,[n("Options for "),e("a",Ue,[n("markdown-it-emoji"),l(i)]),n(".")]),$e]),e("li",null,[Xe,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#emoji"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Emoji")]),_:1})])])])]),Ze,e("ul",null,[ze,e("li",null,[Je,e("p",null,[n("Options for "),e("a",Ke,[n("@mdit-vue/plugin-frontmatter"),l(i)]),n(".")]),Qe]),e("li",null,[en,e("ul",null,[e("li",null,[l(t,{to:"/guide/page.html#frontmatter"},{default:a(()=>[n("Guide > Page > Frontmatter")]),_:1})]),e("li",null,[l(t,{to:"/reference/node-api.html#frontmatter"},{default:a(()=>[n("Node API > Page Properties > frontmatter")]),_:1})])])])]),nn,e("ul",null,[e("li",null,[ln,e("p",null,[n("Options for "),e("a",tn,[n("@mdit-vue/plugin-headers"),l(i)]),n(".")]),an]),e("li",null,[on,e("ul",null,[e("li",null,[l(t,{to:"/reference/node-api.html#headers"},{default:a(()=>[n("Node API > Page Properties > headers")]),_:1})])])])]),sn,e("ul",null,[dn,rn,e("li",null,[pn,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#import-code-blocks"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Import Code Blocks")]),_:1})])])])]),un,e("ul",null,[cn,e("li",null,[hn,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#links"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Links")]),_:1})])])])]),fn,e("ul",null,[mn,e("li",null,[gn,e("p",null,[n("Options for "),e("a",_n,[n("@mdit-vue/plugin-sfc"),l(i)]),n(".")]),kn]),e("li",null,[bn,e("ul",null,[e("li",null,[l(t,{to:"/advanced/cookbook/markdown-and-vue-sfc.html"},{default:a(()=>[n("Cookbook > Markdown and Vue SFC")]),_:1})]),e("li",null,[l(t,{to:"/reference/node-api.html#sfcblocks"},{default:a(()=>[n("Node API > Page Properties > sfcBlocks")]),_:1})])])])]),wn,vn,yn,e("ul",null,[xn,e("li",null,[Dn,e("p",null,[n("Options for "),e("a",Tn,[n("@mdit-vue/plugin-title"),l(i)]),n(".")]),Pn])]),An,e("ul",null,[e("li",null,[Sn,e("p",null,[n("Options for "),e("a",Cn,[n("@mdit-vue/plugin-toc"),l(i)]),n(".")]),qn]),e("li",null,[Ln,e("ul",null,[e("li",null,[l(t,{to:"/guide/markdown.html#table-of-contents"},{default:a(()=>[n("Guide > Markdown > Syntax Extensions > Table of Contents")]),_:1})])])])]),On,Bn,e("ul",null,[En,Gn,e("li",null,[Mn,e("ul",null,[e("li",null,[l(t,{to:"/guide/plugin.html"},{default:a(()=>[n("Guide > Plugin")]),_:1})])])])]),In,Nn,e("p",null,[n("Please check out "),l(t,{to:"/reference/plugin-api.html"},{default:a(()=>[n("Plugin API Reference")]),_:1}),n(" for a full list of Plugin APIs.")])])}const Rn=r(c,[["render",jn],["__file","config.html.vue"]]);export{Rn as default};
diff --git a/assets/config.html-66333531.js b/assets/config.html-66333531.js
new file mode 100644
index 00000000..3af9ed03
--- /dev/null
+++ b/assets/config.html-66333531.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-03a561ce","path":"/zh/reference/default-theme/config.html","title":"配置","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:gear","description":"基础配置 locales 类型： { [path: string]: Partial }; 默认值： {}; 详情：; 多语言支持的各个语言 locales 。 所有在 Locale 配置 (#locale-配置) 章节内的配置项都可以在 locales 中使用。 该配置项仅能在默认主题内生效，注意不要和 站点配置 (../config.md#loca...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/default-theme/config.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/default-theme/config.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"配置"}],["meta",{"property":"og:description","content":"基础配置 locales 类型： { [path: string]: Partial }; 默认值： {}; 详情：; 多语言支持的各个语言 locales 。 所有在 Locale 配置 (#locale-配置) 章节内的配置项都可以在 locales 中使用。 该配置项仅能在默认主题内生效，注意不要和 站点配置 (../config.md#loca..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"配置\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"基础配置","slug":"基础配置","link":"#基础配置","children":[{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"Locale 配置","slug":"locale-配置","link":"#locale-配置","children":[{"level":3,"title":"colorMode","slug":"colormode","link":"#colormode","children":[]},{"level":3,"title":"colorModeSwitch","slug":"colormodeswitch","link":"#colormodeswitch","children":[]},{"level":3,"title":"home","slug":"home","link":"#home","children":[]},{"level":3,"title":"navbar","slug":"navbar","link":"#navbar","children":[]},{"level":3,"title":"logo","slug":"logo","link":"#logo","children":[]},{"level":3,"title":"logoDark","slug":"logodark","link":"#logodark","children":[]},{"level":3,"title":"repo","slug":"repo","link":"#repo","children":[]},{"level":3,"title":"repoLabel","slug":"repolabel","link":"#repolabel","children":[]},{"level":3,"title":"selectLanguageText","slug":"selectlanguagetext","link":"#selectlanguagetext","children":[]},{"level":3,"title":"selectLanguageAriaLabel","slug":"selectlanguagearialabel","link":"#selectlanguagearialabel","children":[]},{"level":3,"title":"selectLanguageName","slug":"selectlanguagename","link":"#selectlanguagename","children":[]},{"level":3,"title":"sidebar","slug":"sidebar","link":"#sidebar","children":[]},{"level":3,"title":"sidebarDepth","slug":"sidebardepth","link":"#sidebardepth","children":[]},{"level":3,"title":"editLink","slug":"editlink","link":"#editlink","children":[]},{"level":3,"title":"editLinkText","slug":"editlinktext","link":"#editlinktext","children":[]},{"level":3,"title":"editLinkPattern","slug":"editlinkpattern","link":"#editlinkpattern","children":[]},{"level":3,"title":"docsRepo","slug":"docsrepo","link":"#docsrepo","children":[]},{"level":3,"title":"docsBranch","slug":"docsbranch","link":"#docsbranch","children":[]},{"level":3,"title":"docsDir","slug":"docsdir","link":"#docsdir","children":[]},{"level":3,"title":"lastUpdated","slug":"lastupdated","link":"#lastupdated","children":[]},{"level":3,"title":"lastUpdatedText","slug":"lastupdatedtext","link":"#lastupdatedtext","children":[]},{"level":3,"title":"contributors","slug":"contributors","link":"#contributors","children":[]},{"level":3,"title":"contributorsText","slug":"contributorstext","link":"#contributorstext","children":[]},{"level":3,"title":"tip","slug":"tip","link":"#tip","children":[]},{"level":3,"title":"warning","slug":"warning","link":"#warning","children":[]},{"level":3,"title":"danger","slug":"danger","link":"#danger","children":[]},{"level":3,"title":"notFound","slug":"notfound","link":"#notfound","children":[]},{"level":3,"title":"backToHome","slug":"backtohome","link":"#backtohome","children":[]},{"level":3,"title":"openInNewWindow","slug":"openinnewwindow","link":"#openinnewwindow","children":[]},{"level":3,"title":"toggleColorMode","slug":"togglecolormode","link":"#togglecolormode","children":[]},{"level":3,"title":"toggleSidebar","slug":"togglesidebar","link":"#togglesidebar","children":[]}]},{"level":2,"title":"插件配置","slug":"插件配置","link":"#插件配置","children":[{"level":3,"title":"themePlugins","slug":"themeplugins","link":"#themeplugins","children":[]},{"level":3,"title":"themePlugins.activeHeaderLinks","slug":"themeplugins-activeheaderlinks","link":"#themeplugins-activeheaderlinks","children":[]},{"level":3,"title":"themePlugins.container","slug":"themeplugins-container","link":"#themeplugins-container","children":[]},{"level":3,"title":"themePlugins.externalLinkIcon","slug":"themeplugins-externallinkicon","link":"#themeplugins-externallinkicon","children":[]},{"level":3,"title":"themePlugins.git","slug":"themeplugins-git","link":"#themeplugins-git","children":[]},{"level":3,"title":"themePlugins.mediumZoom","slug":"themeplugins-mediumzoom","link":"#themeplugins-mediumzoom","children":[]},{"level":3,"title":"themePlugins.nprogress","slug":"themeplugins-nprogress","link":"#themeplugins-nprogress","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":9.99,"words":2996},"filePathRelative":"zh/reference/default-theme/config.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/config.html-8c5b48e3.js b/assets/config.html-8c5b48e3.js
new file mode 100644
index 00000000..056955ef
--- /dev/null
+++ b/assets/config.html-8c5b48e3.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-65a9edeb","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":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/config.html"}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"配置\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"站点配置","slug":"站点配置","link":"#站点配置","children":[{"level":3,"title":"base","slug":"base","link":"#base","children":[]},{"level":3,"title":"lang","slug":"lang","link":"#lang","children":[]},{"level":3,"title":"title","slug":"title","link":"#title","children":[]},{"level":3,"title":"description","slug":"description","link":"#description","children":[]},{"level":3,"title":"head","slug":"head","link":"#head","children":[]},{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"主题配置","slug":"主题配置","link":"#主题配置","children":[{"level":3,"title":"theme","slug":"theme","link":"#theme","children":[]}]},{"level":2,"title":"打包工具配置","slug":"打包工具配置","link":"#打包工具配置","children":[{"level":3,"title":"bundler","slug":"bundler","link":"#bundler","children":[]}]},{"level":2,"title":"通用配置项","slug":"通用配置项","link":"#通用配置项","children":[{"level":3,"title":"dest","slug":"dest","link":"#dest","children":[]},{"level":3,"title":"temp","slug":"temp","link":"#temp","children":[]},{"level":3,"title":"cache","slug":"cache","link":"#cache","children":[]},{"level":3,"title":"public","slug":"public","link":"#public","children":[]},{"level":3,"title":"debug","slug":"debug","link":"#debug","children":[]},{"level":3,"title":"pagePatterns","slug":"pagepatterns","link":"#pagepatterns","children":[]},{"level":3,"title":"permalinkPattern","slug":"permalinkpattern","link":"#permalinkpattern","children":[]}]},{"level":2,"title":"Dev 配置项","slug":"dev-配置项","link":"#dev-配置项","children":[{"level":3,"title":"host","slug":"host","link":"#host","children":[]},{"level":3,"title":"port","slug":"port","link":"#port","children":[]},{"level":3,"title":"open","slug":"open","link":"#open","children":[]},{"level":3,"title":"templateDev","slug":"templatedev","link":"#templatedev","children":[]}]},{"level":2,"title":"Build 配置项","slug":"build-配置项","link":"#build-配置项","children":[{"level":3,"title":"shouldPreload","slug":"shouldpreload","link":"#shouldpreload","children":[]},{"level":3,"title":"shouldPrefetch","slug":"shouldprefetch","link":"#shouldprefetch","children":[]},{"level":3,"title":"templateBuild","slug":"templatebuild","link":"#templatebuild","children":[]}]},{"level":2,"title":"Markdown 配置","slug":"markdown-配置","link":"#markdown-配置","children":[{"level":3,"title":"markdown","slug":"markdown","link":"#markdown","children":[]},{"level":3,"title":"markdown.anchor","slug":"markdown-anchor","link":"#markdown-anchor","children":[]},{"level":3,"title":"markdown.assets","slug":"markdown-assets","link":"#markdown-assets","children":[]},{"level":3,"title":"markdown.code","slug":"markdown-code","link":"#markdown-code","children":[]},{"level":3,"title":"markdown.component","slug":"markdown-component","link":"#markdown-component","children":[]},{"level":3,"title":"markdown.emoji","slug":"markdown-emoji","link":"#markdown-emoji","children":[]},{"level":3,"title":"markdown.frontmatter","slug":"markdown-frontmatter","link":"#markdown-frontmatter","children":[]},{"level":3,"title":"markdown.headers","slug":"markdown-headers","link":"#markdown-headers","children":[]},{"level":3,"title":"markdown.title","slug":"markdown-title","link":"#markdown-title","children":[]},{"level":3,"title":"markdown.importCode","slug":"markdown-importcode","link":"#markdown-importcode","children":[]},{"level":3,"title":"markdown.links","slug":"markdown-links","link":"#markdown-links","children":[]},{"level":3,"title":"markdown.sfc","slug":"markdown-sfc","link":"#markdown-sfc","children":[]},{"level":3,"title":"markdown.slugify","slug":"markdown-slugify","link":"#markdown-slugify","children":[]},{"level":3,"title":"markdown.toc","slug":"markdown-toc","link":"#markdown-toc","children":[]}]},{"level":2,"title":"插件配置","slug":"插件配置","link":"#插件配置","children":[{"level":3,"title":"plugins","slug":"plugins","link":"#plugins","children":[]}]},{"level":2,"title":"插件 API","slug":"插件-api","link":"#插件-api","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":9.34,"words":2801},"filePathRelative":"zh/reference/config.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/config.html-9875b777.js b/assets/config.html-9875b777.js
new file mode 100644
index 00000000..6d1a4766
--- /dev/null
+++ b/assets/config.html-9875b777.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-0f0d17a8","path":"/reference/default-theme/config.html","title":"Config","lang":"en-US","frontmatter":{"icon":"fa6-solid:gear","description":"Basic Config locales Type: { [path: string]: Partial }; Default: {}; Details:; Specify locales for i18n support. All the options inside the Locale Config (#locale-config) sectio...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/default-theme/config.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/default-theme/config.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Config"}],["meta",{"property":"og:description","content":"Basic Config locales Type: { [path: string]: Partial }; Default: {}; Details:; Specify locales for i18n support. All the options inside the Locale Config (#locale-config) sectio..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Config\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Basic Config","slug":"basic-config","link":"#basic-config","children":[{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"Locale Config","slug":"locale-config","link":"#locale-config","children":[{"level":3,"title":"colorMode","slug":"colormode","link":"#colormode","children":[]},{"level":3,"title":"colorModeSwitch","slug":"colormodeswitch","link":"#colormodeswitch","children":[]},{"level":3,"title":"home","slug":"home","link":"#home","children":[]},{"level":3,"title":"navbar","slug":"navbar","link":"#navbar","children":[]},{"level":3,"title":"logo","slug":"logo","link":"#logo","children":[]},{"level":3,"title":"logoDark","slug":"logodark","link":"#logodark","children":[]},{"level":3,"title":"repo","slug":"repo","link":"#repo","children":[]},{"level":3,"title":"repoLabel","slug":"repolabel","link":"#repolabel","children":[]},{"level":3,"title":"selectLanguageText","slug":"selectlanguagetext","link":"#selectlanguagetext","children":[]},{"level":3,"title":"selectLanguageAriaLabel","slug":"selectlanguagearialabel","link":"#selectlanguagearialabel","children":[]},{"level":3,"title":"selectLanguageName","slug":"selectlanguagename","link":"#selectlanguagename","children":[]},{"level":3,"title":"sidebar","slug":"sidebar","link":"#sidebar","children":[]},{"level":3,"title":"sidebarDepth","slug":"sidebardepth","link":"#sidebardepth","children":[]},{"level":3,"title":"editLink","slug":"editlink","link":"#editlink","children":[]},{"level":3,"title":"editLinkText","slug":"editlinktext","link":"#editlinktext","children":[]},{"level":3,"title":"editLinkPattern","slug":"editlinkpattern","link":"#editlinkpattern","children":[]},{"level":3,"title":"docsRepo","slug":"docsrepo","link":"#docsrepo","children":[]},{"level":3,"title":"docsBranch","slug":"docsbranch","link":"#docsbranch","children":[]},{"level":3,"title":"docsDir","slug":"docsdir","link":"#docsdir","children":[]},{"level":3,"title":"lastUpdated","slug":"lastupdated","link":"#lastupdated","children":[]},{"level":3,"title":"lastUpdatedText","slug":"lastupdatedtext","link":"#lastupdatedtext","children":[]},{"level":3,"title":"contributors","slug":"contributors","link":"#contributors","children":[]},{"level":3,"title":"contributorsText","slug":"contributorstext","link":"#contributorstext","children":[]},{"level":3,"title":"tip","slug":"tip","link":"#tip","children":[]},{"level":3,"title":"warning","slug":"warning","link":"#warning","children":[]},{"level":3,"title":"danger","slug":"danger","link":"#danger","children":[]},{"level":3,"title":"notFound","slug":"notfound","link":"#notfound","children":[]},{"level":3,"title":"backToHome","slug":"backtohome","link":"#backtohome","children":[]},{"level":3,"title":"openInNewWindow","slug":"openinnewwindow","link":"#openinnewwindow","children":[]},{"level":3,"title":"toggleColorMode","slug":"togglecolormode","link":"#togglecolormode","children":[]},{"level":3,"title":"toggleSidebar","slug":"togglesidebar","link":"#togglesidebar","children":[]}]},{"level":2,"title":"Plugins Config","slug":"plugins-config","link":"#plugins-config","children":[{"level":3,"title":"themePlugins","slug":"themeplugins","link":"#themeplugins","children":[]},{"level":3,"title":"themePlugins.activeHeaderLinks","slug":"themeplugins-activeheaderlinks","link":"#themeplugins-activeheaderlinks","children":[]},{"level":3,"title":"themePlugins.backToTop","slug":"themeplugins-backtotop","link":"#themeplugins-backtotop","children":[]},{"level":3,"title":"themePlugins.container","slug":"themeplugins-container","link":"#themeplugins-container","children":[]},{"level":3,"title":"themePlugins.externalLinkIcon","slug":"themeplugins-externallinkicon","link":"#themeplugins-externallinkicon","children":[]},{"level":3,"title":"themePlugins.git","slug":"themeplugins-git","link":"#themeplugins-git","children":[]},{"level":3,"title":"themePlugins.mediumZoom","slug":"themeplugins-mediumzoom","link":"#themeplugins-mediumzoom","children":[]},{"level":3,"title":"themePlugins.nprogress","slug":"themeplugins-nprogress","link":"#themeplugins-nprogress","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":7.16,"words":2148},"filePathRelative":"reference/default-theme/config.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/config.html-d093ed05.js b/assets/config.html-d093ed05.js
new file mode 100644
index 00000000..b922f5d2
--- /dev/null
+++ b/assets/config.html-d093ed05.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-b249668c","path":"/reference/config.html","title":"Config","lang":"en-US","frontmatter":{"icon":"fa6-solid:gear","description":"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. It sh...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/config.html"}],["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":"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. It sh..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Config\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Site Config","slug":"site-config","link":"#site-config","children":[{"level":3,"title":"base","slug":"base","link":"#base","children":[]},{"level":3,"title":"lang","slug":"lang","link":"#lang","children":[]},{"level":3,"title":"title","slug":"title","link":"#title","children":[]},{"level":3,"title":"description","slug":"description","link":"#description","children":[]},{"level":3,"title":"head","slug":"head","link":"#head","children":[]},{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"Theme Config","slug":"theme-config","link":"#theme-config","children":[{"level":3,"title":"theme","slug":"theme","link":"#theme","children":[]}]},{"level":2,"title":"Bundler Config","slug":"bundler-config","link":"#bundler-config","children":[{"level":3,"title":"bundler","slug":"bundler","link":"#bundler","children":[]}]},{"level":2,"title":"Common Config","slug":"common-config","link":"#common-config","children":[{"level":3,"title":"dest","slug":"dest","link":"#dest","children":[]},{"level":3,"title":"temp","slug":"temp","link":"#temp","children":[]},{"level":3,"title":"cache","slug":"cache","link":"#cache","children":[]},{"level":3,"title":"public","slug":"public","link":"#public","children":[]},{"level":3,"title":"debug","slug":"debug","link":"#debug","children":[]},{"level":3,"title":"pagePatterns","slug":"pagepatterns","link":"#pagepatterns","children":[]},{"level":3,"title":"permalinkPattern","slug":"permalinkpattern","link":"#permalinkpattern","children":[]}]},{"level":2,"title":"Dev Config","slug":"dev-config","link":"#dev-config","children":[{"level":3,"title":"host","slug":"host","link":"#host","children":[]},{"level":3,"title":"port","slug":"port","link":"#port","children":[]},{"level":3,"title":"open","slug":"open","link":"#open","children":[]},{"level":3,"title":"templateDev","slug":"templatedev","link":"#templatedev","children":[]}]},{"level":2,"title":"Build Config","slug":"build-config","link":"#build-config","children":[{"level":3,"title":"shouldPreload","slug":"shouldpreload","link":"#shouldpreload","children":[]},{"level":3,"title":"shouldPrefetch","slug":"shouldprefetch","link":"#shouldprefetch","children":[]},{"level":3,"title":"templateBuild","slug":"templatebuild","link":"#templatebuild","children":[]}]},{"level":2,"title":"Markdown Config","slug":"markdown-config","link":"#markdown-config","children":[{"level":3,"title":"markdown","slug":"markdown","link":"#markdown","children":[]},{"level":3,"title":"markdown.anchor","slug":"markdown-anchor","link":"#markdown-anchor","children":[]},{"level":3,"title":"markdown.assets","slug":"markdown-assets","link":"#markdown-assets","children":[]},{"level":3,"title":"markdown.code","slug":"markdown-code","link":"#markdown-code","children":[]},{"level":3,"title":"markdown.component","slug":"markdown-component","link":"#markdown-component","children":[]},{"level":3,"title":"markdown.emoji","slug":"markdown-emoji","link":"#markdown-emoji","children":[]},{"level":3,"title":"markdown.frontmatter","slug":"markdown-frontmatter","link":"#markdown-frontmatter","children":[]},{"level":3,"title":"markdown.headers","slug":"markdown-headers","link":"#markdown-headers","children":[]},{"level":3,"title":"markdown.importCode","slug":"markdown-importcode","link":"#markdown-importcode","children":[]},{"level":3,"title":"markdown.links","slug":"markdown-links","link":"#markdown-links","children":[]},{"level":3,"title":"markdown.sfc","slug":"markdown-sfc","link":"#markdown-sfc","children":[]},{"level":3,"title":"markdown.slugify","slug":"markdown-slugify","link":"#markdown-slugify","children":[]},{"level":3,"title":"markdown.title","slug":"markdown-title","link":"#markdown-title","children":[]},{"level":3,"title":"markdown.toc","slug":"markdown-toc","link":"#markdown-toc","children":[]}]},{"level":2,"title":"Plugin Config","slug":"plugin-config","link":"#plugin-config","children":[{"level":3,"title":"plugins","slug":"plugins","link":"#plugins","children":[]}]},{"level":2,"title":"Plugin API","slug":"plugin-api","link":"#plugin-api","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":6.43,"words":1930},"filePathRelative":"reference/config.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/config.html-e71cb202.js b/assets/config.html-e71cb202.js
new file mode 100644
index 00000000..bc46e12c
--- /dev/null
+++ b/assets/config.html-e71cb202.js
@@ -0,0 +1,22 @@
+import{_ as r,W as p,X as c,Y as l,$ as e,Z as t,a0 as n,a1 as o,D as i}from"./framework-46b0e263.js";const u={},h=e("h1",{id:"配置",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#配置","aria-hidden":"true"},"#"),n(" 配置")],-1),m=e("h2",{id:"站点配置",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#站点配置","aria-hidden":"true"},"#"),n(" 站点配置")],-1),_=e("h3",{id:"base",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#base","aria-hidden":"true"},"#"),n(" base")],-1),k=o("
类型： string
默认值： /
详情：
部署站点的基础路径。
如果你想让你的网站部署到一个子路径下，你将需要设置它。它的值应当总是以斜杠开始，并以斜杠结束。举例来说，如果你想将你的网站部署到 https://foo.github.io/bar/，那么 base 应该被设置成 "/bar/"。
`,3),k=n("li",null,[n("p",null,[e("Type: "),n("code",null,"{ [path: string]: Partial }")])],-1),b=n("li",null,[n("p",null,[e("Default: "),n("code",null,"{}")])],-1),v=n("p",null,"Details:",-1),f=n("p",null,"Specify locales for i18n support.",-1),g=n("p",null,[e("All the options inside the "),n("a",{href:"#locale-config"},"Locale Config"),e(" section can be used in locales.")],-1),_=n("code",null,"locales",-1),y=n("p",null,"Also see:",-1),x=l('
To configure the navbar items, you can set it to a navbar array, each item of which could be a NavbarItem object, a NavbarGroup object, or a string:
A NavbarItem object should have a text field and a link field, could have an optional activeMatch field.
A NavbarGroup object should have a text field and a children field. The children field should be a navbar array, too.
A string should be the path to the target page file. It will be converted to a NavbarItem object, using the page title as text, and the page route path as link.
exportdefault{
+ theme:defaultTheme({
+ navbar:[
+ // nested group - max depth is 2
+ {
+ text:"Group",
+ children:[
+ {
+ text:"SubGroup",
+ children:["/group/sub/foo.md","/group/sub/bar.md"],
+ },
+ ],
+ },
+ // control when should the item be active
+ {
+ text:"Group 2",
+ children:[
+ {
+ text:"Always active",
+ link:"/",
+ // this item will always be active
+ activeMatch:"/",
+ },
+ {
+ text:"Active on /foo/",
+ link:"/not-foo/",
+ // this item will be active when current route path starts with /foo/
+ // regular expression is supported
+ activeMatch:"^/foo/",
+ },
+ ],
+ },
+ ],
+ }),
+};
+
This will be used as the link of the repository link, which will be displayed as the last item of the navbar.
exportdefault{
+ theme:defaultTheme({
+ // If you set it in the form of \`organization/repository\`
+ // we will take it as a GitHub repo
+ repo:"vuejs/vuepress",
+ // You can also set it to a URL directly
+ repo:"https://gitlab.com/foo/bar",
+ }),
+};
+
`,8),N=n("li",null,[n("p",null,[e("Type: "),n("code",null,"string")])],-1),A=n("p",null,"Details:",-1),G=n("p",null,[e("Specify the text of the "),n("em",null,"select language menu"),e(".")],-1),P=n("em",null,"select language menu",-1),R=l(`
This option will only take effect inside the locales of your theme config. It will be used as the language name of the locale, which will be displayed in the select language menu.
If you set it to 'auto', the sidebar will be automatically generated from the page headers.
To configure the sidebar items manually, you can set this option to a sidebar array, each item of which could be a SidebarItem object or a string:
A SidebarItem object should have a text field, could have an optional link field, an optional children field and an optional collapsible field. The children field should be a sidebar array. The collapsible field controls whether the item is collapsible.
A string should be the path to the target page file. It will be converted to a SidebarItem object, whose text is the page title, link is the page route path, and children is automatically generated from the page headers.
If you want to set different sidebar for different sub paths, you can set this option to a sidebar object:
Set the maximum depth of the sidebar children which are automatically generated from the page headers.
Set to 0 to disable all levels of headers.
Set to 1 to include <h2> headers.
Set to 2 to include <h2> and <h3> headers.
...
",3),O=n("p",null,[e("The default value of "),n("code",null,"markdown.headers.level"),e(" is "),n("code",null,"[2, 3]"),e(", so the default max value of "),n("code",null,"sidebarDepth"),e(" is "),n("code",null,"2"),e(".")],-1),Z=n("h3",{id:"editlink",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#editlink","aria-hidden":"true"},"#"),e(" editLink")],-1),X=n("li",null,[n("p",null,[e("Type: "),n("code",null,"boolean")])],-1),$=n("li",null,[n("p",null,[e("Default: "),n("code",null,"true")])],-1),J=n("p",null,"Details:",-1),K=n("p",null,[e("Enable the "),n("em",null,"edit this page"),e(" link or not.")],-1),Q=l(`
This will be used for generating the edit this page link.
If you don't set this option, the pattern will be inferred from the docsRepo option. But if your documentation repository is not hosted on a common platform, for example, GitHub, GitLab, Bitbucket, Gitee, etc., you have to set this option explicitly to make the edit this page link work.
Specify the repository url of your documentation source files.
This will be used for generating the edit this page link.
If you don't set this option, it will use the repo option by default. But if your documentation source files are in a different repository, you will need to set this option.
`,13),nn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"boolean")])],-1),en=n("li",null,[n("p",null,[e("Default: "),n("code",null,"true")])],-1),an=n("p",null,"Details:",-1),sn=n("p",null,[e("Enable the "),n("em",null,"last updated timestamp"),e(" or not.")],-1),tn=n("code",null,"false",-1),ln=l('
',3),on=n("li",null,[n("p",null,[e("Type: "),n("code",null,"boolean")])],-1),pn=n("li",null,[n("p",null,[e("Default: "),n("code",null,"true")])],-1),cn=n("p",null,"Details:",-1),un=n("p",null,[e("Enable the "),n("em",null,"contributors list"),e(" or not.")],-1),dn=n("code",null,"false",-1),rn=l('
',5),Tn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"string")])],-1),Dn=n("li",null,[n("p",null,[e("Default: "),n("code",null,"'open in new window'")])],-1),Sn=n("p",null,"Details:",-1),En=n("code",null,"sr-only",-1),In=n("p",null,"This is mainly for a11y purpose.",-1),Cn=n("li",null,[n("p",null,"Also see:"),n("ul",null,[n("li",null,[n("a",{href:"#themeplugins-externallinkicon"},"Default Theme > Config Reference > themePlugins.externalLinkIcon")])])],-1),Ln=l('
Default theme is using some plugins by default. You can disable a plugin if you really do not want to use it. Make sure you understand what the plugin is for before disabling it.
",2),Fn=n("p",null,"Also see:",-1),Vn=n("h3",{id:"themeplugins-externallinkicon",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-externallinkicon","aria-hidden":"true"},"#"),e(" themePlugins.externalLinkIcon")],-1),Hn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"boolean")])],-1),Wn=n("li",null,[n("p",null,[e("Default: "),n("code",null,"true")])],-1),On=n("p",null,"Details:",-1),Zn=n("h3",{id:"themeplugins-git",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-git","aria-hidden":"true"},"#"),e(" themePlugins.git")],-1),Xn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"boolean")])],-1),$n=n("li",null,[n("p",null,[e("Default: "),n("code",null,"true")])],-1),Jn=n("p",null,"Details:",-1),Kn=n("h3",{id:"themeplugins-mediumzoom",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-mediumzoom","aria-hidden":"true"},"#"),e(" themePlugins.mediumZoom")],-1),Qn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"boolean")])],-1),ne=n("li",null,[n("p",null,[e("Default: "),n("code",null,"true")])],-1),ee=n("p",null,"Details:",-1),ae=n("h3",{id:"themeplugins-nprogress",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#themeplugins-nprogress","aria-hidden":"true"},"#"),e(" themePlugins.nprogress")],-1),se=n("li",null,[n("p",null,[e("Type: "),n("code",null,"boolean")])],-1),te=n("li",null,[n("p",null,[e("Default: "),n("code",null,"true")])],-1),le=n("p",null,"Details:",-1);function oe(ie,pe){const i=o("NpmBadge"),s=o("RouterLink"),p=o("ExternalLinkIcon");return u(),d("div",null,[h,a(i,{package:"@vuepress/theme-default"}),m,n("ul",null,[k,b,n("li",null,[v,f,g,n("p",null,[e("This option will only take effect in default theme, so don't confuse with "),_,e(" in "),a(s,{to:"/reference/config.html#locales"},{default:t(()=>[e("Site Config")]),_:1}),e(".")])]),n("li",null,[y,n("ul",null,[n("li",null,[a(s,{to:"/guide/i18n.html"},{default:t(()=>[e("Guide > I18n")]),_:1})])])])]),x,n("ul",null,[w,q,n("li",null,[T,D,n("p",null,[e("If set to "),S,e(", the initial color mode will be automatically set according to "),n("a",E,[e("prefers-color-scheme"),a(p)]),e(".")])]),I]),C,n("ul",null,[n("li",null,[e("Also see: "),n("ul",null,[n("li",null,[a(s,{to:"/guide/assets.html#public-files"},{default:t(()=>[e("Guide > Assets > Public Files")]),_:1})])])])]),L,n("ul",null,[N,n("li",null,[A,G,n("p",null,[e("The "),P,e(" will appear next to the repository button in the navbar when you set multiple "),a(s,{to:"/reference/config.html#locales"},{default:t(()=>[e("locales")]),_:1}),e(" in your site config.")])])]),R,n("ul",null,[j,M,n("li",null,[B,z,n("p",null,[e("You can override this global option via "),a(s,{to:"/reference/default-theme/frontmatter.html#sidebar"},{default:t(()=>[e("sidebar")]),_:1}),e(" frontmatter in your pages.")]),Y]),U]),F,n("ul",null,[V,H,n("li",null,[W,n("p",null,[e("The max value depends on which levels of headers you have extracted via "),a(s,{to:"/reference/config.html#markdown-headers"},{default:t(()=>[e("markdown.headers.level")]),_:1}),e(".")]),O,n("p",null,[e("You can override this global option via "),a(s,{to:"/reference/default-theme/frontmatter.html#sidebardepth"},{default:t(()=>[e("sidebarDepth")]),_:1}),e(" frontmatter in your pages.")])])]),Z,n("ul",null,[X,$,n("li",null,[J,K,n("p",null,[e("You can override this global option via "),a(s,{to:"/reference/default-theme/frontmatter.html#editlink"},{default:t(()=>[e("editLink")]),_:1}),e(" frontmatter in your pages.")])])]),Q,n("ul",null,[nn,en,n("li",null,[an,sn,n("p",null,[e("You can override this global option via "),a(s,{to:"/reference/default-theme/frontmatter.html#lastupdated"},{default:t(()=>[e("lastUpdated")]),_:1}),e(" frontmatter in your pages. Notice that if you have already set this option to "),tn,e(", this feature will be disabled totally and could not be enabled in locales nor page frontmatter.")])])]),ln,n("ul",null,[on,pn,n("li",null,[cn,un,n("p",null,[e("You can override this global option via "),a(s,{to:"/reference/default-theme/frontmatter.html#contributors"},{default:t(()=>[e("contributors")]),_:1}),e(" frontmatter in your pages. Notice that if you have already set this option to "),dn,e(", this feature will be disabled totally and could not be enabled in locales nor page frontmatter.")])])]),rn,n("ul",null,[hn,mn,n("li",null,[kn,n("p",null,[e("Specify the default title of the tip "),a(s,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:t(()=>[e("custom containers")]),_:1}),e(".")])])]),bn,n("ul",null,[vn,fn,n("li",null,[gn,n("p",null,[e("Specify the default title of the warning "),a(s,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:t(()=>[e("custom containers")]),_:1}),e(".")])])]),_n,n("ul",null,[yn,xn,n("li",null,[wn,n("p",null,[e("Specify the default title of the danger "),a(s,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:t(()=>[e("custom containers")]),_:1}),e(".")])])]),qn,n("ul",null,[Tn,Dn,n("li",null,[Sn,n("p",null,[e("Specify the "),En,e(" text of the "),a(s,{to:"/reference/plugin/external-link-icon.html#externallinkicon"},{default:t(()=>[e("ExternalLinkIcon")]),_:1}),e(".")]),In]),Cn]),Ln,n("ul",null,[Nn,An,n("li",null,[Gn,n("p",null,[e("Enable "),a(s,{to:"/reference/plugin/active-header-links.html"},{default:t(()=>[e("@vuepress/plugin-active-header-links")]),_:1}),e(" or not.")])])]),Pn,n("ul",null,[Rn,jn,n("li",null,[Mn,n("p",null,[e("Enable "),a(s,{to:"/reference/plugin/back-to-top.html"},{default:t(()=>[e("@vuepress/plugin-back-to-top")]),_:1}),e(" or not.")])])]),Bn,n("ul",null,[zn,n("li",null,[Yn,n("p",null,[e("Enable custom containers that powered by "),a(s,{to:"/reference/plugin/container.html"},{default:t(()=>[e("@vuepress/plugin-container")]),_:1}),e(" or not.")]),Un]),n("li",null,[Fn,n("ul",null,[n("li",null,[a(s,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:t(()=>[e("Default Theme > Markdown > Custom Containers")]),_:1})])])])]),Vn,n("ul",null,[Hn,Wn,n("li",null,[On,n("p",null,[e("Enable "),a(s,{to:"/reference/plugin/external-link-icon.html"},{default:t(()=>[e("@vuepress/plugin-external-link-icon")]),_:1}),e(" or not.")])])]),Zn,n("ul",null,[Xn,$n,n("li",null,[Jn,n("p",null,[e("Enable "),a(s,{to:"/reference/plugin/git.html"},{default:t(()=>[e("@vuepress/plugin-git")]),_:1}),e(" or not.")])])]),Kn,n("ul",null,[Qn,ne,n("li",null,[ee,n("p",null,[e("Enable "),a(s,{to:"/reference/plugin/medium-zoom.html"},{default:t(()=>[e("@vuepress/plugin-medium-zoom")]),_:1}),e(" or not.")])])]),ae,n("ul",null,[se,te,n("li",null,[le,n("p",null,[e("Enable "),a(s,{to:"/reference/plugin/nprogress.html"},{default:t(()=>[e("@vuepress/plugin-nprogress")]),_:1}),e(" or not.")])])])])}const ue=c(r,[["render",oe],["__file","config.html.vue"]]);export{ue as default};
diff --git a/assets/configuration.html-0d5a74e7.js b/assets/configuration.html-0d5a74e7.js
new file mode 100644
index 00000000..a85c743d
--- /dev/null
+++ b/assets/configuration.html-0d5a74e7.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-81f65e84","path":"/zh/guide/configuration.html","title":"配置","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:gear","description":"配置文件 如果没有任何配置，你的 VuePress 站点仅有一些最基础的功能。为了更好地自定义你的网站，让我们首先在你的文档目录下创建一个 .vuepress 目录，所有 VuePress 相关的文件都将会被放在这里。你的项目结构可能是这样： VuePress 站点的基本配置文件是 .vuepress/config.js ，但也同样支持 TypeScr...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/configuration.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/configuration.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"配置"}],["meta",{"property":"og:description","content":"配置文件 如果没有任何配置，你的 VuePress 站点仅有一些最基础的功能。为了更好地自定义你的网站，让我们首先在你的文档目录下创建一个 .vuepress 目录，所有 VuePress 相关的文件都将会被放在这里。你的项目结构可能是这样： VuePress 站点的基本配置文件是 .vuepress/config.js ，但也同样支持 TypeScr..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"配置\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"配置文件","slug":"配置文件","link":"#配置文件","children":[]},{"level":2,"title":"客户端配置文件","slug":"客户端配置文件","link":"#客户端配置文件","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.72,"words":517},"filePathRelative":"zh/guide/configuration.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/configuration.html-59431c6a.js b/assets/configuration.html-59431c6a.js
new file mode 100644
index 00000000..84c16d2b
--- /dev/null
+++ b/assets/configuration.html-59431c6a.js
@@ -0,0 +1,29 @@
+import{_ as t,W as c,X as l,$ as e,a0 as n,Y as i,Z as a,a1 as o,D as p}from"./framework-46b0e263.js";const r={},u=o(`
Without any configuration, the VuePress site is pretty minimal. To customize your site, let’s first create a .vuepress directory inside your docs directory. This is where all VuePress-specific files will be placed. Your project structure is probably like this:
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 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),m={class:"hint-container tip"},h=e("p",{class:"hint-container-title"},"Tips",-1),b=e("p",null,"Unlike config file, client config file could not be specified via CLI options.",-1);function _(y,w){const s=p("RouterLink");return c(),l("div",null,[u,e("p",null,[n("You can also specify the config file via "),d,n(" option of "),i(s,{to:"/reference/cli.html"},{default:a(()=>[n("CLI")]),_:1}),n(":")]),f,e("div",v,[g,e("p",null,[n("Check out the "),i(s,{to:"/reference/config.html"},{default:a(()=>[n("Config Reference")]),_:1}),n(" for a full list of VuePress config.")])]),k,e("div",m,[h,b,e("p",null,[n("To learn more about client config file, see "),i(s,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:a(()=>[n("Advanced > Cookbook > Usage of Client Config")]),_:1})])])])}const C=t(r,[["render",_],["__file","configuration.html.vue"]]);export{C as default};
diff --git a/assets/configuration.html-782c9432.js b/assets/configuration.html-782c9432.js
new file mode 100644
index 00000000..a7a10394
--- /dev/null
+++ b/assets/configuration.html-782c9432.js
@@ -0,0 +1,29 @@
+import{_ as o,W as c,X as l,$ as s,a0 as n,Y as a,Z as t,a1 as i,D as p}from"./framework-46b0e263.js";const d={},u=i(`
`,7),h={class:"hint-container tip"},f=s("p",{class:"hint-container-title"},"提示",-1),b=s("p",null,"和配置文件不同，客户端配置文件不能通过命令行接口的选项来指定。",-1);function _(x,j){const e=p("RouterLink");return c(),l("div",null,[u,s("p",null,[n("你也可以通过 "),a(e,{to:"/zh/reference/cli.html"},{default:t(()=>[n("命令行接口")]),_:1}),n(" 的 "),r,n(" 选项来指定配置文件：")]),v,s("div",k,[m,s("p",null,[n("前往 "),a(e,{to:"/zh/reference/config.html"},{default:t(()=>[n("配置参考")]),_:1}),n(" 查看所有 VuePress 配置。")])]),g,s("div",h,[f,b,s("p",null,[n("可以前往 "),a(e,{to:"/zh/advanced/cookbook/usage-of-client-config.html"},{default:t(()=>[n("深入 > Cookbook > 客户端配置的使用方法")]),_:1}),n(" 来了解更多信息。")])])])}const V=o(d,[["render",_],["__file","configuration.html.vue"]]);export{V as default};
diff --git a/assets/configuration.html-8cfe2e2f.js b/assets/configuration.html-8cfe2e2f.js
new file mode 100644
index 00000000..ed67bc9c
--- /dev/null
+++ b/assets/configuration.html-8cfe2e2f.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4f4ccb8f","path":"/guide/configuration.html","title":"Configuration","lang":"en-US","frontmatter":{"icon":"fa6-solid:gear","description":"Config File Without any configuration, the VuePress site is pretty minimal. To customize your site, let’s first create a .vuepress directory inside your docs directory. This is ...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/configuration.html"}],["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":"Config File Without any configuration, the VuePress site is pretty minimal. To customize your site, let’s first create a .vuepress directory inside your docs directory. This is ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Configuration\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Config File","slug":"config-file","link":"#config-file","children":[]},{"level":2,"title":"Client Config File","slug":"client-config-file","link":"#client-config-file","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.11,"words":332},"filePathRelative":"guide/configuration.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/container.html-343c4b32.js b/assets/container.html-343c4b32.js
new file mode 100644
index 00000000..9efb445c
--- /dev/null
+++ b/assets/container.html-343c4b32.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3df91977","path":"/reference/plugin/container.html","title":"container","lang":"en-US","frontmatter":{"description":"Register markdown custom containers in your VuePress site. This plugin simplifies the use of markdown-it-container (https://github.com/markdown-it/markdown-it-container), but al...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/container.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/container.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"container"}],["meta",{"property":"og:description","content":"Register markdown custom containers in your VuePress site. This plugin simplifies the use of markdown-it-container (https://github.com/markdown-it/markdown-it-container), but al..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"container\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Container Syntax","slug":"container-syntax","link":"#container-syntax","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"type","slug":"type","link":"#type","children":[]},{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]},{"level":3,"title":"before","slug":"before","link":"#before","children":[]},{"level":3,"title":"after","slug":"after","link":"#after","children":[]},{"level":3,"title":"render","slug":"render","link":"#render","children":[]},{"level":3,"title":"validate","slug":"validate","link":"#validate","children":[]},{"level":3,"title":"marker","slug":"marker","link":"#marker","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.51,"words":452},"filePathRelative":"reference/plugin/container.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/container.html-3cbbe523.js b/assets/container.html-3cbbe523.js
new file mode 100644
index 00000000..eb6edc22
--- /dev/null
+++ b/assets/container.html-3cbbe523.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-b10e9d30","path":"/zh/reference/plugin/container.html","title":"container","lang":"zh-CN","frontmatter":{"description":"为你的 VuePress 站点注册自定义容器。 该插件简化了 markdown-it-container (https://github.com/markdown-it/markdown-it-container) 的使用方法，但同时也保留了其原本的能力。 默认主题的 自定义容器 (../default-theme/markdown.md#自定义容器)...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/container.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/container.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"container"}],["meta",{"property":"og:description","content":"为你的 VuePress 站点注册自定义容器。 该插件简化了 markdown-it-container (https://github.com/markdown-it/markdown-it-container) 的使用方法，但同时也保留了其原本的能力。 默认主题的 自定义容器 (../default-theme/markdown.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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"container\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"容器语法","slug":"容器语法","link":"#容器语法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"type","slug":"type","link":"#type","children":[]},{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]},{"level":3,"title":"before","slug":"before","link":"#before","children":[]},{"level":3,"title":"after","slug":"after","link":"#after","children":[]},{"level":3,"title":"render","slug":"render","link":"#render","children":[]},{"level":3,"title":"validate","slug":"validate","link":"#validate","children":[]},{"level":3,"title":"marker","slug":"marker","link":"#marker","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.98,"words":594},"filePathRelative":"zh/reference/plugin/container.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/container.html-78c33ddf.js b/assets/container.html-78c33ddf.js
new file mode 100644
index 00000000..e716ab8b
--- /dev/null
+++ b/assets/container.html-78c33ddf.js
@@ -0,0 +1,42 @@
+import{_ as c,W as r,X as u,Y as s,$ as n,a0 as a,Z as p,a1 as o,D as t}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"container",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#container","aria-hidden":"true"},"#"),a(" container")],-1),h=n("p",null,"Register markdown custom containers in your VuePress site.",-1),m={href:"https://github.com/markdown-it/markdown-it-container",target:"_blank",rel:"noopener noreferrer"},v=o(`
`,9),f=n("li",null,[n("p",null,[a("Type: "),n("code",null,"string")])],-1),g=n("p",null,"Details:",-1),b=n("p",null,"The type of the container.",-1),_=n("code",null,"name",-1),y={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},w=o(`
`,11),T=n("p",null,"Details:",-1),q=n("code",null,"render",-1),I={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},D=n("p",null,[a("This plugin uses a default "),n("code",null,"render"),a(" function. If you specify this option, the default "),n("code",null,"render"),a(" function will be replaced, and the "),n("a",{href:"#locales"},"locales"),a(", "),n("a",{href:"#before"},"before"),a(" and "),n("a",{href:"#after"},"after"),a(" options will be ignored.")],-1),C=n("h3",{id:"validate",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#validate","aria-hidden":"true"},"#"),a(" validate")],-1),N=n("li",null,[n("p",null,[a("Type: "),n("code",null,"(params: string) => boolean")])],-1),R=n("p",null,"Details:",-1),B=n("code",null,"validate",-1),E={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},P=n("h3",{id:"marker",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#marker","aria-hidden":"true"},"#"),a(" marker")],-1),V=n("li",null,[n("p",null,[a("Type: "),n("code",null,"string")])],-1),L=n("p",null,"Details:",-1),$=n("code",null,"marker",-1),A={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"};function M(S,z){const l=t("NpmBadge"),e=t("ExternalLinkIcon"),i=t("RouterLink");return r(),u("div",null,[k,s(l,{package:"@vuepress/plugin-container"}),h,n("p",null,[a("This plugin simplifies the use of "),n("a",m,[a("markdown-it-container"),s(e)]),a(", but also retains its original capabilities.")]),n("p",null,[a("The "),s(i,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:p(()=>[a("Custom Containers")]),_:1}),a(" of default theme is powered by this plugin.")]),v,n("ul",null,[f,n("li",null,[g,b,n("p",null,[a("It will be used as the "),_,a(" param of "),n("a",y,[a("markdown-it-container"),s(e)]),a(".")])])]),w,n("ul",null,[n("li",null,[a("Also see: "),n("ul",null,[n("li",null,[s(i,{to:"/guide/i18n.html"},{default:p(()=>[a("Guide > I18n")]),_:1})])])])]),x,n("ul",null,[n("li",null,[T,n("p",null,[a("The "),q,a(" option of "),n("a",I,[a("markdown-it-container"),s(e)]),a(".")]),D])]),C,n("ul",null,[N,n("li",null,[R,n("p",null,[a("The "),B,a(" option of "),n("a",E,[a("markdown-it-container"),s(e)]),a(".")])])]),P,n("ul",null,[V,n("li",null,[L,n("p",null,[a("The "),$,a(" option of "),n("a",A,[a("markdown-it-container"),s(e)]),a(".")])])])])}const G=c(d,[["render",M],["__file","container.html.vue"]]);export{G as default};
diff --git a/assets/container.html-98692cc1.js b/assets/container.html-98692cc1.js
new file mode 100644
index 00000000..cb4b0dbc
--- /dev/null
+++ b/assets/container.html-98692cc1.js
@@ -0,0 +1,42 @@
+import{_ as c,W as r,X as u,Y as s,$ as n,a0 as a,Z as p,a1 as o,D as t}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"container",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#container","aria-hidden":"true"},"#"),a(" container")],-1),h=n("p",null,"为你的 VuePress 站点注册自定义容器。",-1),v={href:"https://github.com/markdown-it/markdown-it-container",target:"_blank",rel:"noopener noreferrer"},m=o(`
`,11),E=n("p",null,"详情：",-1),q={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},A=n("code",null,"render",-1),B=n("p",null,[a("该插件使用了一个默认的 "),n("code",null,"render"),a(" 函数。但如果你指定了该配置项，那么默认的 "),n("code",null,"render"),a(" 函数就会被替换掉，此时 "),n("a",{href:"#locales"},"locales"),a(" 、 "),n("a",{href:"#before"},"before"),a(" 和 "),n("a",{href:"#after"},"after"),a(" 配置项都会被忽略。")],-1),I=n("h3",{id:"validate",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#validate","aria-hidden":"true"},"#"),a(" validate")],-1),N=n("li",null,[n("p",null,[a("类型： "),n("code",null,"(params: string) => boolean")])],-1),P=n("p",null,"详情：",-1),R={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},V=n("code",null,"validate",-1),D=n("h3",{id:"marker",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#marker","aria-hidden":"true"},"#"),a(" marker")],-1),L=n("li",null,[n("p",null,[a("类型： "),n("code",null,"string")])],-1),$=n("p",null,"详情：",-1),z={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},C=n("code",null,"marker",-1);function F(M,T){const l=t("NpmBadge"),e=t("ExternalLinkIcon"),i=t("RouterLink");return r(),u("div",null,[k,s(l,{package:"@vuepress/plugin-container"}),h,n("p",null,[a("该插件简化了 "),n("a",v,[a("markdown-it-container"),s(e)]),a(" 的使用方法，但同时也保留了其原本的能力。")]),n("p",null,[a("默认主题的 "),s(i,{to:"/zh/reference/default-theme/markdown.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%B9%E5%99%A8"},{default:p(()=>[a("自定义容器")]),_:1}),a(" 就是由该插件支持的。")]),m,n("ul",null,[g,n("li",null,[b,f,n("p",null,[a("它将会被用作 "),n("a",_,[a("markdown-it-container"),s(e)]),a(" 的 "),y,a(" 参数。")])])]),w,n("ul",null,[n("li",null,[a("参考： "),n("ul",null,[n("li",null,[s(i,{to:"/zh/guide/i18n.html"},{default:p(()=>[a("指南 > 多语言支持")]),_:1})])])])]),x,n("ul",null,[n("li",null,[E,n("p",null,[n("a",q,[a("markdown-it-container"),s(e)]),a(" 的 "),A,a(" 配置项。")]),B])]),I,n("ul",null,[N,n("li",null,[P,n("p",null,[n("a",R,[a("markdown-it-container"),s(e)]),a(" 的 "),V,a(" 配置项。")])])]),D,n("ul",null,[L,n("li",null,[$,n("p",null,[n("a",z,[a("markdown-it-container"),s(e)]),a(" 的 "),C,a(" 配置项。")])])])])}const W=c(d,[["render",F],["__file","container.html.vue"]]);export{W as default};
diff --git a/assets/contributing.html-4ed8de19.js b/assets/contributing.html-4ed8de19.js
new file mode 100644
index 00000000..65e3afd9
--- /dev/null
+++ b/assets/contributing.html-4ed8de19.js
@@ -0,0 +1,4 @@
+import{_ as d,W as r,X as i,$ as o,a0 as e,Y as s,a1 as n,D as a}from"./framework-46b0e263.js";const c={},l=o("h1",{id:"contributing-guide",tabindex:"-1"},[o("a",{class:"header-anchor",href:"#contributing-guide","aria-hidden":"true"},"#"),e(" Contributing Guide")],-1),p=o("h2",{id:"overview",tabindex:"-1"},[o("a",{class:"header-anchor",href:"#overview","aria-hidden":"true"},"#"),e(" Overview")],-1),h={href:"https://en.wikipedia.org/wiki/Monorepo",target:"_blank",rel:"noopener noreferrer"},u={href:"https://pnpm.io/workspaces",target:"_blank",rel:"noopener noreferrer"},m=n('
In the packages directory:
bundler-vite: The VuePress bundler package with vite. Use vite to dev and build VuePress app that generated by @vuepress/core.
bundler-webpack: The VuePress bundler package with webpack. Use webpack to dev and build VuePress app that generated by @vuepress/core.
cli: The VuePress command line interface (CLI) package. It will resolve user config file, and create VuePress app with @vuepress/core, then execute corresponding command.
client: The VuePress client package. Provides the client entry, and exports types and composable utils that can be used in client side development.
core: The VuePress core. Provides pure Node API to generate VuePress app, including page handling, plugin system and data preparation.
markdown: The VuePress markdown package. Use markdown-it as the markdown parser and integrate some plugins to be used in VuePress.
shared: Utilities that shared between node side and client side.
utils: Utilities that should only be used in node side.
In the ecosystem directory:
plugin-${name}: Official plugins.
theme-default: The default theme.
vuepress: A wrapper of vuepress-vite.
vuepress-vite: A wrapper of @vuepress/cli + @vuepress/bundler-vite + @vuepress/theme-default. If users want to use default theme with vite, they can simply install this package.
vuepress-webpack: A wrapper of @vuepress/cli + @vuepress/bundler-webpack + @vuepress/theme-default. If users want to use default theme with webpack, they can simply install this package.
The build script uses tsc and tsup to compile TypeScript source files to JavaScript dist files.
Also, it will copy necessary resources from source directory to dist directory, because some source files (e.g. .vue, .css files) would not be processed by tsc nor tsup, but should keep the same relative path in the dist directory.
You may need to run this script first after your clone this repository, because the dist files are ignored by .gitignore.
The clean script runs clean script in all packages, cleaning all the dist files and caches. In other words, it will remove all the files that generated by build, copy scripts.
It's used before you want to re-build source files from a clean / initial state.
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:
',25),V={href:"https://www.netlify.com",target:"_blank",rel:"noopener noreferrer"},T={href:"https://v2.vuepress.vuejs.org",target:"_blank",rel:"noopener noreferrer"},I={href:"https://pages.github.com",target:"_blank",rel:"noopener noreferrer"},S={href:"https://vuepress.github.io",target:"_blank",rel:"noopener noreferrer"};function N(A,C){const t=a("ExternalLinkIcon");return r(),i("div",null,[l,p,o("p",null,[e("This repository employs a "),o("a",h,[e("monorepo"),s(t)]),e(" setup with "),o("a",u,[e("pnpm workspaces"),s(t)]),e(", and hosts a number of associated but separated packages.")]),m,o("ul",null,[o("li",null,[o("a",b,[e("Node.js"),s(t)]),e(),f]),o("li",null,[o("a",v,[e("pnpm"),s(t)]),e(),g])]),_,o("ul",null,[o("li",null,[o("a",w,[e("TypeScript"),s(t)]),e(" as the development language")]),o("li",null,[o("a",k,[e("Vitest"),s(t)]),e(" for unit testing")]),o("li",null,[o("a",y,[e("ESLint"),s(t)]),e(" + "),o("a",x,[e("Prettier"),s(t)]),e(" for code linting and formatting")])]),P,o("ul",null,[o("li",null,[e("Release deployment powered by "),o("a",V,[e("Netlify"),s(t)]),e(". This deployment is built from the latest released version, so users will not see unreleased changes. The domain name is "),o("a",T,[e("https://v2.vuepress.vuejs.org"),s(t)]),e(".")]),o("li",null,[e("Developer deployment powered by "),o("a",I,[e("GitHub Pages"),s(t)]),e(". This deployment is built from the latest commit, so developers could preview the latest changes. The domain name is "),o("a",S,[e("https://vuepress.github.io"),s(t)]),e(".")])])])}const U=d(c,[["render",N],["__file","contributing.html.vue"]]);export{U as default};
diff --git a/assets/contributing.html-6dc0f72e.js b/assets/contributing.html-6dc0f72e.js
new file mode 100644
index 00000000..2e60f250
--- /dev/null
+++ b/assets/contributing.html-6dc0f72e.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-e012c1f2","path":"/zh/contributing.html","title":"贡献指南","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:signs-post","sidebar":"auto","description":"概览 项目仓库借助于 pnpm 工作空间 (https://pnpm.io/zh/workspaces) 来实现 Monorepo (https://en.wikipedia.org/wiki/Monorepo) ，存放了多个互相关联的独立 Package 。 在 packages 目录下： bundler-vite: 基于 Vite 的 Bundle...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/contributing.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/contributing.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"贡献指南"}],["meta",{"property":"og:description","content":"概览 项目仓库借助于 pnpm 工作空间 (https://pnpm.io/zh/workspaces) 来实现 Monorepo (https://en.wikipedia.org/wiki/Monorepo) ，存放了多个互相关联的独立 Package 。 在 packages 目录下： bundler-vite: 基于 Vite 的 Bundle..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"贡献指南\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"概览","slug":"概览","link":"#概览","children":[]},{"level":2,"title":"开发配置","slug":"开发配置","link":"#开发配置","children":[]},{"level":2,"title":"开发脚本","slug":"开发脚本","link":"#开发脚本","children":[{"level":3,"title":"pnpm build","slug":"pnpm-build","link":"#pnpm-build","children":[]},{"level":3,"title":"pnpm clean","slug":"pnpm-clean","link":"#pnpm-clean","children":[]},{"level":3,"title":"pnpm docs:*","slug":"pnpm-docs","link":"#pnpm-docs","children":[]},{"level":3,"title":"pnpm lint","slug":"pnpm-lint","link":"#pnpm-lint","children":[]},{"level":3,"title":"pnpm test","slug":"pnpm-test","link":"#pnpm-test","children":[]}]},{"level":2,"title":"文档","slug":"文档","link":"#文档","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":3.46,"words":1038},"filePathRelative":"zh/contributing.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/contributing.html-e03745b5.js b/assets/contributing.html-e03745b5.js
new file mode 100644
index 00000000..15cb7b17
--- /dev/null
+++ b/assets/contributing.html-e03745b5.js
@@ -0,0 +1,4 @@
+import{_ as r,W as a,X as s,$ as o,a0 as e,Y as n,a1 as c,D as t}from"./framework-46b0e263.js";const i={},p=o("h1",{id:"贡献指南",tabindex:"-1"},[o("a",{class:"header-anchor",href:"#贡献指南","aria-hidden":"true"},"#"),e(" 贡献指南")],-1),l=o("h2",{id:"概览",tabindex:"-1"},[o("a",{class:"header-anchor",href:"#概览","aria-hidden":"true"},"#"),e(" 概览")],-1),h={href:"https://pnpm.io/zh/workspaces",target:"_blank",rel:"noopener noreferrer"},u={href:"https://en.wikipedia.org/wiki/Monorepo",target:"_blank",rel:"noopener noreferrer"},b=c('
在 packages 目录下：
bundler-vite: 基于 Vite 的 Bundler 模块。使用 Vite 对 VuePress App 执行 dev 和 build 操作。
',25),N={href:"https://www.netlify.com",target:"_blank",rel:"noopener noreferrer"},y={href:"https://v2.vuepress.vuejs.org",target:"_blank",rel:"noopener noreferrer"},S={href:"https://pages.github.com",target:"_blank",rel:"noopener noreferrer"},A={href:"https://vuepress.github.io",target:"_blank",rel:"noopener noreferrer"};function B(C,E){const d=t("ExternalLinkIcon");return a(),s("div",null,[p,l,o("p",null,[e("项目仓库借助于 "),o("a",h,[e("pnpm 工作空间"),n(d)]),e(" 来实现 "),o("a",u,[e("Monorepo"),n(d)]),e(" ，存放了多个互相关联的独立 Package 。")]),b,o("ul",null,[o("li",null,[o("a",m,[e("Node.js"),n(d)]),e(),_]),o("li",null,[o("a",v,[e("pnpm"),n(d)]),e(),f])]),g,o("ul",null,[o("li",null,[o("a",k,[e("TypeScript"),n(d)]),e(" 作为开发语言")]),o("li",null,[o("a",x,[e("Vitest"),n(d)]),e(" 用于单元测试")]),o("li",null,[o("a",V,[e("ESLint"),n(d)]),e(" + "),o("a",w,[e("Prettier"),n(d)]),e(" 用于代码检查和格式化")])]),P,o("ul",null,[o("li",null,[e("在 "),o("a",N,[e("Netlify"),n(d)]),e(" 部署的 Release 版本。该站点是从最新发布的版本中构建而来，因此用户不会看到未发布的改动。域名为 "),o("a",y,[e("https://v2.vuepress.vuejs.org"),n(d)]),e("。")]),o("li",null,[e("在 "),o("a",S,[e("GitHub Pages"),n(d)]),e(" 部署的 Developer 版本。该站点是从最新的提交中构建而来，因此开发者可以预览最新的改动。域名为 "),o("a",A,[e("https://vuepress.github.io"),n(d)]),e("。")])])])}const M=r(i,[["render",B],["__file","contributing.html.vue"]]);export{M as default};
diff --git a/assets/contributing.html-f20968df.js b/assets/contributing.html-f20968df.js
new file mode 100644
index 00000000..aa0c809b
--- /dev/null
+++ b/assets/contributing.html-f20968df.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6ce48554","path":"/contributing.html","title":"Contributing Guide","lang":"en-US","frontmatter":{"icon":"fa6-solid:signs-post","sidebar":"auto","description":"Overview This repository employs a monorepo (https://en.wikipedia.org/wiki/Monorepo) setup with pnpm workspaces (https://pnpm.io/workspaces), and hosts a number of associated bu...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/contributing.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/contributing.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Contributing Guide"}],["meta",{"property":"og:description","content":"Overview This repository employs a monorepo (https://en.wikipedia.org/wiki/Monorepo) setup with pnpm workspaces (https://pnpm.io/workspaces), and hosts a number of associated bu..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Contributing Guide\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Overview","slug":"overview","link":"#overview","children":[]},{"level":2,"title":"Development Setup","slug":"development-setup","link":"#development-setup","children":[]},{"level":2,"title":"Scripts","slug":"scripts","link":"#scripts","children":[{"level":3,"title":"pnpm build","slug":"pnpm-build","link":"#pnpm-build","children":[]},{"level":3,"title":"pnpm clean","slug":"pnpm-clean","link":"#pnpm-clean","children":[]},{"level":3,"title":"pnpm docs:*","slug":"pnpm-docs","link":"#pnpm-docs","children":[]},{"level":3,"title":"pnpm lint","slug":"pnpm-lint","link":"#pnpm-lint","children":[]},{"level":3,"title":"pnpm test","slug":"pnpm-test","link":"#pnpm-test","children":[]}]},{"level":2,"title":"Documentation","slug":"documentation","link":"#documentation","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.34,"words":702},"filePathRelative":"contributing.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/deployment.html-24cc7f5b.js b/assets/deployment.html-24cc7f5b.js
new file mode 100644
index 00000000..1e67119e
--- /dev/null
+++ b/assets/deployment.html-24cc7f5b.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4a7b6bf9","path":"/zh/guide/deployment.html","title":"部署","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:rocket","description":"下述的指南基于以下条件： Markdown 源文件放置在你项目的 docs 目录；; 使用的是默认的构建输出目录 (.vuepress/dist) ；; 使用 pnpm (https://pnpm.io/zh/) 作为包管理器，当然也支持使用 npm 或 yarn 。; VuePress 作为项目依赖安装，并在 package.json 中配置了如下脚...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/deployment.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/deployment.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"部署"}],["meta",{"property":"og:description","content":"下述的指南基于以下条件： Markdown 源文件放置在你项目的 docs 目录；; 使用的是默认的构建输出目录 (.vuepress/dist) ；; 使用 pnpm (https://pnpm.io/zh/) 作为包管理器，当然也支持使用 npm 或 yarn 。; VuePress 作为项目依赖安装，并在 package.json 中配置了如下脚..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"部署\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"GitHub Pages","slug":"github-pages","link":"#github-pages","children":[]},{"level":2,"title":"GitLab Pages","slug":"gitlab-pages","link":"#gitlab-pages","children":[]},{"level":2,"title":"Google Firebase","slug":"google-firebase","link":"#google-firebase","children":[]},{"level":2,"title":"Heroku","slug":"heroku","link":"#heroku","children":[]},{"level":2,"title":"Kinsta","slug":"kinsta","link":"#kinsta","children":[]},{"level":2,"title":"Edgio","slug":"edgio","link":"#edgio","children":[]},{"level":2,"title":"Netlify","slug":"netlify","link":"#netlify","children":[]},{"level":2,"title":"Vercel","slug":"vercel","link":"#vercel","children":[]},{"level":2,"title":"云开发 CloudBase","slug":"云开发-cloudbase","link":"#云开发-cloudbase","children":[]},{"level":2,"title":"21 云盒子","slug":"_21-云盒子","link":"#_21-云盒子","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":4.36,"words":1309},"filePathRelative":"zh/guide/deployment.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/deployment.html-355f7597.js b/assets/deployment.html-355f7597.js
new file mode 100644
index 00000000..4cc71223
--- /dev/null
+++ b/assets/deployment.html-355f7597.js
@@ -0,0 +1,101 @@
+import{_ as c,W as p,X as u,$ as n,a0 as s,Y as e,Z as l,a1 as t,D as i}from"./framework-46b0e263.js";const r={},d=n("h1",{id:"deployment",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#deployment","aria-hidden":"true"},"#"),s(" Deployment")],-1),k=n("p",null,"The following guides are based on some shared assumptions:",-1),m=n("li",null,[s("You are placing your Markdown source files inside the "),n("code",null,"docs"),s(" directory of your project;")],-1),v=n("li",null,[s("You are using the default build output location ("),n("code",null,".vuepress/dist"),s(");")],-1),h={href:"https://pnpm.io",target:"_blank",rel:"noopener noreferrer"},b=n("li",null,[s("VuePress is installed as a local dependency in your project, and you have setup the following script in "),n("code",null,"package.json"),s(":")],-1),g=t(`
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),f={href:"https://github.com/features/actions",target:"_blank",rel:"noopener noreferrer"},y=n("p",null,[s("Create "),n("code",null,".github/workflows/docs.yml"),s(" to set up the workflow.")],-1),w=t(`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@v3
+ with:
+ # fetch all commits to get last updated time or other git log info
+ fetch-depth:0
+
+ -name: Setup pnpm
+ uses: pnpm/action-setup@v2
+ with:
+ # choose pnpm version to use
+ version:7
+ # install deps with pnpm
+ run_install:true
+
+ -name: Setup Node.js
+ uses: actions/setup-node@v3
+ with:
+ # choose node.js version to use
+ node-version:18
+ # cache deps for pnpm
+ cache: pnpm
+
+ # 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@v2
+ 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 }}
+
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),P=n("code",null,".gitlab-ci.yml",-1),I={href:"https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/",target:"_blank",rel:"noopener noreferrer"},N=t(`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 -f https://get.pnpm.io/v6.16.js | node - add --global pnpm@7
+ - 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
+
`,1),S={class:"hint-container tip"},C=n("p",{class:"hint-container-title"},"Tips",-1),O={href:"https://docs.gitlab.com/ce/user/project/pages/#getting-started",target:"_blank",rel:"noopener noreferrer"},H=n("h2",{id:"google-firebase",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#google-firebase","aria-hidden":"true"},"#"),s(" Google Firebase")],-1),G={href:"https://www.npmjs.com/package/firebase-tools",target:"_blank",rel:"noopener noreferrer"},T=n("li",null,[n("p",null,[s("Create "),n("code",null,"firebase.json"),s(" and "),n("code",null,".firebaserc"),s(" at the root of your project with the following content:")])],-1),U=t(`
After running pnpm docs:build, deploy using the command firebase deploy.
`,5),V={class:"hint-container tip"},A=n("p",{class:"hint-container-title"},"Tips",-1),M={href:"https://firebase.google.com/docs/cli",target:"_blank",rel:"noopener noreferrer"},L=n("h2",{id:"heroku",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#heroku","aria-hidden":"true"},"#"),s(" Heroku")],-1),B={href:"https://devcenter.heroku.com/articles/heroku-cli",target:"_blank",rel:"noopener noreferrer"},D={href:"https://signup.heroku.com",target:"_blank",rel:"noopener noreferrer"},Y=n("li",null,[n("p",null,[s("Run "),n("code",null,"heroku login"),s(" and fill in your Heroku credentials:")])],-1),F=t(`
heroku login
+
Create a file called static.json in the root of your project with the below content:
static.json:
{
+ "root":"./docs/.vuepress/dist"
+}
+
`,4),K={href:"https://github.com/heroku/heroku-buildpack-static",target:"_blank",rel:"noopener noreferrer"},z=n("h2",{id:"kinsta",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#kinsta","aria-hidden":"true"},"#"),s(" Kinsta")],-1),W={href:"https://kinsta.com/docs/vuepress-application/",target:"_blank",rel:"noopener noreferrer"},$=n("h2",{id:"edgio",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#edgio","aria-hidden":"true"},"#"),s(" Edgio")],-1),X={href:"https://docs.edg.io/guides/vuepress",target:"_blank",rel:"noopener noreferrer"},Z=n("h2",{id:"netlify",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#netlify","aria-hidden":"true"},"#"),s(" Netlify")],-1),J={href:"https://netlify.com",target:"_blank",rel:"noopener noreferrer"},Q=n("ul",null,[n("li",null,[n("strong",null,"Build Command:"),s(),n("code",null,"pnpm docs:build")]),n("li",null,[n("strong",null,"Publish directory:"),s(),n("code",null,"docs/.vuepress/dist")])],-1),nn={href:"https://docs.netlify.com/configure-builds/environment-variables",target:"_blank",rel:"noopener noreferrer"},sn=n("ul",null,[n("li",null,[n("code",null,"NODE_VERSION"),s(": 14")])],-1),en=n("li",null,[n("p",null,"Hit the deploy button.")],-1),an=n("h2",{id:"vercel",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vercel","aria-hidden":"true"},"#"),s(" Vercel")],-1),tn={href:"https://vercel.com",target:"_blank",rel:"noopener noreferrer"},on=n("ul",null,[n("li",null,[n("strong",null,"FRAMEWORK PRESET:"),s(),n("code",null,"Other")]),n("li",null,[n("strong",null,"BUILD COMMAND:"),s(),n("code",null,"pnpm docs:build")]),n("li",null,[n("strong",null,"OUTPUT DIRECTORY:"),s(),n("code",null,"docs/.vuepress/dist")])],-1),ln=n("li",null,[n("p",null,"Hit the deploy button.")],-1);function cn(pn,un){const a=i("ExternalLinkIcon"),o=i("RouterLink");return p(),u("div",null,[d,k,n("ul",null,[m,v,n("li",null,[s("You are using as "),n("a",h,[s("pnpm"),e(a)]),s(" package manager, while npm and yarn are also supported;")]),b]),g,n("ol",null,[n("li",null,[n("p",null,[s("Set the correct "),e(o,{to:"/reference/config.html#base"},{default:l(()=>[s("base")]),_:1}),s(" config.")]),_]),n("li",null,[n("p",null,[s("Choose your preferred CI tools. Here we take "),n("a",f,[s("GitHub Actions"),e(a)]),s(" as an example.")]),y])]),w,n("div",E,[q,n("p",null,[s("Please refer to "),n("a",j,[s("GitHub Pages official guide"),e(a)]),s(" for more details.")])]),x,n("ol",null,[n("li",null,[n("p",null,[s("Set the correct "),e(o,{to:"/reference/config.html#base"},{default:l(()=>[s("base")]),_:1}),s(" config.")]),R]),n("li",null,[n("p",null,[s("Create "),P,s(" to set up "),n("a",I,[s("GitLab CI"),e(a)]),s(" workflow.")])])]),N,n("div",S,[C,n("p",null,[s("Please refer to "),n("a",O,[s("GitLab Pages official guide"),e(a)]),s(" for more details.")])]),H,n("ol",null,[n("li",null,[n("p",null,[s("Make sure you have "),n("a",G,[s("firebase-tools"),e(a)]),s(" installed.")])]),T]),U,n("div",V,[A,n("p",null,[s("Please refer to "),n("a",M,[s("Firebase CLI official guide"),e(a)]),s(" for more details.")])]),L,n("ol",null,[n("li",null,[n("p",null,[s("Install "),n("a",B,[s("Heroku CLI"),e(a)]),s(".")])]),n("li",null,[n("p",null,[s("Create a Heroku account by "),n("a",D,[s("signing up"),e(a)]),s(".")])]),Y]),F,n("p",null,[s("This is the configuration of your site; read more at "),n("a",K,[s("heroku-buildpack-static"),e(a)]),s(".")]),z,n("p",null,[s("See "),n("a",W,[s("Set Up VuePress on Kinsta"),e(a)]),s(".")]),$,n("p",null,[s("See "),n("a",X,[s("Edgio Documentation > Framework Guides > VuePress"),e(a)]),s(".")]),Z,n("ol",null,[n("li",null,[n("p",null,[s("On "),n("a",J,[s("Netlify"),e(a)]),s(", set up a new project from GitHub with the following settings:")]),Q]),n("li",null,[n("p",null,[s("Set "),n("a",nn,[s("Environment variables"),e(a)]),s(" to choose node version:")]),sn]),en]),an,n("ol",null,[n("li",null,[n("p",null,[s("Go to "),n("a",tn,[s("Vercel"),e(a)]),s(", set up a new project from GitHub with the following settings:")]),on]),ln])])}const dn=c(r,[["render",cn],["__file","deployment.html.vue"]]);export{dn as default};
diff --git a/assets/deployment.html-69247d56.js b/assets/deployment.html-69247d56.js
new file mode 100644
index 00000000..c323f336
--- /dev/null
+++ b/assets/deployment.html-69247d56.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-e8a66a70","path":"/guide/deployment.html","title":"Deployment","lang":"en-US","frontmatter":{"icon":"fa6-solid:rocket","description":"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...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/deployment.html"}],["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":"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..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Deployment\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"GitHub Pages","slug":"github-pages","link":"#github-pages","children":[]},{"level":2,"title":"GitLab Pages","slug":"gitlab-pages","link":"#gitlab-pages","children":[]},{"level":2,"title":"Google Firebase","slug":"google-firebase","link":"#google-firebase","children":[]},{"level":2,"title":"Heroku","slug":"heroku","link":"#heroku","children":[]},{"level":2,"title":"Kinsta","slug":"kinsta","link":"#kinsta","children":[]},{"level":2,"title":"Edgio","slug":"edgio","link":"#edgio","children":[]},{"level":2,"title":"Netlify","slug":"netlify","link":"#netlify","children":[]},{"level":2,"title":"Vercel","slug":"vercel","link":"#vercel","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.63,"words":788},"filePathRelative":"guide/deployment.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/deployment.html-868cba60.js b/assets/deployment.html-868cba60.js
new file mode 100644
index 00000000..52f39f4e
--- /dev/null
+++ b/assets/deployment.html-868cba60.js
@@ -0,0 +1,104 @@
+import{_ as c,W as p,X as u,$ as n,a0 as s,Y as e,Z as o,a2 as r,a1 as t,D as i}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"部署",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#部署","aria-hidden":"true"},"#"),s(" 部署")],-1),v=n("p",null,"下述的指南基于以下条件：",-1),m=n("li",null,[s("Markdown 源文件放置在你项目的 "),n("code",null,"docs"),s(" 目录；")],-1),h=n("li",null,[s("使用的是默认的构建输出目录 ("),n("code",null,".vuepress/dist"),s(") ；")],-1),b={href:"https://pnpm.io/zh/",target:"_blank",rel:"noopener noreferrer"},_=n("li",null,[s("VuePress 作为项目依赖安装，并在 "),n("code",null,"package.json"),s(" 中配置了如下脚本：")],-1),g=t(`
newCrawler({
+ appId:'YOUR_APP_ID',
+ apiKey:'YOUR_API_KEY',
+ rateLimit:8,
+ startUrls:[
+ // These are urls which algolia start to craw
+ // If your site is divided in to mutiple parts,
+ // you may want to set mutiple entry links
+ 'https://YOUR_WEBSITE_URL/',
+ ],
+ sitemaps:[
+ // if you are using sitemap plugins (e.g.: vuepress-plugin-sitemap2), you may provide one
+ 'https://YOUR_WEBSITE_URL/sitemap.xml',
+ ],
+ ignoreCanonicalTo:false,
+ exclusionPatterns:[
+ // You can use this to stop algolia crawing some paths
+ ],
+ discoveryPatterns:[
+ // These are urls which algolia looking for,
+ 'https://YOUR_WEBSITE_URL/**',
+ ],
+ // Crawler schedule, set it according to your docs update frequency
+ schedule:'at 02:00 every 1 day',
+ actions:[
+ // you may have mutiple actions, especially when you are deploying mutiple docs under one domain
+ {
+ // name the index with name you like
+ indexName:'YOUR_INDEX_NAME',
+ // paths where the index take effect
+ pathsToMatch:['https://YOUR_WEBSITE_URL/**'],
+ // controls how algolia extracts records from your site
+ recordExtractor:({ $, helpers })=>{
+ // options for @vuepress/theme-default
+ return helpers.docsearch({
+ recordProps:{
+ lvl0:{
+ selectors:'.sidebar-heading.active',
+ defaultValue:'Documentation',
+ },
+ lvl1:'.theme-default-content h1',
+ lvl2:'.theme-default-content h2',
+ lvl3:'.theme-default-content h3',
+ lvl4:'.theme-default-content h4',
+ lvl5:'.theme-default-content h5',
+ lvl6:'.theme-default-content h6',
+ content:'.theme-default-content p, .theme-default-content li',
+ },
+ indexHeadings:true,
+ })
+ },
+ },
+ ],
+ initialIndexSettings:{
+ // controls how index are initialized
+ // only has effects before index are initialize
+ // you may need to delete your index and recraw after modification
+ YOUR_INDEX_NAME:{
+ attributesForFaceting:['type','lang'],
+ attributesToRetrieve:['hierarchy','content','anchor','url'],
+ attributesToHighlight:['hierarchy','hierarchy_camel','content'],
+ attributesToSnippet:['content:10'],
+ camelCaseAttributes:['hierarchy','hierarchy_radio','content'],
+ searchableAttributes:[
+ 'unordered(hierarchy_radio_camel.lvl0)',
+ 'unordered(hierarchy_radio.lvl0)',
+ 'unordered(hierarchy_radio_camel.lvl1)',
+ 'unordered(hierarchy_radio.lvl1)',
+ 'unordered(hierarchy_radio_camel.lvl2)',
+ 'unordered(hierarchy_radio.lvl2)',
+ 'unordered(hierarchy_radio_camel.lvl3)',
+ 'unordered(hierarchy_radio.lvl3)',
+ 'unordered(hierarchy_radio_camel.lvl4)',
+ 'unordered(hierarchy_radio.lvl4)',
+ 'unordered(hierarchy_radio_camel.lvl5)',
+ 'unordered(hierarchy_radio.lvl5)',
+ 'unordered(hierarchy_radio_camel.lvl6)',
+ 'unordered(hierarchy_radio.lvl6)',
+ 'unordered(hierarchy_camel.lvl0)',
+ 'unordered(hierarchy.lvl0)',
+ 'unordered(hierarchy_camel.lvl1)',
+ 'unordered(hierarchy.lvl1)',
+ 'unordered(hierarchy_camel.lvl2)',
+ 'unordered(hierarchy.lvl2)',
+ 'unordered(hierarchy_camel.lvl3)',
+ 'unordered(hierarchy.lvl3)',
+ 'unordered(hierarchy_camel.lvl4)',
+ 'unordered(hierarchy.lvl4)',
+ 'unordered(hierarchy_camel.lvl5)',
+ 'unordered(hierarchy.lvl5)',
+ 'unordered(hierarchy_camel.lvl6)',
+ 'unordered(hierarchy.lvl6)',
+ 'content',
+ ],
+ distinct:true,
+ attributeForDistinct:'url',
+ customRanking:[
+ 'desc(weight.pageRank)',
+ 'desc(weight.level)',
+ 'asc(weight.position)',
+ ],
+ ranking:[
+ 'words',
+ 'filters',
+ 'typo',
+ 'attribute',
+ 'proximity',
+ 'exact',
+ 'custom',
+ ],
+ highlightPreTag:'<span class="algolia-docsearch-suggestion--highlight">',
+ highlightPostTag:'</span>',
+ minWordSizefor1Typo:3,
+ minWordSizefor2Typos:7,
+ allowTyposOnNumericTokens:false,
+ minProximity:1,
+ ignorePlurals:true,
+ advancedSyntax:true,
+ attributeCriteriaComputedByMinProximity:true,
+ removeWordsIfNoResults:'allOptional',
+ },
+ },
+})
+
The above recordProps is the configuration used for the default theme. You can modify them according to the theme you are using.
Notice that the initialIndexSettings.YOUR_INDEX_NAME.attributesForFaceting fields must include 'lang' to make this plugin work properly.
`,1),D={class:"hint-container tip"},T=n("p",{class:"hint-container-title"},"Tips",-1),S={href:"https://crawler.algolia.com/admin/crawlers/",target:"_blank",rel:"noopener noreferrer"},I=n("h2",{id:"options",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#options","aria-hidden":"true"},"#"),s(" Options")],-1),P=n("h3",{id:"apikey",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#apikey","aria-hidden":"true"},"#"),s(" apiKey")],-1),q=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),A=n("li",null,[n("p",null,[s("Required: "),n("code",null,"true")])],-1),E=n("li",null,[n("p",null,"Details:"),n("p",null,[s("The "),n("code",null,"apiKey"),s(" that you received from the DocSearch team, or generated by yourself.")])],-1),N=n("p",null,"Also see:",-1),R={href:"https://docsearch.algolia.com/docs/api#apikey",target:"_blank",rel:"noopener noreferrer"},O=n("h3",{id:"indexname",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#indexname","aria-hidden":"true"},"#"),s(" indexName")],-1),U=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),Y=n("li",null,[n("p",null,[s("Required: "),n("code",null,"true")])],-1),z=n("li",null,[n("p",null,"Details:"),n("p",null,[s("The "),n("code",null,"indexName"),s(" that you received from the DocSearch team, or generated by yourself.")])],-1),B=n("p",null,"Also see:",-1),C={href:"https://docsearch.algolia.com/docs/api#indexname",target:"_blank",rel:"noopener noreferrer"},W=n("h3",{id:"appid",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#appid","aria-hidden":"true"},"#"),s(" appId")],-1),L=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),j=n("li",null,[n("p",null,[s("Required: "),n("code",null,"true")])],-1),K=n("li",null,[n("p",null,"Details:"),n("p",null,"It defines your own application ID.")],-1),V=n("p",null,"Also see:",-1),F={href:"https://docsearch.algolia.com/docs/api#appid",target:"_blank",rel:"noopener noreferrer"},M=n("h3",{id:"searchparameters",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#searchparameters","aria-hidden":"true"},"#"),s(" searchParameters")],-1),X=n("li",null,[n("p",null,[s("Type: "),n("code",null,"SearchParameters")])],-1),H=n("li",null,[n("p",null,"Details:"),n("p",null,"Parameters of Algolia Search API.")],-1),G=n("p",null,"Also see:",-1),Q={href:"https://docsearch.algolia.com/docs/api/#searchparameters",target:"_blank",rel:"noopener noreferrer"},$={href:"https://www.algolia.com/doc/api-reference/search-api-parameters/",target:"_blank",rel:"noopener noreferrer"},Z=n("h3",{id:"placeholder",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#placeholder","aria-hidden":"true"},"#"),s(" placeholder")],-1),J=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),nn=n("li",null,[n("p",null,[s("Default: "),n("code",null,"'Search docs'")])],-1),sn=n("li",null,[n("p",null,"Details:"),n("p",null,"The placeholder attribute of the search input.")],-1),an=n("p",null,"Also see:",-1),en={href:"https://docsearch.algolia.com/docs/api/#placeholder",target:"_blank",rel:"noopener noreferrer"},tn=n("h3",{id:"disableuserpersonalization",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#disableuserpersonalization","aria-hidden":"true"},"#"),s(" disableUserPersonalization")],-1),pn=n("li",null,[n("p",null,[s("Type: "),n("code",null,"boolean")])],-1),on=n("li",null,[n("p",null,[s("Default: "),n("code",null,"false")])],-1),ln=n("li",null,[n("p",null,"Details:"),n("p",null,"Whether to disable all personalized features: recent searches, favorite searches, etc.")],-1),cn=n("p",null,"Also see:",-1),rn={href:"https://docsearch.algolia.com/docs/api/#disableuserpersonalization",target:"_blank",rel:"noopener noreferrer"},un=n("h3",{id:"initialquery",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#initialquery","aria-hidden":"true"},"#"),s(" initialQuery")],-1),dn=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),kn=n("li",null,[n("p",null,"Details:"),n("p",null,"The initial query when the modal opens.")],-1),hn=n("p",null,"Also see:",-1),vn={href:"https://docsearch.algolia.com/docs/api/#initialquery",target:"_blank",rel:"noopener noreferrer"},mn=n("h3",{id:"translations",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#translations","aria-hidden":"true"},"#"),s(" translations")],-1),bn=n("li",null,[n("p",null,[s("Type: "),n("code",null,"Partial")])],-1),gn=n("li",null,[n("p",null,"Details:"),n("p",null,"Allow replacing the default text in the DocSearch button or modal.")],-1),yn=n("p",null,"Also see:",-1),_n={href:"https://docsearch.algolia.com/docs/api/#translations",target:"_blank",rel:"noopener noreferrer"},fn=t(`
`,3),xn=n("h3",{id:"indexbase",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#indexbase","aria-hidden":"true"},"#"),s(" indexBase")],-1),wn=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),Dn=n("p",null,"Details:",-1),Tn=n("p",null,"The base path of the search index.",-1),Sn=n("p",null,[s("If you are deploying your site to multiple domains, you don't need to submit all of them to DocSearch and generate search index separately. You could choose one of the domains as the "),n("em",null,"index domain"),s(", and only submit the "),n("em",null,"index domain"),s(" to Docsearch for crawling search index. Then, you could reuse the search index across all deployments.")],-1),In=n("em",null,"index domain",-1),Pn=t('
Whether to inject the default styles of DocSearch or not.
If you think the default styles of DocSearch is not compatible with your site, you can try to override the default styles, or set this option to false to totally exclude the default styles.
When this option is disabled, you need to import your own styles for DocSearch. Also notice that all styles customization in Styles section would be unavailable.
This plugin will register a <Docsearch /> component globally, and you can use it without any props.
Put this component to where you want to place the docsearch button. For example, default theme puts this component to the end of the navbar.
Tips
This component is mainly used for theme development. You don't need to use it directly in most cases.
`,5);function En(Nn,Rn){const i=l("NpmBadge"),e=l("ExternalLinkIcon"),p=l("RouterLink");return r(),u("div",null,[k,a(i,{package:"@vuepress/plugin-docsearch"}),n("p",null,[s("Integrate "),n("a",h,[s("Algolia DocSearch"),a(e)]),s(" into VuePress, which can provide search to your documentation site.")]),v,n("p",null,[s("You need to "),n("a",m,[s("submit the URL of your site"),a(e)]),s(" to join the DocSearch program. The DocSearch team will send "),b,s(" and "),g,s(" to your email once the index is generated. Then you can configure this plugin to enable DocSearch in VuePress.")]),n("p",null,[s("Alternatively, you can "),n("a",y,[s("run your own crawler"),a(e)]),s(" to generate the index, and then use your own "),_,s(", "),f,s(" and "),x,s(" to configure this plugin.")]),w,n("div",D,[T,n("p",null,[s("If you are not using default theme, or you meet any problems when using docsearch, you can also check the above example crawler config, and ahead to "),n("a",S,[s("Algolia Crawler"),a(e)]),s(", and edit your config with 'Editor' panel in project sidebar.")])]),I,P,n("ul",null,[q,A,E,n("li",null,[N,n("ul",null,[n("li",null,[n("a",R,[s("DocSearch > Options > apiKey"),a(e)])])])])]),O,n("ul",null,[U,Y,z,n("li",null,[B,n("ul",null,[n("li",null,[n("a",C,[s("DocSearch > Options > indexName"),a(e)])])])])]),W,n("ul",null,[L,j,K,n("li",null,[V,n("ul",null,[n("li",null,[n("a",F,[s("DocSearch > Options > appId"),a(e)])])])])]),M,n("ul",null,[X,H,n("li",null,[G,n("ul",null,[n("li",null,[n("a",Q,[s("DocSearch > Options > searchParameters"),a(e)])]),n("li",null,[n("a",$,[s("Algolia > Search API Parameters"),a(e)])])])])]),Z,n("ul",null,[J,nn,sn,n("li",null,[an,n("ul",null,[n("li",null,[n("a",en,[s("DocSearch > Options > placeholder"),a(e)])])])])]),tn,n("ul",null,[pn,on,ln,n("li",null,[cn,n("ul",null,[n("li",null,[n("a",rn,[s("DocSearch > Options > disableUserPersonalization"),a(e)])])])])]),un,n("ul",null,[dn,kn,n("li",null,[hn,n("ul",null,[n("li",null,[n("a",vn,[s("DocSearch > Options > initialQuery"),a(e)])])])])]),mn,n("ul",null,[bn,gn,n("li",null,[yn,n("ul",null,[n("li",null,[n("a",_n,[s("DocSearch > Options > translations"),a(e)])])])])]),fn,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(p,{to:"/guide/i18n.html"},{default:o(()=>[s("Guide > I18n")]),_:1})])])])]),xn,n("ul",null,[wn,n("li",null,[n("p",null,[s("Default: "),a(p,{to:"/reference/config.html#base"},{default:o(()=>[s("base")]),_:1})])]),n("li",null,[Dn,Tn,Sn,n("p",null,[s("However, if the "),a(p,{to:"/reference/config.html#base"},{default:o(()=>[s("base")]),_:1}),s(" of your deployments are different for different domains, you need to set the option to the "),a(p,{to:"/reference/config.html#base"},{default:o(()=>[s("base")]),_:1}),s(" of your "),In,s(", so that other deployments could reuse the search index correctly.")])])]),Pn,n("p",null,[s("You can customize styles via CSS variables that provided by "),n("a",qn,[s("@docsearch/css"),a(e)]),s(":")]),An])}const Un=c(d,[["render",En],["__file","docsearch.html.vue"]]);export{Un as default};
diff --git a/assets/docsearch.html-96cbfce9.js b/assets/docsearch.html-96cbfce9.js
new file mode 100644
index 00000000..6e381d69
--- /dev/null
+++ b/assets/docsearch.html-96cbfce9.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-ec0baf10","path":"/reference/plugin/docsearch.html","title":"docsearch","lang":"en-US","frontmatter":{"description":"Integrate Algolia DocSearch (https://docsearch.algolia.com/) into VuePress, which can provide search to your documentation site. Default theme will add DocSearch to the navbar o...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/docsearch.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/docsearch.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"docsearch"}],["meta",{"property":"og:description","content":"Integrate Algolia DocSearch (https://docsearch.algolia.com/) into VuePress, which can provide search to your documentation site. Default theme will add DocSearch to the navbar o..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"docsearch\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Get Search Index","slug":"get-search-index","link":"#get-search-index","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"apiKey","slug":"apikey","link":"#apikey","children":[]},{"level":3,"title":"indexName","slug":"indexname","link":"#indexname","children":[]},{"level":3,"title":"appId","slug":"appid","link":"#appid","children":[]},{"level":3,"title":"searchParameters","slug":"searchparameters","link":"#searchparameters","children":[]},{"level":3,"title":"placeholder","slug":"placeholder","link":"#placeholder","children":[]},{"level":3,"title":"disableUserPersonalization","slug":"disableuserpersonalization","link":"#disableuserpersonalization","children":[]},{"level":3,"title":"initialQuery","slug":"initialquery","link":"#initialquery","children":[]},{"level":3,"title":"translations","slug":"translations","link":"#translations","children":[]},{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]},{"level":3,"title":"indexBase","slug":"indexbase","link":"#indexbase","children":[]},{"level":3,"title":"injectStyles","slug":"injectstyles","link":"#injectstyles","children":[]}]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]},{"level":2,"title":"Components","slug":"components","link":"#components","children":[{"level":3,"title":"Docsearch","slug":"docsearch-1","link":"#docsearch-1","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":4.92,"words":1476},"filePathRelative":"reference/plugin/docsearch.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/docsearch.html-e0be4873.js b/assets/docsearch.html-e0be4873.js
new file mode 100644
index 00000000..fe145e86
--- /dev/null
+++ b/assets/docsearch.html-e0be4873.js
@@ -0,0 +1,203 @@
+import{_ as i,W as r,X as u,Y as a,$ as n,a0 as s,Z as o,a1 as e,D as l}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"docsearch",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#docsearch","aria-hidden":"true"},"#"),s(" docsearch")],-1),h={href:"https://docsearch.algolia.com/",target:"_blank",rel:"noopener noreferrer"},v=e(`
`,5);function y(f,_){const p=t("ExternalLinkIcon"),o=t("RouterLink");return i(),u("div",null,[k,s("p",null,[n("默认主题将所有 "),s("a",v,[n("非全局的组件"),a(p)]),n(" 都注册了一个带 "),m,n(" 前缀的 "),a(o,{to:"/zh/reference/plugin-api.html#alias"},{default:r(()=>[n("alias")]),_:1}),n(" 。例如，"),g,n(" 的别名是 "),b,n(" 。")]),h])}const x=l(d,[["render",y],["__file","extending.html.vue"]]);export{x as default};
diff --git a/assets/extending.html-475b2487.js b/assets/extending.html-475b2487.js
new file mode 100644
index 00000000..a3d0b9f3
--- /dev/null
+++ b/assets/extending.html-475b2487.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6175ace0","path":"/reference/default-theme/extending.html","title":"Extending","lang":"en-US","frontmatter":{"icon":"fa6-solid:clone","description":"VuePress default theme is widely used by users, so it is designed to be extendable, allowing users to make their own customization with ease. VuePress provides basic ability to ...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/default-theme/extending.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/default-theme/extending.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Extending"}],["meta",{"property":"og:description","content":"VuePress default theme is widely used by users, so it is designed to be extendable, allowing users to make their own customization with ease. VuePress provides basic ability to ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Extending\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Layout Slots","slug":"layout-slots","link":"#layout-slots","children":[]},{"level":2,"title":"Components Replacement","slug":"components-replacement","link":"#components-replacement","children":[]},{"level":2,"title":"Developing a Child Theme","slug":"developing-a-child-theme","link":"#developing-a-child-theme","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.56,"words":468},"filePathRelative":"reference/default-theme/extending.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/extending.html-d6c7b1f5.js b/assets/extending.html-d6c7b1f5.js
new file mode 100644
index 00000000..d878f446
--- /dev/null
+++ b/assets/extending.html-d6c7b1f5.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-90ed1862","path":"/zh/reference/default-theme/extending.html","title":"继承","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:clone","description":"VuePress 默认主题有着大量的用户，因此我们对它进行了一些便于继承的设计，以便用户轻松进行定制化。 VuePress 提供了继承主题的基础能力，但不同的主题可能会提供不同的可继承的功能。因此，如果你使用的是一个社区主题的话，你最好参考主题本身的文档来了解如何继承它。 布局插槽 默认主题的 Layout 布局提供了一些插槽： navbar; nav...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/default-theme/extending.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/default-theme/extending.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"继承"}],["meta",{"property":"og:description","content":"VuePress 默认主题有着大量的用户，因此我们对它进行了一些便于继承的设计，以便用户轻松进行定制化。 VuePress 提供了继承主题的基础能力，但不同的主题可能会提供不同的可继承的功能。因此，如果你使用的是一个社区主题的话，你最好参考主题本身的文档来了解如何继承它。 布局插槽 默认主题的 Layout 布局提供了一些插槽： navbar; nav..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"继承\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"布局插槽","slug":"布局插槽","link":"#布局插槽","children":[]},{"level":2,"title":"组件替换","slug":"组件替换","link":"#组件替换","children":[]},{"level":2,"title":"开发一个子主题","slug":"开发一个子主题","link":"#开发一个子主题","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.14,"words":643},"filePathRelative":"zh/reference/default-theme/extending.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/extending.html-f332bc2d.js b/assets/extending.html-f332bc2d.js
new file mode 100644
index 00000000..a16b4e7a
--- /dev/null
+++ b/assets/extending.html-f332bc2d.js
@@ -0,0 +1,66 @@
+import{_ as c}from"./extending-a-theme-01-9eaa80a2.js";import{_ as i,W as l,X as u,$ as s,a0 as n,Y as a,Z as r,a1 as t,D as e}from"./framework-46b0e263.js";const d={},k=t(`
VuePress default theme is widely used by users, so it is designed to be extendable, allowing users to make their own customization with ease.
VuePress provides basic ability to extend a theme, but different themes may have different features to be extended. Thus, if you are using a community theme, you'd better refer to the theme's own documentation for how to extending it.
Then the default Layout layout has been overridden by your own local layout, which will add a custom footer to every normal pages in default theme (excluding homepage):
The layout slots are useful, but sometimes you might find it's not flexible enough. Default theme also provides the ability to replace a single component.
Instead of extending the default theme directly in .vuepress/config.ts and .vuepress/client.ts, you can also develop your own theme extending the default theme:
`,5);function y(f,w){const o=e("RouterLink"),p=e("ExternalLinkIcon");return l(),u("div",null,[k,s("p",null,[n("Default theme has registered "),a(o,{to:"/reference/plugin-api.html#alias"},{default:r(()=>[n("alias")]),_:1}),n(" for every "),s("a",m,[n("non-global components"),a(p)]),n(" with a "),v,n(" prefix. For example, the alias of "),h,n(" is "),g,n(".")]),b])}const q=i(d,[["render",y],["__file","extending.html.vue"]]);export{q as default};
diff --git a/assets/external-link-icon.html-57fd9332.js b/assets/external-link-icon.html-57fd9332.js
new file mode 100644
index 00000000..0d25eb7b
--- /dev/null
+++ b/assets/external-link-icon.html-57fd9332.js
@@ -0,0 +1,25 @@
+import{_ as p,W as c,X as r,Y as s,$ as n,a0 as a,Z as u,a1 as t,D as e}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"external-link-icon",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#external-link-icon","aria-hidden":"true"},"#"),a(" external-link-icon")],-1),h=t(`
This plugin has been integrated into the default theme.
This plugin will register a <ExternalLinkIcon /> component globally, and you can use it without any props.
Tips
This component is mainly used for theme development. You don't need to use it directly in most cases.
',10);function m(b,x){const i=e("NpmBadge"),o=e("ExternalLinkIcon"),l=e("RouterLink");return c(),r("div",null,[k,s(i,{package:"@vuepress/plugin-external-link-icon"}),n("p",null,[a("This plugin will add an icon to the external link in your markdown content, i.e. "),s(o)]),h,n("ul",null,[n("li",null,[a("Also see: "),n("ul",null,[n("li",null,[s(l,{to:"/guide/i18n.html"},{default:u(()=>[a("Guide > I18n")]),_:1})])])])]),v])}const f=p(d,[["render",m],["__file","external-link-icon.html.vue"]]);export{f as default};
diff --git a/assets/external-link-icon.html-58c8c6e2.js b/assets/external-link-icon.html-58c8c6e2.js
new file mode 100644
index 00000000..2a000155
--- /dev/null
+++ b/assets/external-link-icon.html-58c8c6e2.js
@@ -0,0 +1,25 @@
+import{_ as p,W as c,X as r,Y as s,$ as n,a0 as a,Z as u,a1 as t,D as e}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"external-link-icon",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#external-link-icon","aria-hidden":"true"},"#"),a(" external-link-icon")],-1),v=t(`
`,5);function yn(Ln,wn){const o=i("NpmBadge"),s=i("RouterLink"),u=i("ExternalLinkIcon");return d(),p("div",null,[h,a(o,{package:"@vuepress/theme-default"}),m,k,v,n("ul",null,[_,n("li",null,[b,n("p",null,[e("由"),a(s,{to:"/zh/reference/plugin/external-link-icon.html#externallinkicon"},{default:l(()=>[e("@vuepress/plugin-external-link-icon")]),_:1}),e(" 提供。")])]),n("li",null,[g,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#themeplugins-externallinkicon"},{default:l(()=>[e("默认主题 > 配置 > themePlugins.externalLinkIcon")]),_:1})])])])]),f,n("ul",null,[x,y,n("li",null,[L,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#navbar"},{default:l(()=>[e("默认主题 > 配置 > navbar")]),_:1})])])])]),w,n("ul",null,[n("li",null,[e("参考： "),n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/styles.html#style-%E6%96%87%E4%BB%B6"},{default:l(()=>[e("默认主题 > 样式 > Style 文件")]),_:1})])])])]),z,n("ul",null,[N,n("li",null,[B,n("ul",null,[n("li",null,[a(s,{to:"/zh/guide/assets.html#public-%E6%96%87%E4%BB%B6"},{default:l(()=>[e("指南 > 静态资源 > Public 文件")]),_:1})])])])]),E,n("ul",null,[F,A,n("li",null,[I,n("ul",null,[S,n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#colormode"},{default:l(()=>[e("默认主题 > 配置 > colorMode")]),_:1})])])])]),V,n("ul",null,[C,P,n("li",null,[T,H,M,n("p",null,[e("需要注意的是，首页图片的高度同样受到了 CSS 的约束。设置这个属性主要是为了减少由加载首页图片引起的 "),n("a",R,[e("累积布局偏移 (CLS)"),a(u)]),e(" 。")])])]),U,n("ul",null,[D,n("li",null,[q,j,n("p",null,[e("如果不设置，则默认使用站点 "),a(s,{to:"/zh/reference/config.html#title"},{default:l(()=>[e("title")]),_:1}),e(" 。")]),G])]),O,n("ul",null,[W,n("li",null,[X,Y,n("p",null,[e("如果不设置，则默认使用站点 "),a(s,{to:"/zh/reference/config.html#description"},{default:l(()=>[e("description")]),_:1}),e(" 。")]),Z])]),$,n("ul",null,[J,K,n("li",null,[Q,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#editlink"},{default:l(()=>[e("默认主题 > 配置 > editLink")]),_:1})])])])]),nn,n("ul",null,[en,an,n("li",null,[sn,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#editlinkpattern"},{default:l(()=>[e("默认主题 > 配置 > editLinkPattern")]),_:1})])])])]),ln,n("ul",null,[tn,on,n("li",null,[un,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#lastupdated"},{default:l(()=>[e("默认主题 > 配置 > lastUpdated")]),_:1})])])])]),cn,n("ul",null,[dn,pn,n("li",null,[rn,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#contributors"},{default:l(()=>[e("默认主题 > 配置 > contributors")]),_:1})])])])]),hn,n("ul",null,[mn,kn,n("li",null,[vn,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#sidebar"},{default:l(()=>[e("默认主题 > 配置 > sidebar")]),_:1})])])])]),_n,n("ul",null,[bn,gn,n("li",null,[fn,n("ul",null,[n("li",null,[a(s,{to:"/zh/reference/default-theme/config.html#sidebardepth"},{default:l(()=>[e("默认主题 > 配置 > sidebarDepth")]),_:1})])])])]),xn])}const Nn=c(r,[["render",yn],["__file","frontmatter.html.vue"]]);export{Nn as default};
diff --git a/assets/frontmatter.html-5c8a8e5d.js b/assets/frontmatter.html-5c8a8e5d.js
new file mode 100644
index 00000000..415baf83
--- /dev/null
+++ b/assets/frontmatter.html-5c8a8e5d.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3590f0ec","path":"/reference/frontmatter.html","title":"Frontmatter","lang":"en-US","frontmatter":{"icon":"fa-solid:bars","description":"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 (https://yaml.org/type/timestamp...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/frontmatter.html"}],["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":"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 (https://yaml.org/type/timestamp..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Frontmatter\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"date","slug":"date","link":"#date","children":[]},{"level":2,"title":"description","slug":"description","link":"#description","children":[]},{"level":2,"title":"head","slug":"head","link":"#head","children":[]},{"level":2,"title":"lang","slug":"lang","link":"#lang","children":[]},{"level":2,"title":"layout","slug":"layout","link":"#layout","children":[]},{"level":2,"title":"permalink","slug":"permalink","link":"#permalink","children":[]},{"level":2,"title":"permalinkPattern","slug":"permalinkpattern","link":"#permalinkpattern","children":[]},{"level":2,"title":"routeMeta","slug":"routemeta","link":"#routemeta","children":[]},{"level":2,"title":"title","slug":"title","link":"#title","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.96,"words":588},"filePathRelative":"reference/frontmatter.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/frontmatter.html-5f732d4f.js b/assets/frontmatter.html-5f732d4f.js
new file mode 100644
index 00000000..5a9c455b
--- /dev/null
+++ b/assets/frontmatter.html-5f732d4f.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-a566dc26","path":"/zh/reference/default-theme/frontmatter.html","title":"Frontmatter","lang":"zh-CN","frontmatter":{"icon":"fa-solid:bars","description":"所有页面 本章节中的 Frontmatter 会在所有类型的页面中生效。 externalLinkIcon 类型： boolean; 详情：; 由@vuepress/plugin-external-link-icon (../plugin/external-link-icon.md#externallinkicon) 提供。 参考：; 默认主题 > 配...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/default-theme/frontmatter.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/default-theme/frontmatter.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Frontmatter"}],["meta",{"property":"og:description","content":"所有页面 本章节中的 Frontmatter 会在所有类型的页面中生效。 externalLinkIcon 类型： boolean; 详情：; 由@vuepress/plugin-external-link-icon (../plugin/external-link-icon.md#externallinkicon) 提供。 参考：; 默认主题 > 配..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Frontmatter\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"所有页面","slug":"所有页面","link":"#所有页面","children":[{"level":3,"title":"externalLinkIcon","slug":"externallinkicon","link":"#externallinkicon","children":[]},{"level":3,"title":"navbar","slug":"navbar","link":"#navbar","children":[]},{"level":3,"title":"pageClass","slug":"pageclass","link":"#pageclass","children":[]}]},{"level":2,"title":"首页","slug":"首页","link":"#首页","children":[{"level":3,"title":"home","slug":"home","link":"#home","children":[]},{"level":3,"title":"heroImage","slug":"heroimage","link":"#heroimage","children":[]},{"level":3,"title":"heroImageDark","slug":"heroimagedark","link":"#heroimagedark","children":[]},{"level":3,"title":"heroAlt","slug":"heroalt","link":"#heroalt","children":[]},{"level":3,"title":"heroHeight","slug":"heroheight","link":"#heroheight","children":[]},{"level":3,"title":"heroText","slug":"herotext","link":"#herotext","children":[]},{"level":3,"title":"tagline","slug":"tagline","link":"#tagline","children":[]},{"level":3,"title":"actions","slug":"actions","link":"#actions","children":[]},{"level":3,"title":"features","slug":"features","link":"#features","children":[]},{"level":3,"title":"footer","slug":"footer","link":"#footer","children":[]},{"level":3,"title":"footerHtml","slug":"footerhtml","link":"#footerhtml","children":[]}]},{"level":2,"title":"普通页面","slug":"普通页面","link":"#普通页面","children":[{"level":3,"title":"editLink","slug":"editlink","link":"#editlink","children":[]},{"level":3,"title":"editLinkPattern","slug":"editlinkpattern","link":"#editlinkpattern","children":[]},{"level":3,"title":"lastUpdated","slug":"lastupdated","link":"#lastupdated","children":[]},{"level":3,"title":"contributors","slug":"contributors","link":"#contributors","children":[]},{"level":3,"title":"sidebar","slug":"sidebar","link":"#sidebar","children":[]},{"level":3,"title":"sidebarDepth","slug":"sidebardepth","link":"#sidebardepth","children":[]},{"level":3,"title":"prev","slug":"prev","link":"#prev","children":[]},{"level":3,"title":"next","slug":"next","link":"#next","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":4.18,"words":1254},"filePathRelative":"zh/reference/default-theme/frontmatter.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/frontmatter.html-60124b9c.js b/assets/frontmatter.html-60124b9c.js
new file mode 100644
index 00000000..f34b291d
--- /dev/null
+++ b/assets/frontmatter.html-60124b9c.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-e5e26a84","path":"/reference/default-theme/frontmatter.html","title":"Frontmatter","lang":"en-US","frontmatter":{"icon":"fa-solid:bars","description":"All Pages Frontmatter in this section will take effect in all types of pages. externalLinkIcon Type: boolean; Details:; Provided by @vuepress/plugin-external-link-icon (../plugi...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/default-theme/frontmatter.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/default-theme/frontmatter.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Frontmatter"}],["meta",{"property":"og:description","content":"All Pages Frontmatter in this section will take effect in all types of pages. externalLinkIcon Type: boolean; Details:; Provided by @vuepress/plugin-external-link-icon (../plugi..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Frontmatter\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"All Pages","slug":"all-pages","link":"#all-pages","children":[{"level":3,"title":"externalLinkIcon","slug":"externallinkicon","link":"#externallinkicon","children":[]},{"level":3,"title":"navbar","slug":"navbar","link":"#navbar","children":[]},{"level":3,"title":"pageClass","slug":"pageclass","link":"#pageclass","children":[]}]},{"level":2,"title":"Home Page","slug":"home-page","link":"#home-page","children":[{"level":3,"title":"home","slug":"home","link":"#home","children":[]},{"level":3,"title":"heroImage","slug":"heroimage","link":"#heroimage","children":[]},{"level":3,"title":"heroImageDark","slug":"heroimagedark","link":"#heroimagedark","children":[]},{"level":3,"title":"heroAlt","slug":"heroalt","link":"#heroalt","children":[]},{"level":3,"title":"heroHeight","slug":"heroheight","link":"#heroheight","children":[]},{"level":3,"title":"heroText","slug":"herotext","link":"#herotext","children":[]},{"level":3,"title":"tagline","slug":"tagline","link":"#tagline","children":[]},{"level":3,"title":"actions","slug":"actions","link":"#actions","children":[]},{"level":3,"title":"features","slug":"features","link":"#features","children":[]},{"level":3,"title":"footer","slug":"footer","link":"#footer","children":[]},{"level":3,"title":"footerHtml","slug":"footerhtml","link":"#footerhtml","children":[]}]},{"level":2,"title":"Normal Page","slug":"normal-page","link":"#normal-page","children":[{"level":3,"title":"editLink","slug":"editlink","link":"#editlink","children":[]},{"level":3,"title":"editLinkPattern","slug":"editlinkpattern","link":"#editlinkpattern","children":[]},{"level":3,"title":"lastUpdated","slug":"lastupdated","link":"#lastupdated","children":[]},{"level":3,"title":"contributors","slug":"contributors","link":"#contributors","children":[]},{"level":3,"title":"sidebar","slug":"sidebar","link":"#sidebar","children":[]},{"level":3,"title":"sidebarDepth","slug":"sidebardepth","link":"#sidebardepth","children":[]},{"level":3,"title":"prev","slug":"prev","link":"#prev","children":[]},{"level":3,"title":"next","slug":"next","link":"#next","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.91,"words":874},"filePathRelative":"reference/default-theme/frontmatter.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/frontmatter.html-9281febe.js b/assets/frontmatter.html-9281febe.js
new file mode 100644
index 00000000..07856d27
--- /dev/null
+++ b/assets/frontmatter.html-9281febe.js
@@ -0,0 +1,30 @@
+import{_ as u,W as c,X as d,Y as e,$ as n,a0 as a,Z as s,a1 as o,D as l}from"./framework-46b0e263.js";const r={},m=n("h1",{id:"frontmatter",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),a(" Frontmatter")],-1),h=n("h2",{id:"date",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#date","aria-hidden":"true"},"#"),a(" date")],-1),k=n("li",null,[n("p",null,[a("Type: "),n("code",null,"string")])],-1),f=n("p",null,"Details:",-1),g=n("p",null,"Created date for the page.",-1),y=n("code",null,"yyyy-MM-dd",-1),v={href:"https://yaml.org/type/timestamp.html",target:"_blank",rel:"noopener noreferrer"},_=n("p",null,"Also see:",-1),b=n("h2",{id:"description",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#description","aria-hidden":"true"},"#"),a(" description")],-1),x=n("li",null,[n("p",null,[a("Type: "),n("code",null,"string")])],-1),w=n("li",null,[n("p",null,"Details:"),n("p",null,"Description for the page."),n("p",null,[a("This will override the "),n("code",null,"description"),a(" option in your site config.")])],-1),P=n("p",null,"Also see:",-1),T=o(`
`,5),q=n("h2",{id:"lang",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#lang","aria-hidden":"true"},"#"),a(" lang")],-1),C=n("li",null,[n("p",null,[a("Type: "),n("code",null,"string")])],-1),A=n("li",null,[n("p",null,"Details:"),n("p",null,"Language for the page."),n("p",null,[a("This will override the "),n("code",null,"lang"),a(" option in your site config.")])],-1),M=n("p",null,"Also see:",-1),D=o(`
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),L=n("li",null,[n("p",null,[a("Type: "),n("code",null,"string")])],-1),N=n("li",null,[n("p",null,"Details:"),n("p",null,"Permalink for the page."),n("p",null,"This will override the default route path that determined by the file path of the page.")],-1),I=n("p",null,"Also see:",-1),E=n("li",null,[n("a",{href:"#permalinkpattern"},"Frontmatter > permalinkPattern")],-1),R=o(`
Then the permalink of the page would be 2021/01/03/bar-baz.html.
`,7),B=n("li",null,[n("a",{href:"#date"},"Frontmatter > date")],-1),F=n("li",null,[n("a",{href:"#permalink"},"Frontmatter > permalink")],-1),Y=n("h2",{id:"routemeta",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#routemeta","aria-hidden":"true"},"#"),a(" routeMeta")],-1),V=n("li",null,[n("p",null,[a("Type: "),n("code",null,"Record")])],-1),S=n("li",null,[n("p",null,"Details:"),n("p",null,"Custom data to be attached to the page route.")],-1),z=n("p",null,"Also see:",-1),G=n("h2",{id:"title",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#title","aria-hidden":"true"},"#"),a(" title")],-1),H=n("li",null,[n("p",null,[a("Type: "),n("code",null,"string")])],-1),U=n("li",null,[n("p",null,"Details:"),n("p",null,"Title for the page."),n("p",null,[a("If you don't specify "),n("code",null,"title"),a(" in frontmatter, content of the first level-one header (i.e. "),n("code",null,"# title"),a(") will be used as the title.")])],-1),W=n("p",null,"Also see:",-1);function X(Z,$){const i=l("NpmBadge"),p=l("ExternalLinkIcon"),t=l("RouterLink");return c(),d("div",null,[m,e(i,{package:"@vuepress/client"}),e(i,{package:"@vuepress/markdown"}),h,n("ul",null,[k,n("li",null,[f,g,n("p",null,[a("You should specify the date in the form of "),y,a(", or follow the "),n("a",v,[a("YAML Timestamp Type"),e(p)]),a(".")])]),n("li",null,[_,n("ul",null,[n("li",null,[e(t,{to:"/reference/node-api.html#date"},{default:s(()=>[a("Node API > Page Properties > date")]),_:1})])])])]),b,n("ul",null,[x,w,n("li",null,[P,n("ul",null,[n("li",null,[e(t,{to:"/reference/config.html#description"},{default:s(()=>[a("Config > description")]),_:1})])])])]),T,n("ul",null,[n("li",null,[a("Also see: "),n("ul",null,[n("li",null,[e(t,{to:"/reference/config.html#head"},{default:s(()=>[a("Config > head")]),_:1})])])])]),q,n("ul",null,[C,A,n("li",null,[M,n("ul",null,[n("li",null,[e(t,{to:"/reference/config.html#lang"},{default:s(()=>[a("Config > lang")]),_:1})]),n("li",null,[e(t,{to:"/reference/node-api.html#lang"},{default:s(()=>[a("Node API > Page Properties > lang")]),_:1})])])])]),D,n("ul",null,[L,N,n("li",null,[I,n("ul",null,[E,n("li",null,[e(t,{to:"/guide/page.html#routing"},{default:s(()=>[a("Guide > Page > Routing")]),_:1})]),n("li",null,[e(t,{to:"/reference/node-api.html#permalink"},{default:s(()=>[a("Node API > Page Properties > permalink")]),_:1})])])])]),R,n("ul",null,[n("li",null,[a("Also see: "),n("ul",null,[n("li",null,[e(t,{to:"/reference/config.html#permalinkpattern"},{default:s(()=>[a("Config > permalinkPattern")]),_:1})]),B,F,n("li",null,[e(t,{to:"/reference/node-api.html#permalink"},{default:s(()=>[a("Node API > Page Properties > permalink")]),_:1})])])])]),Y,n("ul",null,[V,S,n("li",null,[z,n("ul",null,[n("li",null,[e(t,{to:"/reference/node-api.html#routeMeta"},{default:s(()=>[a("Node API > Page Properties > routeMeta")]),_:1})])])])]),G,n("ul",null,[H,U,n("li",null,[W,n("ul",null,[n("li",null,[e(t,{to:"/reference/node-api.html#title"},{default:s(()=>[a("Node API > Page Properties > title")]),_:1})])])])])])}const J=u(r,[["render",X],["__file","frontmatter.html.vue"]]);export{J as default};
diff --git a/assets/frontmatter.html-96a3ef5a.js b/assets/frontmatter.html-96a3ef5a.js
new file mode 100644
index 00000000..5ad49dd7
--- /dev/null
+++ b/assets/frontmatter.html-96a3ef5a.js
@@ -0,0 +1,60 @@
+import{_ as u,W as r,X as c,Y as a,$ as e,a0 as n,Z as t,a1 as l,D as i}from"./framework-46b0e263.js";const d={},h=e("h1",{id:"frontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),n(" Frontmatter")],-1),m=e("h2",{id:"all-pages",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#all-pages","aria-hidden":"true"},"#"),n(" All Pages")],-1),k=e("p",null,"Frontmatter in this section will take effect in all types of pages.",-1),f=e("h3",{id:"externallinkicon",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#externallinkicon","aria-hidden":"true"},"#"),n(" externalLinkIcon")],-1),g=e("li",null,[e("p",null,[n("Type: "),e("code",null,"boolean")])],-1),v=e("p",null,"Details:",-1),b=e("p",null,"Also see:",-1),_=e("h3",{id:"navbar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#navbar","aria-hidden":"true"},"#"),n(" navbar")],-1),y=e("li",null,[e("p",null,[n("Type: "),e("code",null,"boolean")])],-1),x=e("li",null,[e("p",null,"Details:"),e("p",null,"Show navbar on this page or not."),e("p",null,"If you disable navbar in theme config, this frontmatter will not take effect.")],-1),T=e("p",null,"Also see:",-1),D=l(`
`,8),S=e("h3",{id:"heroimagedark",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#heroimagedark","aria-hidden":"true"},"#"),n(" heroImageDark")],-1),A=e("li",null,[e("p",null,[n("Type: "),e("code",null,"string")])],-1),C=e("li",null,[e("p",null,"Details:"),e("p",null,"Specify the url of hero image to be used in dark mode."),e("p",null,"You can make use of this option if you want to use different heroImage config in dark mode.")],-1),L=e("p",null,"Also see:",-1),I=e("li",null,[e("a",{href:"#heroimage"},"Default Theme > Frontmatter > heroImage")],-1),N=l('
',3),E=e("li",null,[e("p",null,[n("Type: "),e("code",null,"number")])],-1),P=e("li",null,[e("p",null,[n("Default: "),e("code",null,"280")])],-1),V=e("p",null,"Details:",-1),F=e("p",null,[n("Specify the "),e("code",null,"height"),n(" attribute of the hero "),e("code",null,""),n(" tag.")],-1),j=e("p",null,"You may need to reduce this value if the height of your hero image is less than the default value.",-1),H={href:"https://web.dev/cls/",target:"_blank",rel:"noopener noreferrer"},B=e("h3",{id:"herotext",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#herotext","aria-hidden":"true"},"#"),n(" heroText")],-1),M=e("li",null,[e("p",null,[n("Type: "),e("code",null,"string | null")])],-1),q=e("p",null,"Details:",-1),G=e("p",null,"Specify the the hero text.",-1),R=e("p",null,[n("Set to "),e("code",null,"null"),n(" to disable hero text.")],-1),Y=e("h3",{id:"tagline",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#tagline","aria-hidden":"true"},"#"),n(" tagline")],-1),U=e("li",null,[e("p",null,[n("Type: "),e("code",null,"string | null")])],-1),z=e("p",null,"Details:",-1),O=e("p",null,"Specify the the tagline.",-1),W=e("p",null,[n("Set to "),e("code",null,"null"),n(" to disable tagline.")],-1),X=l(`
---
+features:
+ -title: Simplicity First
+ details: Minimal setup with markdown-centered project structure helps you focus on writing.
+ -title: Vue-Powered
+ details: Enjoy the dev experience of Vue, use Vue components in markdown, and develop custom themes with Vue.
+ -title: Performant
+ details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
+---
+
`,17),Z=e("li",null,[e("p",null,[n("Type: "),e("code",null,"boolean")])],-1),$=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Enable the "),e("em",null,"edit this page"),n(" link in this page or not.")])],-1),J=e("p",null,"Also see:",-1),K=e("h3",{id:"editlinkpattern",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#editlinkpattern","aria-hidden":"true"},"#"),n(" editLinkPattern")],-1),Q=e("li",null,[e("p",null,[n("Type: "),e("code",null,"string")])],-1),ee=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Specify the pattern of the "),e("em",null,"edit this page"),n(" link of this page.")])],-1),ne=e("p",null,"Also see:",-1),ae=e("h3",{id:"lastupdated",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#lastupdated","aria-hidden":"true"},"#"),n(" lastUpdated")],-1),se=e("li",null,[e("p",null,[n("Type: "),e("code",null,"boolean")])],-1),te=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Enable the "),e("em",null,"last updated timestamp"),n(" in this page or not.")])],-1),le=e("p",null,"Also see:",-1),ie=e("h3",{id:"contributors",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#contributors","aria-hidden":"true"},"#"),n(" contributors")],-1),oe=e("li",null,[e("p",null,[n("Type: "),e("code",null,"boolean")])],-1),pe=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Enable the "),e("em",null,"contributors list"),n(" in this page or not.")])],-1),ue=e("p",null,"Also see:",-1),re=e("h3",{id:"sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sidebar","aria-hidden":"true"},"#"),n(" sidebar")],-1),ce=e("li",null,[e("p",null,[n("Type: "),e("code",null,"false | 'auto' | SidebarConfigArray | SidebarConfigObject")])],-1),de=e("li",null,[e("p",null,"Details:"),e("p",null,"Configure the sidebar of this page.")],-1),he=e("p",null,"Also see:",-1),me=e("h3",{id:"sidebardepth",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sidebardepth","aria-hidden":"true"},"#"),n(" sidebarDepth")],-1),ke=e("li",null,[e("p",null,[n("Type: "),e("code",null,"number")])],-1),fe=e("li",null,[e("p",null,"Details:"),e("p",null,"Configure the sidebar depth of this page.")],-1),ge=e("p",null,"Also see:",-1),ve=l(`
If you don't set this frontmatter, the link will be inferred from the sidebar config.
To configure the prev link manually, you can set this frontmatter to a NavLink object or a string:
A NavLink object should have a text field and a link field.
A string should be the path to the target page file. It will be converted to a NavLink object, whose text is the page title, and link is the page route path.
`,5);function be(_e,ye){const o=i("NpmBadge"),s=i("RouterLink"),p=i("ExternalLinkIcon");return r(),c("div",null,[h,a(o,{package:"@vuepress/theme-default"}),m,k,f,e("ul",null,[g,e("li",null,[v,e("p",null,[n("Provided by "),a(s,{to:"/reference/plugin/external-link-icon.html#externallinkicon"},{default:t(()=>[n("@vuepress/plugin-external-link-icon")]),_:1}),n(".")])]),e("li",null,[b,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#themeplugins-externallinkicon"},{default:t(()=>[n("Default Theme > Config Reference > themePlugins.externalLinkIcon")]),_:1})])])])]),_,e("ul",null,[y,x,e("li",null,[T,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#navbar"},{default:t(()=>[n("Default Theme > Config > navbar")]),_:1})])])])]),D,e("ul",null,[e("li",null,[n("Also see: "),e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/styles.html#style-file"},{default:t(()=>[n("Default Theme > Styles > Style File")]),_:1})])])])]),w,e("ul",null,[e("li",null,[n("Also see: "),e("ul",null,[e("li",null,[a(s,{to:"/guide/assets.html#public-files"},{default:t(()=>[n("Guide > Assets > Public Files")]),_:1})])])])]),S,e("ul",null,[A,C,e("li",null,[L,e("ul",null,[I,e("li",null,[a(s,{to:"/reference/default-theme/config.html#colormode"},{default:t(()=>[n("Default Theme > Config > colorMode")]),_:1})])])])]),N,e("ul",null,[E,P,e("li",null,[V,F,j,e("p",null,[n("Notice that the height is also constrained by CSS. This attribute is to reduce "),e("a",H,[n("Cumulative Layout Shift (CLS)"),a(p)]),n(" that caused by the loading of the hero image.")])])]),B,e("ul",null,[M,e("li",null,[q,G,e("p",null,[n("This will fallback to the site "),a(s,{to:"/reference/config.html#title"},{default:t(()=>[n("title")]),_:1}),n(".")]),R])]),Y,e("ul",null,[U,e("li",null,[z,O,e("p",null,[n("This will fallback to the site "),a(s,{to:"/reference/config.html#description"},{default:t(()=>[n("description")]),_:1}),n(".")]),W])]),X,e("ul",null,[Z,$,e("li",null,[J,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#editlink"},{default:t(()=>[n("Default Theme > Config > editLink")]),_:1})])])])]),K,e("ul",null,[Q,ee,e("li",null,[ne,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#editlinkpattern"},{default:t(()=>[n("Default Theme > Config > editLinkPattern")]),_:1})])])])]),ae,e("ul",null,[se,te,e("li",null,[le,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#lastupdated"},{default:t(()=>[n("Default Theme > Config > lastUpdated")]),_:1})])])])]),ie,e("ul",null,[oe,pe,e("li",null,[ue,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#contributors"},{default:t(()=>[n("Default Theme > Config > contributors")]),_:1})])])])]),re,e("ul",null,[ce,de,e("li",null,[he,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#sidebar"},{default:t(()=>[n("Default Theme > Config > sidebar")]),_:1})])])])]),me,e("ul",null,[ke,fe,e("li",null,[ge,e("ul",null,[e("li",null,[a(s,{to:"/reference/default-theme/config.html#sidebardepth"},{default:t(()=>[n("Default Theme > Config > sidebarDepth")]),_:1})])])])]),ve])}const Te=u(d,[["render",be],["__file","frontmatter.html.vue"]]);export{Te as default};
diff --git a/assets/frontmatter.html-bdbde184.js b/assets/frontmatter.html-bdbde184.js
new file mode 100644
index 00000000..820a449b
--- /dev/null
+++ b/assets/frontmatter.html-bdbde184.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-d147334a","path":"/zh/reference/frontmatter.html","title":"Frontmatter","lang":"zh-CN","frontmatter":{"icon":"fa-solid:bars","description":"date 类型： string; 详情：; 页面的创建日期。 应按照 yyyy-MM-dd 的格式来指定日期，或者遵循 YAML Timestamp Type (https://yaml.org/type/timestamp.html) 。 参考：; Node API > Page 属性 > date (./node-api.md#date); des...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/frontmatter.html"}],["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":"date 类型： string; 详情：; 页面的创建日期。 应按照 yyyy-MM-dd 的格式来指定日期，或者遵循 YAML Timestamp Type (https://yaml.org/type/timestamp.html) 。 参考：; Node API > Page 属性 > date (./node-api.md#date); des..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Frontmatter\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"date","slug":"date","link":"#date","children":[]},{"level":2,"title":"description","slug":"description","link":"#description","children":[]},{"level":2,"title":"head","slug":"head","link":"#head","children":[]},{"level":2,"title":"lang","slug":"lang","link":"#lang","children":[]},{"level":2,"title":"layout","slug":"layout","link":"#layout","children":[]},{"level":2,"title":"permalink","slug":"permalink","link":"#permalink","children":[]},{"level":2,"title":"permalinkPattern","slug":"permalinkpattern","link":"#permalinkpattern","children":[]},{"level":2,"title":"routeMeta","slug":"routemeta","link":"#routemeta","children":[]},{"level":2,"title":"title","slug":"title","link":"#title","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.56,"words":767},"filePathRelative":"zh/reference/frontmatter.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/getting-started.html-218659cd.js b/assets/getting-started.html-218659cd.js
new file mode 100644
index 00000000..f0e0c393
--- /dev/null
+++ b/assets/getting-started.html-218659cd.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-fb0f0066","path":"/guide/getting-started.html","title":"Getting Started","lang":"en-US","frontmatter":{"icon":"fa6-solid:lightbulb","description":"VuePress v2 is currently in beta stage. It's ready to be used for building your site, but the config and API are not stable enough, which is likely to have breaking changes betw...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/getting-started.html"}],["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":"VuePress v2 is currently in beta stage. It's ready to be used for building your site, but the config and API are not stable enough, which is likely to have breaking changes betw..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Getting Started\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Prerequisites","slug":"prerequisites","link":"#prerequisites","children":[]},{"level":2,"title":"Manual Installation","slug":"manual-installation","link":"#manual-installation","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.32,"words":397},"filePathRelative":"guide/getting-started.md","localizedDate":"February 22, 2023","autoDesc":true}`);export{e as data};
diff --git a/assets/getting-started.html-7cb9cdb6.js b/assets/getting-started.html-7cb9cdb6.js
new file mode 100644
index 00000000..3166e81f
--- /dev/null
+++ b/assets/getting-started.html-7cb9cdb6.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-37781588","path":"/zh/guide/getting-started.html","title":"快速上手","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:lightbulb","description":"VuePress v2 目前仍处于 beta 阶段。你已经可以用它来构建你的站点，但是它的配置和 API 还不够稳定，很可能会在 Minor 版本中发生 Breaking Changes 。因此，在每次更新 beta 版本之后，请一定要仔细阅读 更新日志 (https://github.com/vuepress/vuepress-next/blob/m...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/getting-started.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/getting-started.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"快速上手"}],["meta",{"property":"og:description","content":"VuePress v2 目前仍处于 beta 阶段。你已经可以用它来构建你的站点，但是它的配置和 API 还不够稳定，很可能会在 Minor 版本中发生 Breaking Changes 。因此，在每次更新 beta 版本之后，请一定要仔细阅读 更新日志 (https://github.com/vuepress/vuepress-next/blob/m..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"快速上手\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"依赖环境","slug":"依赖环境","link":"#依赖环境","children":[]},{"level":2,"title":"手动安装","slug":"手动安装","link":"#手动安装","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.75,"words":524},"filePathRelative":"zh/guide/getting-started.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/getting-started.html-82d2dd43.js b/assets/getting-started.html-82d2dd43.js
new file mode 100644
index 00000000..8fb6de56
--- /dev/null
+++ b/assets/getting-started.html-82d2dd43.js
@@ -0,0 +1,26 @@
+import{_ as p,W as h,X as v,$ as e,a0 as n,Y as s,Z as a,a1 as d,D as c}from"./framework-46b0e263.js";const g={},b=e("h1",{id:"getting-started",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#getting-started","aria-hidden":"true"},"#"),n(" Getting Started")],-1),m={class:"hint-container warning"},_=e("p",{class:"hint-container-title"},"Note",-1),k=e("code",null,"beta",-1),f={href:"https://github.com/vuepress/vuepress-next/blob/main/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"},y=e("h2",{id:"prerequisites",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#prerequisites","aria-hidden":"true"},"#"),n(" Prerequisites")],-1),x={href:"https://nodejs.org/",target:"_blank",rel:"noopener noreferrer"},P={href:"https://classic.yarnpkg.com/en/",target:"_blank",rel:"noopener noreferrer"},A={class:"hint-container tip"},N=e("p",{class:"hint-container-title"},"Tips",-1),q={href:"https://pnpm.io/",target:"_blank",rel:"noopener noreferrer"},S=e("code",null,"vue",-1),w=e("code",null,"@vuepress/client",-1),V=e("code",null,"pnpm add -D vue @vuepress/client@next",-1),j={href:"https://yarnpkg.com/",target:"_blank",rel:"noopener noreferrer"},I=e("code",null,"nodeLinker: 'node-modules'",-1),M={href:"https://yarnpkg.com/configuration/yarnrc#nodeLinker",target:"_blank",rel:"noopener noreferrer"},C=e("code",null,".yarnrc.yml",-1),L=d(`
This section will help you build a basic VuePress documentation site from ground up. If you already have an existing project and would like to keep documentation inside the project, start from Step 3.
Step 7: Serve the documentation site in the local server
`,6),X=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"pnpm"),n(` docs:dev
+`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),Z=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"yarn"),n(` docs:dev
+`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),$=e("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[e("pre",{class:"language-bash"},[e("code",null,[e("span",{class:"token function"},"npm"),n(` run docs:dev
+`)])]),e("div",{class:"line-numbers","aria-hidden":"true"},[e("div",{class:"line-number"})])],-1),F={href:"http://localhost:8080",target:"_blank",rel:"noopener noreferrer"};function J(K,Q){const t=c("ExternalLinkIcon"),r=c("CodeTabs"),u=c("RouterLink");return h(),v("div",null,[b,e("div",m,[_,e("p",null,[n("VuePress v2 is currently in "),k,n(" stage. It's ready to be used for building your site, but the config and API are not stable enough, which is likely to have breaking changes between minor releases. So make sure to read the "),e("a",f,[n("changelog"),s(t)]),n(" carefully each time you upgrade a beta version.")])]),y,e("ul",null,[e("li",null,[e("a",x,[n("Node.js v14.18.0+"),s(t)])]),e("li",null,[e("a",P,[n("Yarn v1 classic"),s(t)]),n(" (Optional)")])]),e("div",A,[N,e("ul",null,[e("li",null,[n("With "),e("a",q,[n("pnpm"),s(t)]),n(", you may need to install "),S,n(" and "),w,n(" as peer-dependencies, i.e. "),V,n(".")]),e("li",null,[n("With "),e("a",j,[n("yarn 2"),s(t)]),n(", you need to set "),I,n(" in your "),e("a",M,[C,s(t)]),n(" file.")])])]),L,s(r,{id:"58",data:[{title:"PNPM"},{title:"YARN"},{title:"NPM"}],active:0,"tab-id":"shell"},{tab0:a(({title:i,value:l,isActive:o})=>[D]),tab1:a(({title:i,value:l,isActive:o})=>[E]),tab2:a(({title:i,value:l,isActive:o})=>[R]),_:1}),T,s(r,{id:"76",data:[{title:"PNPM"},{title:"YARN"},{title:"NPM"}],active:0,"tab-id":"shell"},{tab0:a(({title:i,value:l,isActive:o})=>[Y]),tab1:a(({title:i,value:l,isActive:o})=>[B]),tab2:a(({title:i,value:l,isActive:o})=>[W]),_:1}),e("ul",null,[e("li",null,[G,n(": Add some "),e("a",H,[n("scripts"),s(t)]),n(" to "),O])]),z,s(r,{id:"118",data:[{title:"PNPM"},{title:"YARN"},{title:"NPM"}],active:0,"tab-id":"shell"},{tab0:a(({title:i,value:l,isActive:o})=>[X]),tab1:a(({title:i,value:l,isActive:o})=>[Z]),tab2:a(({title:i,value:l,isActive:o})=>[$]),_:1}),e("p",null,[n("VuePress will start a hot-reloading development server at "),e("a",F,[n("http://localhost:8080"),s(t)]),n(". When you modify your markdown files, the content in the browser will be auto updated.")]),e("p",null,[n("By now, you should have a basic but functional VuePress documentation site. Next, learn about the basics of "),s(u,{to:"/guide/configuration.html"},{default:a(()=>[n("configuration")]),_:1}),n(" in VuePress.")])])}const ee=p(g,[["render",J],["__file","getting-started.html.vue"]]);export{ee as default};
diff --git a/assets/getting-started.html-b0306b71.js b/assets/getting-started.html-b0306b71.js
new file mode 100644
index 00000000..8187e8c6
--- /dev/null
+++ b/assets/getting-started.html-b0306b71.js
@@ -0,0 +1,26 @@
+import{_ as p,W as h,X as v,$ as e,a0 as s,Y as n,Z as a,a1 as d,D as c}from"./framework-46b0e263.js";const b={},g=e("h1",{id:"快速上手",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#快速上手","aria-hidden":"true"},"#"),s(" 快速上手")],-1),m={class:"hint-container warning"},_=e("p",{class:"hint-container-title"},"注意",-1),k=e("code",null,"beta",-1),f={href:"https://github.com/vuepress/vuepress-next/blob/main/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"},x=e("h2",{id:"依赖环境",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#依赖环境","aria-hidden":"true"},"#"),s(" 依赖环境")],-1),P={href:"https://nodejs.org/",target:"_blank",rel:"noopener noreferrer"},A={href:"https://classic.yarnpkg.com/zh-Hans/",target:"_blank",rel:"noopener noreferrer"},N={class:"hint-container tip"},y=e("p",{class:"hint-container-title"},"提示",-1),V={href:"https://pnpm.io/zh/",target:"_blank",rel:"noopener noreferrer"},q=e("code",null,"vue",-1),M=e("code",null,"@vuepress/client",-1),j=e("code",null,"pnpm add -D vue @vuepress/client@next",-1),L={href:"https://yarnpkg.com/",target:"_blank",rel:"noopener noreferrer"},C={href:"https://yarnpkg.com/configuration/yarnrc#nodeLinker",target:"_blank",rel:"noopener noreferrer"},D=e("code",null,".yarnrc.yml",-1),E=e("code",null,"nodeLinker: 'node-modules'",-1),R=d(`
This plugin will significantly slow down the speed of data preparation, especially when you have a lot of pages. You can consider disabling this plugin in dev mode to get better development experience.
This attribute would also include contributors to the files listed in gitInclude.
`,24);function f(y,x){const l=s("NpmBadge"),t=s("RouterLink"),i=s("ExternalLinkIcon");return r(),d("div",null,[h,e(l,{package:"@vuepress/plugin-git"}),m,a("p",null,[n("The "),e(t,{to:"/reference/default-theme/config.html#lastupdated"},{default:o(()=>[n("lastUpdated")]),_:1}),n(" and "),e(t,{to:"/reference/default-theme/config.html#contributors"},{default:o(()=>[n("contributors")]),_:1}),n(" of default theme is powered by this plugin.")]),g,a("p",null,[n("This plugin requires your project to be inside a "),a("a",k,[n("Git Repository"),e(i)]),n(", so that it can collect information from the commit history.")]),a("p",null,[n("You should ensure all commits are available when building your site. For example, CI workflows usually clone your repository with "),a("a",v,[n("--depth 1"),e(i)]),n(" to avoid fetching all commits, so you should disable the behavior to make this plugin work properly in CI.")]),b])}const _=c(u,[["render",f],["__file","git.html.vue"]]);export{_ as default};
diff --git a/assets/git.html-3f427683.js b/assets/git.html-3f427683.js
new file mode 100644
index 00000000..705c52ab
--- /dev/null
+++ b/assets/git.html-3f427683.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-0f9e4c06","path":"/reference/plugin/git.html","title":"git","lang":"en-US","frontmatter":{"description":"This plugin will collect git information of your pages, including the created and updated time, the contributors, etc. The lastUpdated (../default-theme/config.md#lastupdated) a...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/git.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/git.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"git"}],["meta",{"property":"og:description","content":"This plugin will collect git information of your pages, including the created and updated time, the contributors, etc. The lastUpdated (../default-theme/config.md#lastupdated) a..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"git\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Git Repository","slug":"git-repository","link":"#git-repository","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"createdTime","slug":"createdtime","link":"#createdtime","children":[]},{"level":3,"title":"updatedTime","slug":"updatedtime","link":"#updatedtime","children":[]},{"level":3,"title":"contributors","slug":"contributors","link":"#contributors","children":[]}]},{"level":2,"title":"Frontmatter","slug":"frontmatter","link":"#frontmatter","children":[{"level":3,"title":"gitInclude","slug":"gitinclude","link":"#gitinclude","children":[]}]},{"level":2,"title":"Page Data","slug":"page-data","link":"#page-data","children":[{"level":3,"title":"git.createdTime","slug":"git-createdtime","link":"#git-createdtime","children":[]},{"level":3,"title":"git.updatedTime","slug":"git-updatedtime","link":"#git-updatedtime","children":[]},{"level":3,"title":"git.contributors","slug":"git-contributors","link":"#git-contributors","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.45,"words":436},"filePathRelative":"reference/plugin/git.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/git.html-e47476ae.js b/assets/git.html-e47476ae.js
new file mode 100644
index 00000000..fd41727f
--- /dev/null
+++ b/assets/git.html-e47476ae.js
@@ -0,0 +1,30 @@
+import{_ as l,W as r,X as d,Y as s,$ as a,a0 as n,Z as p,a1 as o,D as e}from"./framework-46b0e263.js";const u={},h=a("h1",{id:"git",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#git","aria-hidden":"true"},"#"),n(" git")],-1),k=a("p",null,"该插件会收集你的页面的 Git 信息，包括创建和更新时间、贡献者等。",-1),m=o(`
`,4),k={href:"https://support.google.com/analytics/answer/9234069",target:"_blank",rel:"noopener noreferrer"},_=n("code",null,"page_view",-1),m=n("code",null,"first_visit",-1),b=n("p",null,[s("So if you only want to collect some basic data of your site, you don't need to do anything else except setting the "),n("a",{href:"#id"},"Measurement ID"),s(" correctly.")],-1),y=n("code",null,"gtag()",-1),f=n("code",null,"window",-1),w={href:"https://developers.google.com/analytics/devguides/collection/ga4/events",target:"_blank",rel:"noopener noreferrer"},x=n("h2",{id:"options",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#options","aria-hidden":"true"},"#"),s(" Options")],-1),X=n("h3",{id:"id",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#id","aria-hidden":"true"},"#"),s(" id")],-1),A=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),D=n("p",null,"Details:",-1),I=n("p",null,[s("The Measurement ID of Google Analytics 4, which should start with "),n("code",null,"'G-'"),s(".")],-1),G={href:"https://support.google.com/analytics/answer/9539598",target:"_blank",rel:"noopener noreferrer"},N=n("li",null,[n("p",null,"Example:")],-1),V=t(`
`,1);function S(j,U){const l=o("NpmBadge"),a=o("ExternalLinkIcon");return c(),p("div",null,[u,e(l,{package:"@vuepress/plugin-google-analytics"}),n("p",null,[s("Integrate "),n("a",d,[s("Google Analytics"),e(a)]),s(" into VuePress.")]),n("p",null,[s("This plugin will import "),n("a",g,[s("gtag.js"),e(a)]),s(" for "),n("a",h,[s("Google Analytics 4"),e(a)]),s(".")]),v,n("p",null,[s("Google Analytics will "),n("a",k,[s("automatically collect some events"),e(a)]),s(", such as "),_,s(", "),m,s(", etc.")]),b,n("p",null,[s("After using this plugin, the global "),y,s(" function is available on the "),f,s(" object, and you can use it for "),n("a",w,[s("custom events reporting"),e(a)]),s(".")]),x,X,n("ul",null,[A,n("li",null,[D,I,n("p",null,[s("You can follow the instructions "),n("a",G,[s("here"),e(a)]),s(' to find your Measurement ID. Notice the difference between Google Analytics 4 Measurement ID (i.e. "G-" ID) and Universal Analytics Tracking ID (i.e. "UA-" ID).')])]),N]),V,n("ul",null,[q,n("li",null,[E,n("p",null,[s("Set to "),T,s(" to enable sending events to DebugView. "),n("a",B,[s("See more information on DebugView"),e(a)]),s(".")])]),P]),M])}const Y=i(r,[["render",S],["__file","google-analytics.html.vue"]]);export{Y as default};
diff --git a/assets/google-analytics.html-fe5b25b3.js b/assets/google-analytics.html-fe5b25b3.js
new file mode 100644
index 00000000..43e37564
--- /dev/null
+++ b/assets/google-analytics.html-fe5b25b3.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-b3f1b470","path":"/reference/plugin/google-analytics.html","title":"google-analytics","lang":"en-US","frontmatter":{"description":"Integrate Google Analytics (https://analytics.google.com/) into VuePress. This plugin will import gtag.js (https://developers.google.com/analytics/devguides/collection/gtagjs) f...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/google-analytics.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/google-analytics.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"google-analytics"}],["meta",{"property":"og:description","content":"Integrate Google Analytics (https://analytics.google.com/) into VuePress. This plugin will import gtag.js (https://developers.google.com/analytics/devguides/collection/gtagjs) f..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"google-analytics\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Reporting Events","slug":"reporting-events","link":"#reporting-events","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"id","slug":"id","link":"#id","children":[]},{"level":3,"title":"debug","slug":"debug","link":"#debug","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.82,"words":247},"filePathRelative":"reference/plugin/google-analytics.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/hero-8a9eb0cf.js b/assets/hero-8a9eb0cf.js
new file mode 100644
index 00000000..d90d6d57
--- /dev/null
+++ b/assets/hero-8a9eb0cf.js
@@ -0,0 +1 @@
+const o="/images/hero.png";export{o as _};
diff --git a/assets/i18n.html-979c3eb8.js b/assets/i18n.html-979c3eb8.js
new file mode 100644
index 00000000..dd046dee
--- /dev/null
+++ b/assets/i18n.html-979c3eb8.js
@@ -0,0 +1,41 @@
+import{_ as i,W as p,X as l,$ as s,a0 as n,Y as e,Z as t,a1 as o,D as c}from"./framework-46b0e263.js";const u={},r=o(`
exportdefault{
+ 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:
`,4),g={class:"hint-container tip"},f=s("p",{class:"hint-container-title"},"Tips",-1);function b(_,y){const a=c("RouterLink");return p(),l("div",null,[r,s("p",null,[n("Then, specify the "),d,n(" option in your "),e(a,{to:"/guide/configuration.html#config-file"},{default:t(()=>[n("config file")]),_:1}),n(":")]),v,s("div",m,[k,s("p",null,[n("Config reference: "),e(a,{to:"/reference/config.html#locales"},{default:t(()=>[n("locales")]),_:1})])]),h,s("div",g,[f,s("p",null,[n("Config reference: "),e(a,{to:"/reference/default-theme/config.html#locales"},{default:t(()=>[n("Default Theme > locales")]),_:1})])])])}const x=i(u,[["render",b],["__file","i18n.html.vue"]]);export{x as default};
diff --git a/assets/i18n.html-c6901264.js b/assets/i18n.html-c6901264.js
new file mode 100644
index 00000000..c9dd3486
--- /dev/null
+++ b/assets/i18n.html-c6901264.js
@@ -0,0 +1,41 @@
+import{_ as p,W as i,X as c,$ as s,a0 as n,Y as e,Z as t,a1 as o,D as l}from"./framework-46b0e263.js";const u={},r=o(`
`,4),b={class:"hint-container tip"},g=s("p",{class:"hint-container-title"},"提示",-1);function _(f,q){const a=l("RouterLink");return i(),c("div",null,[r,s("p",null,[n("然后，在你的 "),e(a,{to:"/zh/guide/configuration.html#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"},{default:t(()=>[n("配置文件")]),_:1}),n(" 中设置 "),d,n(" 选项：")]),v,s("div",k,[m,s("p",null,[n("配置参考： "),e(a,{to:"/zh/reference/config.html#locales"},{default:t(()=>[n("locales")]),_:1})])]),h,s("div",b,[g,s("p",null,[n("配置参考： "),e(a,{to:"/zh/reference/default-theme/config.html#locales"},{default:t(()=>[n("默认主题 > locales")]),_:1})])])])}const x=p(u,[["render",_],["__file","i18n.html.vue"]]);export{x as default};
diff --git a/assets/i18n.html-cd078675.js b/assets/i18n.html-cd078675.js
new file mode 100644
index 00000000..6d01f6fc
--- /dev/null
+++ b/assets/i18n.html-cd078675.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-acb10be2","path":"/guide/i18n.html","title":"I18n","lang":"en-US","frontmatter":{"icon":"fa6-solid:language","description":"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 in y...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/i18n.html"}],["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":"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 in y..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"I18n\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Site I18n Config","slug":"site-i18n-config","link":"#site-i18n-config","children":[]},{"level":2,"title":"Theme I18n Config","slug":"theme-i18n-config","link":"#theme-i18n-config","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.87,"words":260},"filePathRelative":"guide/i18n.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/i18n.html-d3e7282a.js b/assets/i18n.html-d3e7282a.js
new file mode 100644
index 00000000..a2cdce46
--- /dev/null
+++ b/assets/i18n.html-d3e7282a.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4b8f1400","path":"/zh/guide/i18n.html","title":"多语言支持","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:language","description":"站点多语言配置 要启用 VuePress 的多语言支持，首先需要使用如下的文件目录结构： 然后，在你的 配置文件 (./configuration.md#配置文件) 中设置 locales 选项： 如果一个语言没有声明 lang, title, description 或者 head ，VuePress 将会尝试使用顶层配置的对应值。如果每个语言都声明...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/i18n.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/i18n.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"多语言支持"}],["meta",{"property":"og:description","content":"站点多语言配置 要启用 VuePress 的多语言支持，首先需要使用如下的文件目录结构： 然后，在你的 配置文件 (./configuration.md#配置文件) 中设置 locales 选项： 如果一个语言没有声明 lang, title, description 或者 head ，VuePress 将会尝试使用顶层配置的对应值。如果每个语言都声明..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"多语言支持\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"站点多语言配置","slug":"站点多语言配置","link":"#站点多语言配置","children":[]},{"level":2,"title":"主题多语言配置","slug":"主题多语言配置","link":"#主题多语言配置","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.22,"words":367},"filePathRelative":"zh/guide/i18n.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/index.html-01e674f5.js b/assets/index.html-01e674f5.js
new file mode 100644
index 00000000..d70d3c4a
--- /dev/null
+++ b/assets/index.html-01e674f5.js
@@ -0,0 +1 @@
+import{_ as e,W as o,X as a,a1 as t}from"./framework-46b0e263.js";const r={},n=t('
',5),s=[n];function c(i,d){return o(),a("div",null,s)}const l=e(r,[["render",c],["__file","index.html.vue"]]);export{l as default};
diff --git a/assets/index.html-1c40c637.js b/assets/index.html-1c40c637.js
new file mode 100644
index 00000000..772f7885
--- /dev/null
+++ b/assets/index.html-1c40c637.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-43e2b7cf","path":"/reference/default-theme/","title":"Default Theme","lang":"en-US","frontmatter":{"title":"Default Theme","article":false,"feed":false,"sitemap":false,"description":"","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/default-theme/"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/default-theme/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Default Theme"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Default Theme\\"}"]]},"headers":[],"git":{},"readingTime":{"minutes":0.03,"words":9},"filePathRelative":null,"autoDesc":true}');export{e as data};
diff --git a/assets/index.html-1fc2b45e.js b/assets/index.html-1fc2b45e.js
new file mode 100644
index 00000000..cead33c5
--- /dev/null
+++ b/assets/index.html-1fc2b45e.js
@@ -0,0 +1,38 @@
+import{_ as c,W as r,X as o,Y as d,Z as e,$ as s,a0 as n,D as u}from"./framework-46b0e263.js";const m={},p=s("h3",{id:"as-easy-as-1-2-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#as-easy-as-1-2-3","aria-hidden":"true"},"#"),n(" As Easy as 1, 2, 3")],-1),v=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"language-bash"},[s("code",null,[s("span",{class:"token comment"},"# install in your project"),n(`
+`),s("span",{class:"token function"},"pnpm"),n(),s("span",{class:"token function"},"add"),n(),s("span",{class:"token parameter variable"},"-D"),n(` vuepress@next @vuepress/client@next vue
+
+`),s("span",{class:"token comment"},"# create a markdown file"),n(`
+`),s("span",{class:"token builtin class-name"},"echo"),n(),s("span",{class:"token string"},"'# Hello VuePress'"),n(),s("span",{class:"token operator"},">"),n(` README.md
+
+`),s("span",{class:"token comment"},"# start writing"),n(`
+`),s("span",{class:"token function"},"pnpm"),n(` vuepress dev
+
+`),s("span",{class:"token comment"},"# build to static files"),n(`
+`),s("span",{class:"token function"},"pnpm"),n(` vuepress build
+`)])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"})])],-1),b=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"language-bash"},[s("code",null,[s("span",{class:"token comment"},"# install in your project"),n(`
+`),s("span",{class:"token function"},"yarn"),n(),s("span",{class:"token function"},"add"),n(),s("span",{class:"token parameter variable"},"-D"),n(` vuepress@next
+
+`),s("span",{class:"token comment"},"# create a markdown file"),n(`
+`),s("span",{class:"token builtin class-name"},"echo"),n(),s("span",{class:"token string"},"'# Hello VuePress'"),n(),s("span",{class:"token operator"},">"),n(` README.md
+
+`),s("span",{class:"token comment"},"# start writing"),n(`
+`),s("span",{class:"token function"},"yarn"),n(` vuepress dev
+
+`),s("span",{class:"token comment"},"# build to static files"),n(`
+`),s("span",{class:"token function"},"yarn"),n(` vuepress build
+`)])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"})])],-1),k=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"language-bash"},[s("code",null,[s("span",{class:"token comment"},"# install in your project"),n(`
+`),s("span",{class:"token function"},"npm"),n(),s("span",{class:"token function"},"install"),n(),s("span",{class:"token parameter variable"},"-D"),n(` vuepress@next
+
+`),s("span",{class:"token comment"},"# create a markdown file"),n(`
+
+`),s("span",{class:"token builtin class-name"},"echo"),n(),s("span",{class:"token string"},"'# Hello VuePress'"),n(),s("span",{class:"token operator"},">"),n(` README.md
+
+`),s("span",{class:"token comment"},"# start writing"),n(`
+
+npx vuepress dev
+
+`),s("span",{class:"token comment"},"# build to static files"),n(`
+
+npx vuepress build
+
+`)])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"}),s("div",{class:"line-number"})])],-1);function h(f,_){const t=u("CodeTabs");return r(),o("div",null,[p,d(t,{id:"3",data:[{title:"PNPM"},{title:"YARN"},{title:"NPM"}],active:0,"tab-id":"shell"},{tab0:e(({title:a,value:l,isActive:i})=>[v]),tab1:e(({title:a,value:l,isActive:i})=>[b]),tab2:e(({title:a,value:l,isActive:i})=>[k]),_:1})])}const x=c(m,[["render",h],["__file","index.html.vue"]]);export{x as default};
diff --git a/assets/index.html-2130e344.js b/assets/index.html-2130e344.js
new file mode 100644
index 00000000..4faf065b
--- /dev/null
+++ b/assets/index.html-2130e344.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-16d7d7b6","path":"/zh/advanced/","title":"Advanced","lang":"en-US","frontmatter":{"title":"Advanced","article":false,"feed":false,"sitemap":false,"description":"","head":[["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"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Advanced\\"}"]]},"headers":[],"git":{},"readingTime":{"minutes":0.03,"words":9},"filePathRelative":null,"autoDesc":true}');export{e as data};
diff --git a/assets/index.html-2f61641e.js b/assets/index.html-2f61641e.js
new file mode 100644
index 00000000..5aafd7d4
--- /dev/null
+++ b/assets/index.html-2f61641e.js
@@ -0,0 +1 @@
+import{_,W as a,X as l,Y as o,Z as s,D as e}from"./framework-46b0e263.js";const r={};function i(m,p){const n=e("HopeIcon"),t=e("AutoCatalog");return a(),l("div",null,[o(t,null,{icon:s(({icon:c})=>[o(n,{icon:c},null,8,["icon"])]),_:1})])}const d=_(r,[["render",i],["__file","index.html.vue"]]);export{d as default};
diff --git a/assets/index.html-3a17c39d.js b/assets/index.html-3a17c39d.js
new file mode 100644
index 00000000..9a1e3fee
--- /dev/null
+++ b/assets/index.html-3a17c39d.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-70e5a528","path":"/zh/reference/","title":"Reference","lang":"en-US","frontmatter":{"title":"Reference","article":false,"feed":false,"sitemap":false,"description":"","head":[["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Reference"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Reference\\"}"]]},"headers":[],"git":{},"readingTime":{"minutes":0.03,"words":9},"filePathRelative":null,"autoDesc":true}');export{e as data};
diff --git a/assets/index.html-3afbf148.js b/assets/index.html-3afbf148.js
new file mode 100644
index 00000000..c99e3093
--- /dev/null
+++ b/assets/index.html-3afbf148.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-03c9312a","path":"/advanced/cookbook/","title":"Introduction","lang":"en-US","frontmatter":{"icon":"fa6-solid:circle-info","description":"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 may not know ...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/"}],["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":"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 may not know ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Introduction\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"What's the Cookbook for?","slug":"what-s-the-cookbook-for","link":"#what-s-the-cookbook-for","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.25,"words":75},"filePathRelative":"advanced/cookbook/README.md","localizedDate":"February 22, 2023","autoDesc":true}`);export{e as data};
diff --git a/assets/index.html-48204d48.js b/assets/index.html-48204d48.js
new file mode 100644
index 00000000..5aafd7d4
--- /dev/null
+++ b/assets/index.html-48204d48.js
@@ -0,0 +1 @@
+import{_,W as a,X as l,Y as o,Z as s,D as e}from"./framework-46b0e263.js";const r={};function i(m,p){const n=e("HopeIcon"),t=e("AutoCatalog");return a(),l("div",null,[o(t,null,{icon:s(({icon:c})=>[o(n,{icon:c},null,8,["icon"])]),_:1})])}const d=_(r,[["render",i],["__file","index.html.vue"]]);export{d as default};
diff --git a/assets/index.html-5b546a26.js b/assets/index.html-5b546a26.js
new file mode 100644
index 00000000..3450b762
--- /dev/null
+++ b/assets/index.html-5b546a26.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-2d0ad528","path":"/zh/","title":"首页","lang":"zh-CN","frontmatter":{"home":true,"icon":"fa6-solid:house","title":"首页","heroImage":"/images/hero.png","actions":[{"text":"快速上手","link":"/zh/guide/getting-started.html","type":"primary"},{"text":"项目简介","link":"/zh/guide/","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 。选一个你喜欢的来使用吧！"}],"description":"像数 1, 2, 3 一样容易 ::: code-tabs#shell tab:active PNPM tab:active YARN tab:active NPM :::","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"首页"}],["meta",{"property":"og:description","content":"像数 1, 2, 3 一样容易 ::: code-tabs#shell tab:active PNPM tab:active YARN tab:active NPM :::"}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"首页\\",\\"description\\":\\"像数 1, 2, 3 一样容易 ::: code-tabs#shell tab:active PNPM tab:active YARN tab:active NPM :::\\"}"]]},"headers":[{"level":3,"title":"像数 1, 2, 3 一样容易","slug":"像数-1-2-3-一样容易","link":"#像数-1-2-3-一样容易","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.4,"words":421},"filePathRelative":"zh/README.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/index.html-5e4b3f7a.js b/assets/index.html-5e4b3f7a.js
new file mode 100644
index 00000000..5aafd7d4
--- /dev/null
+++ b/assets/index.html-5e4b3f7a.js
@@ -0,0 +1 @@
+import{_,W as a,X as l,Y as o,Z as s,D as e}from"./framework-46b0e263.js";const r={};function i(m,p){const n=e("HopeIcon"),t=e("AutoCatalog");return a(),l("div",null,[o(t,null,{icon:s(({icon:c})=>[o(n,{icon:c},null,8,["icon"])]),_:1})])}const d=_(r,[["render",i],["__file","index.html.vue"]]);export{d as default};
diff --git a/assets/index.html-62511030.js b/assets/index.html-62511030.js
new file mode 100644
index 00000000..a6a99e25
--- /dev/null
+++ b/assets/index.html-62511030.js
@@ -0,0 +1 @@
+import{_ as r,W as a,X as i,$ as t,a0 as e,Y as n,a1 as s,D as d}from"./framework-46b0e263.js";const l={},c=t("h1",{id:"introduction",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#introduction","aria-hidden":"true"},"#"),e(" Introduction")],-1),h={href:"https://en.wikipedia.org/wiki/Markdown",target:"_blank",rel:"noopener noreferrer"},u=t("p",null,"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.",-1),p=t("h2",{id:"how-it-works",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#how-it-works","aria-hidden":"true"},"#"),e(" How It Works")],-1),f={href:"https://vuejs.org/",target:"_blank",rel:"noopener noreferrer"},m={href:"https://router.vuejs.org",target:"_blank",rel:"noopener noreferrer"},g={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"},w=t("p",null,"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.",-1),b={href:"https://nuxtjs.org/",target:"_blank",rel:"noopener noreferrer"},_=t("code",null,"nuxt generate",-1),v={href:"https://www.gatsbyjs.org/",target:"_blank",rel:"noopener noreferrer"},y=s('
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
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.
Docsify / Docute
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
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.
GitBook
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.
',6);function k(V,x){const o=d("ExternalLinkIcon");return a(),i("div",null,[c,t("p",null,[e("VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in "),t("a",h,[e("Markdown"),n(o)]),e(", then VuePress will help you to generate a static site to host them.")]),u,p,t("p",null,[e("A VuePress site is in fact a single-page application (SPA) powered by "),t("a",f,[e("Vue"),n(o)]),e(" and "),t("a",m,[e("Vue Router"),n(o)]),e(".")]),t("p",null,[e("Routes are generated according to the relative path of your markdown files. Each Markdown file is compiled into HTML with "),t("a",g,[e("markdown-it"),n(o)]),e(" 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.")]),w,t("p",null,[e("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 "),t("a",b,[e("Nuxt"),n(o)]),e("'s "),_,e(" command and other projects like "),t("a",v,[e("Gatsby"),n(o)]),e(".")]),y])}const j=r(l,[["render",k],["__file","index.html.vue"]]);export{j as default};
diff --git a/assets/index.html-78973204.js b/assets/index.html-78973204.js
new file mode 100644
index 00000000..5aafd7d4
--- /dev/null
+++ b/assets/index.html-78973204.js
@@ -0,0 +1 @@
+import{_,W as a,X as l,Y as o,Z as s,D as e}from"./framework-46b0e263.js";const r={};function i(m,p){const n=e("HopeIcon"),t=e("AutoCatalog");return a(),l("div",null,[o(t,null,{icon:s(({icon:c})=>[o(n,{icon:c},null,8,["icon"])]),_:1})])}const d=_(r,[["render",i],["__file","index.html.vue"]]);export{d as default};
diff --git a/assets/index.html-7e872e5b.js b/assets/index.html-7e872e5b.js
new file mode 100644
index 00000000..7f62b550
--- /dev/null
+++ b/assets/index.html-7e872e5b.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-47357bdb","path":"/zh/guide/","title":"介绍","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:circle-info","description":"VuePress 是一个以 Markdown 为中心的静态网站生成器。你可以使用 Markdown (https://zh.wikipedia.org/wiki/Markdown) 来书写内容（如文档、博客等），然后 VuePress 会帮助你生成一个静态网站来展示它们。 VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求，但是...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"介绍"}],["meta",{"property":"og:description","content":"VuePress 是一个以 Markdown 为中心的静态网站生成器。你可以使用 Markdown (https://zh.wikipedia.org/wiki/Markdown) 来书写内容（如文档、博客等），然后 VuePress 会帮助你生成一个静态网站来展示它们。 VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求，但是..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"介绍\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"它是如何工作的？","slug":"它是如何工作的","link":"#它是如何工作的","children":[]},{"level":2,"title":"为什么不是 ...?","slug":"为什么不是","link":"#为什么不是","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.81,"words":842},"filePathRelative":"zh/guide/README.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/index.html-80a01853.js b/assets/index.html-80a01853.js
new file mode 100644
index 00000000..9553da34
--- /dev/null
+++ b/assets/index.html-80a01853.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-fffb8e28","path":"/guide/","title":"Introduction","lang":"en-US","frontmatter":{"icon":"fa6-solid:circle-info","description":"VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown (https://en.wikipedia.org/wiki/Markdown), then VuePre...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/"}],["meta",{"property":"og:url","content":"https://vuejs.press/guide/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Introduction"}],["meta",{"property":"og:description","content":"VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdown (https://en.wikipedia.org/wiki/Markdown), then VuePre..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Introduction\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"How It Works","slug":"how-it-works","link":"#how-it-works","children":[]},{"level":2,"title":"Why Not ...?","slug":"why-not","link":"#why-not","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.77,"words":530},"filePathRelative":"guide/README.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/index.html-842ca072.js b/assets/index.html-842ca072.js
new file mode 100644
index 00000000..2dc11258
--- /dev/null
+++ b/assets/index.html-842ca072.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-d61a9282","path":"/reference/plugin/","title":"Plugin","lang":"en-US","frontmatter":{"title":"Plugin","article":false,"feed":false,"sitemap":false,"description":"","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Plugin"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Plugin\\"}"]]},"headers":[],"git":{},"readingTime":{"minutes":0.03,"words":9},"filePathRelative":null,"autoDesc":true}');export{e as data};
diff --git a/assets/index.html-89525fb9.js b/assets/index.html-89525fb9.js
new file mode 100644
index 00000000..5aafd7d4
--- /dev/null
+++ b/assets/index.html-89525fb9.js
@@ -0,0 +1 @@
+import{_,W as a,X as l,Y as o,Z as s,D as e}from"./framework-46b0e263.js";const r={};function i(m,p){const n=e("HopeIcon"),t=e("AutoCatalog");return a(),l("div",null,[o(t,null,{icon:s(({icon:c})=>[o(n,{icon:c},null,8,["icon"])]),_:1})])}const d=_(r,[["render",i],["__file","index.html.vue"]]);export{d as default};
diff --git a/assets/index.html-96c02e47.js b/assets/index.html-96c02e47.js
new file mode 100644
index 00000000..eb601850
--- /dev/null
+++ b/assets/index.html-96c02e47.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-22a2f9fd","path":"/reference/","title":"Reference","lang":"en-US","frontmatter":{"title":"Reference","article":false,"feed":false,"sitemap":false,"description":"","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Reference"}],["meta",{"property":"og:type","content":"website"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"WebPage\\",\\"name\\":\\"Reference\\"}"]]},"headers":[],"git":{},"readingTime":{"minutes":0.03,"words":9},"filePathRelative":null,"autoDesc":true}');export{e as data};
diff --git a/assets/index.html-9ac61946.js b/assets/index.html-9ac61946.js
new file mode 100644
index 00000000..5aafd7d4
--- /dev/null
+++ b/assets/index.html-9ac61946.js
@@ -0,0 +1 @@
+import{_,W as a,X as l,Y as o,Z as s,D as e}from"./framework-46b0e263.js";const r={};function i(m,p){const n=e("HopeIcon"),t=e("AutoCatalog");return a(),l("div",null,[o(t,null,{icon:s(({icon:c})=>[o(n,{icon:c},null,8,["icon"])]),_:1})])}const d=_(r,[["render",i],["__file","index.html.vue"]]);export{d as default};
diff --git a/assets/index.html-a69c820c.js b/assets/index.html-a69c820c.js
new file mode 100644
index 00000000..5aafd7d4
--- /dev/null
+++ b/assets/index.html-a69c820c.js
@@ -0,0 +1 @@
+import{_,W as a,X as l,Y as o,Z as s,D as e}from"./framework-46b0e263.js";const r={};function i(m,p){const n=e("HopeIcon"),t=e("AutoCatalog");return a(),l("div",null,[o(t,null,{icon:s(({icon:c})=>[o(n,{icon:c},null,8,["icon"])]),_:1})])}const d=_(r,[["render",i],["__file","index.html.vue"]]);export{d as default};
diff --git a/assets/index.html-a809ce07.js b/assets/index.html-a809ce07.js
new file mode 100644
index 00000000..bdb551d0
--- /dev/null
+++ b/assets/index.html-a809ce07.js
@@ -0,0 +1 @@
+import{_ as o,W as s,X as a,$ as t,a0 as e,Y as n,a1 as i,D as c}from"./framework-46b0e263.js";const d={},l=t("h1",{id:"介绍",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#介绍","aria-hidden":"true"},"#"),e(" 介绍")],-1),h={href:"https://zh.wikipedia.org/wiki/Markdown",target:"_blank",rel:"noopener noreferrer"},u=t("p",null,"VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求，但是现在它已经在帮助大量用户构建他们的文档、博客和其他静态网站。",-1),p=t("h2",{id:"它是如何工作的",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#它是如何工作的","aria-hidden":"true"},"#"),e(" 它是如何工作的？")],-1),_={href:"https://vuejs.org/",target:"_blank",rel:"noopener noreferrer"},V={href:"https://router.vuejs.org",target:"_blank",rel:"noopener noreferrer"},k={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"},f=t("p",null,"在开发过程中，我们启动一个常规的开发服务器 (dev-server) ，并将 VuePress 站点作为一个常规的 SPA。如果你以前使用过 Vue 的话，你在使用时会感受到非常熟悉的开发体验。",-1),x={href:"https://nuxtjs.org/",target:"_blank",rel:"noopener noreferrer"},v=t("code",null,"nuxt generate",-1),P={href:"https://www.gatsbyjs.org/",target:"_blank",rel:"noopener noreferrer"},w=i('
`,11);function v(m,g){const a=u("RouterLink");return o(),c("div",null,[r,k,s("p",null,[n("借助于 "),t(a,{to:"/zh/reference/theme-api.html"},{default:e(()=>[n("主题 API")]),_:1}),n(" ，你可以让用户继承你的主题，允许用户对你的主题进行改动。")]),s("p",null,[n("你肯定已经知道了如何 "),t(a,{to:"/zh/reference/default-theme/extending.html"},{default:e(()=>[n("继承默认主题")]),_:1}),n(" 。接下来我们将介绍如何让你的主题像默认主题一样被用户继承。")]),d])}const h=p(i,[["render",v],["__file","making-a-theme-extendable.html.vue"]]);export{h as default};
diff --git a/assets/making-a-theme-extendable.html-8d323011.js b/assets/making-a-theme-extendable.html-8d323011.js
new file mode 100644
index 00000000..eb3fdbda
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-8d323011.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-04c514ac","path":"/zh/advanced/cookbook/making-a-theme-extendable.html","title":"开发一个可继承的主题","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:clone","description":"有时用户可能希望对一个主题进行一些小改动，但是又不想 Fork 并修改整个项目。 借助于 主题 API (../../reference/theme-api.md) ，你可以让用户继承你的主题，允许用户对你的主题进行改动。 你肯定已经知道了如何 继承默认主题 (../../reference/default-theme/extending.md) 。接...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/cookbook/making-a-theme-extendable.html"}],["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 并修改整个项目。 借助于 主题 API (../../reference/theme-api.md) ，你可以让用户继承你的主题，允许用户对你的主题进行改动。 你肯定已经知道了如何 继承默认主题 (../../reference/default-theme/extending.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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"开发一个可继承的主题\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"布局插槽","slug":"布局插槽","link":"#布局插槽","children":[]},{"level":2,"title":"组件别名","slug":"组件别名","link":"#组件别名","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.41,"words":424},"filePathRelative":"zh/advanced/cookbook/making-a-theme-extendable.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/making-a-theme-extendable.html-9a9a0ccd.js b/assets/making-a-theme-extendable.html-9a9a0ccd.js
new file mode 100644
index 00000000..929b2905
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-9a9a0ccd.js
@@ -0,0 +1,35 @@
+import{_ as p,W as o,X as c,$ as s,a0 as n,Y as t,Z as e,a1 as l,D as u}from"./framework-46b0e263.js";const i={},r=s("h1",{id:"making-a-theme-extendable",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#making-a-theme-extendable","aria-hidden":"true"},"#"),n(" Making a Theme Extendable")],-1),k=s("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),d=l(`
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:
Then, users can replace specific components by overriding the alias when extending or using your theme.
`,11);function m(v,g){const a=u("RouterLink");return o(),c("div",null,[r,k,s("p",null,[n("With the help of "),t(a,{to:"/reference/theme-api.html"},{default:e(()=>[n("Theme API")]),_:1}),n(", you can make your theme extendable, allowing users to make their own modifications easily.")]),s("p",null,[n("You must have known that how to "),t(a,{to:"/reference/default-theme/extending.html"},{default:e(()=>[n("extend default theme")]),_:1}),n(". Here we'll introduce how to make your own theme extendable like default theme.")]),d])}const b=p(i,[["render",m],["__file","making-a-theme-extendable.html.vue"]]);export{b as default};
diff --git a/assets/making-a-theme-extendable.html-f8f662ca.js b/assets/making-a-theme-extendable.html-f8f662ca.js
new file mode 100644
index 00000000..54237581
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-f8f662ca.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-06adec7d","path":"/advanced/cookbook/making-a-theme-extendable.html","title":"Making a Theme Extendable","lang":"en-US","frontmatter":{"icon":"fa6-solid:clone","description":"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 Theme API (../../reference/theme-api.m...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/making-a-theme-extendable.html"}],["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":"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 Theme API (../../reference/theme-api.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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Making a Theme Extendable\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Layout Slots","slug":"layout-slots","link":"#layout-slots","children":[]},{"level":2,"title":"Component Aliases","slug":"component-aliases","link":"#component-aliases","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.96,"words":289},"filePathRelative":"advanced/cookbook/making-a-theme-extendable.md","localizedDate":"February 22, 2023","autoDesc":true}`);export{e as data};
diff --git a/assets/markdown-and-vue-sfc.html-0af2e2a9.js b/assets/markdown-and-vue-sfc.html-0af2e2a9.js
new file mode 100644
index 00000000..a3ba567f
--- /dev/null
+++ b/assets/markdown-and-vue-sfc.html-0af2e2a9.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4e3c9b8c","path":"/advanced/cookbook/markdown-and-vue-sfc.html","title":"Markdown and Vue SFC","lang":"en-US","frontmatter":{"icon":"fa6-brands:vuejs","description":"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 and are treated as Vue SFC ...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/markdown-and-vue-sfc.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/cookbook/markdown-and-vue-sfc.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Markdown and Vue SFC"}],["meta",{"property":"og:description","content":"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 and are treated as Vue SFC ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Markdown and Vue SFC\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.72,"words":215},"filePathRelative":"advanced/cookbook/markdown-and-vue-sfc.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/markdown-and-vue-sfc.html-5c47f4ae.js b/assets/markdown-and-vue-sfc.html-5c47f4ae.js
new file mode 100644
index 00000000..857b49da
--- /dev/null
+++ b/assets/markdown-and-vue-sfc.html-5c47f4ae.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-63e02eaa","path":"/zh/advanced/cookbook/markdown-and-vue-sfc.html","title":"Markdown 与 Vue SFC","lang":"zh-CN","frontmatter":{"icon":"fa6-brands:vuejs","description":"每一个 Markdown 文件，首先都会编译为 HTML ，然后转换为一个 Vue 单文件组件 (SFC) 。换句话说，你可以像写 Vue SFC 一样来写 Markdown 文件： 和 标签会直接被当作 Vue SFC 中的标签。换句话说，它们是从 标签中提升到了 SFC 的顶层。; 所有 和 标签的以外的内容，会先被编译为 HTML ，然后被当作 ...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/cookbook/markdown-and-vue-sfc.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/advanced/cookbook/markdown-and-vue-sfc.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Markdown 与 Vue SFC"}],["meta",{"property":"og:description","content":"每一个 Markdown 文件，首先都会编译为 HTML ，然后转换为一个 Vue 单文件组件 (SFC) 。换句话说，你可以像写 Vue SFC 一样来写 Markdown 文件： 和 标签会直接被当作 Vue SFC 中的标签。换句话说，它们是从 标签中提升到了 SFC 的顶层。; 所有 和 标签的以外的内容，会先被编译为 HTML ，然后被当作 ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Markdown 与 Vue SFC\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.96,"words":287},"filePathRelative":"zh/advanced/cookbook/markdown-and-vue-sfc.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/markdown-and-vue-sfc.html-dc45e8fd.js b/assets/markdown-and-vue-sfc.html-dc45e8fd.js
new file mode 100644
index 00000000..aafa3e7c
--- /dev/null
+++ b/assets/markdown-and-vue-sfc.html-dc45e8fd.js
@@ -0,0 +1,31 @@
+import{_ as c,r as l,W as i,X as u,$ as n,a5 as t,Y as d,Z as r,a1 as k,j as v}from"./framework-46b0e263.js";const m=k(`
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.
Note
As Vue SFC can contain only one <script> element, you should avoid using more than one <script> in VuePress markdown.
`,8),g={__name:"markdown-and-vue-sfc.html",setup(b){const e=(o,s)=>v("div",{class:"red-div"},s.slots.default()),p="Vue in Markdown",a=l(0);return(o,s)=>(i(),u("div",null,[m,n("p",null,[n("em",null,"Hello, "+t(p))]),d(e,null,{default:r(()=>[n("p",null,[n("em",null,"Current count is: "+t(a.value),1)])]),_:1}),n("p",null,[n("button",{onClick:s[0]||(s[0]=f=>a.value++)},"Click Me!")])]))}},_=c(g,[["__file","markdown-and-vue-sfc.html.vue"]]);export{_ as default};
diff --git a/assets/markdown-and-vue-sfc.html-ed00f986.js b/assets/markdown-and-vue-sfc.html-ed00f986.js
new file mode 100644
index 00000000..dfcec673
--- /dev/null
+++ b/assets/markdown-and-vue-sfc.html-ed00f986.js
@@ -0,0 +1,31 @@
+import{_ as o,r as l,W as i,X as u,$ as n,a5 as t,Y as d,Z as r,a1 as k,j as v}from"./framework-46b0e263.js";const m=k(`
`,8),g={__name:"markdown-and-vue-sfc.html",setup(b){const e=(c,s)=>v("div",{class:"red-div"},s.slots.default()),p="Markdown 中的 Vue",a=l(0);return(c,s)=>(i(),u("div",null,[m,n("p",null,[n("em",null,"你好， "+t(p))]),d(e,null,{default:r(()=>[n("p",null,[n("em",null,"当前计数为： "+t(a.value),1)])]),_:1}),n("p",null,[n("button",{onClick:s[0]||(s[0]=_=>a.value++)},"点我！")])]))}},w=o(g,[["__file","markdown-and-vue-sfc.html.vue"]]);export{w as default};
diff --git a/assets/markdown.html-02e69834.js b/assets/markdown.html-02e69834.js
new file mode 100644
index 00000000..be01a7db
--- /dev/null
+++ b/assets/markdown.html-02e69834.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-176c9c4a","path":"/reference/default-theme/markdown.html","title":"Markdown","lang":"en-US","frontmatter":{"icon":"fa6-brands:markdown","description":"Custom Containers Usage:; The type is required, and the title and content are optional. Supported type : tip; warning; danger; details; Alias of CodeGroup (./components.md#codeg...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/default-theme/markdown.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/default-theme/markdown.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Markdown"}],["meta",{"property":"og:description","content":"Custom Containers Usage:; The type is required, and the title and content are optional. Supported type : tip; warning; danger; details; Alias of CodeGroup (./components.md#codeg..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Markdown\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Custom Containers","slug":"custom-containers","link":"#custom-containers","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.61,"words":184},"filePathRelative":"reference/default-theme/markdown.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/markdown.html-72308ea5.js b/assets/markdown.html-72308ea5.js
new file mode 100644
index 00000000..ec1a2e3a
--- /dev/null
+++ b/assets/markdown.html-72308ea5.js
@@ -0,0 +1,59 @@
+import{_ as p,W as v,X as m,Y as e,$ as n,a0 as s,Z as a,a1 as t,D as i}from"./framework-46b0e263.js";const g={},b=n("h1",{id:"markdown",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown","aria-hidden":"true"},"#"),s(" Markdown")],-1),k=n("h2",{id:"custom-containers",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#custom-containers","aria-hidden":"true"},"#"),s(" Custom Containers")],-1),h=t(`
Usage:
::: <type> [title]
+[content]
+:::
+
The type is required, and the title and content are optional.
::: tip
+
+This is a tip
+
+:::
+
+::: warning
+
+This is a warning
+
+:::
+
+::: danger
+
+This is a dangerous warning
+
+:::
+
+::: details
+This is a details block
+
+:::
+
Output
Tips
This is a tip
Note
This is a warning
Warning
This is a dangerous warning
Details
This is a details block
Example 2 (custom title):
Input
::: danger STOP
+Danger zone, do not proceed
+
+:::
+
+::: details Click me to view the code
+
+\`\`\`ts
+console.log("Hello, VuePress!");
+\`\`\`
+
+:::
+
\`\`\`ts
+// 行号默认是启用的
+const line2 ="This is line 2";
+const line3 ="This is line 3";
+\`\`\`
+
+\`\`\`ts:no-line-numbers
+// 行号被禁用
+const line2 ='This is line 2'
+const line3 ='This is line 3'
+\`\`\`
+
输出
// 行号默认是启用的
+const line2 ="This is line 2";
+const line3 ="This is line 3";
+
// 行号被禁用
+const line2 ='This is line 2'
+const line3 ='This is line 3'
+
"),a(o)]),s(" 和 "),n("a",$n,[s(""),a(o)]),s(" 等。")]),n("li",null,[n("a",Kn,[s("MathML 标签"),a(o)]),s("，它们可能会被一些 markdown-it 的 LaTeX 插件用到。")])]),Qn,n("ul",null,[n("li",null,[s("添加一个 "),n("a",ns,[s("v-pre"),a(o)]),s(" 指令来跳过这个元素和它的子元素的编译过程。注意所有的模板语法也都会失效。")]),n("li",null,[s("设置 "),n("a",ss,[s("compilerOptions.isCustomElement"),a(o)]),s(" 来告诉 Vue 模板编译器不要尝试作为组件来解析它们。 "),n("ul",null,[n("li",null,[s("对于 "),as,s(" ，设置 "),a(t,{to:"/zh/reference/bundler/webpack.html#vue"},{default:e(()=>[s("vue.compilerOptions")]),_:1})]),n("li",null,[s("对于 "),es,s(" ，设置 "),a(t,{to:"/zh/reference/bundler/vite.html#vuepluginoptions"},{default:e(()=>[s("vuePluginOptions.template.compilerOptions")]),_:1})])])])])])}const ps=k(b,[["render",ts],["__file","markdown.html.vue"]]);export{ps as default};
diff --git a/assets/markdown.html-c9777236.js b/assets/markdown.html-c9777236.js
new file mode 100644
index 00000000..4dfaf5d2
--- /dev/null
+++ b/assets/markdown.html-c9777236.js
@@ -0,0 +1,130 @@
+import{_ as m,W as c,X as r,$ as n,a0 as s,Y as e,Z as a,a2 as k,a3 as h,a4 as g,a1 as i,D as p,a5 as v}from"./framework-46b0e263.js";const b={},f=n("h1",{id:"markdown",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown","aria-hidden":"true"},"#"),s(" Markdown")],-1),_={href:"https://commonmark.org/help/",target:"_blank",rel:"noopener noreferrer"},w=n("h2",{id:"syntax-extensions",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#syntax-extensions","aria-hidden":"true"},"#"),s(" Syntax Extensions")],-1),y={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"},x={href:"https://github.com/markdown-it/markdown-it#syntax-extensions",target:"_blank",rel:"noopener noreferrer"},T=n("p",null,"This section will introduce built-in Markdown syntax extensions of VuePress.",-1),C=n("h3",{id:"embedded",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#embedded","aria-hidden":"true"},"#"),s(" Embedded")],-1),q=n("p",null,"Embedded by markdown-it:",-1),j={href:"https://help.github.com/articles/organizing-information-with-tables/",target:"_blank",rel:"noopener noreferrer"},M={href:"https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text",target:"_blank",rel:"noopener noreferrer"},L=n("h3",{id:"header-anchors",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#header-anchors","aria-hidden":"true"},"#"),s(" Header Anchors")],-1),R=n("p",null,[s("You might have noticed that, a "),n("code",null,"#"),s(" anchor is displayed when you hover the mouse on the headers of each section. By clicking the "),n("code",null,"#"),s(" anchor, you can jump to the section directly.")],-1),V={class:"hint-container tip"},E=n("p",{class:"hint-container-title"},"Tips",-1),H={href:"https://github.com/valeriangalliat/markdown-it-anchor",target:"_blank",rel:"noopener noreferrer"},I=n("h3",{id:"links",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#links","aria-hidden":"true"},"#"),s(" Links")],-1),S={href:"https://spec.commonmark.org/0.29/#link-reference-definitions",target:"_blank",rel:"noopener noreferrer"},O=i(`
Take our documentation source files as an example:
`,7),B=n("br",null,null,-1),P=n("br",null,null,-1),N=n("br",null,null,-1),D=n("br",null,null,-1),G=n("br",null,null,-1),U={href:"https://github.com",target:"_blank",rel:"noopener noreferrer"},Y=n("p",null,[n("strong",null,"Explanation")],-1),A=n("li",null,[s("Internal links will be converted to "),n("code",null,""),s(" for SPA navigation.")],-1),F=n("code",null,".md",-1),W=n("li",null,[s("External links will get "),n("code",null,'target="_blank" rel="noopener noreferrer"'),s(" attrs.")],-1),z=n("p",null,[n("strong",null,"Suggestion")],-1),J=n("p",null,"Try to use relative paths instead of absolute paths for internal links to markdown files.",-1),X=n("ul",null,[n("li",null,"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."),n("li",null,"Relative paths are consistent in different locales, so you don't need to change the locale path when translating your content.")],-1),Z={class:"hint-container tip"},$=n("p",{class:"hint-container-title"},"Tips",-1),K=n("p",null,"This links extension is supported by our built-in plugin.",-1),Q=n("h3",{id:"emoji",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#emoji","aria-hidden":"true"},"#"),s(" Emoji 🎉")],-1),nn=n("p",null,[s("You can add emoji to your Markdown content by typing "),n("code",null,":EMOJICODE:"),s(".")],-1),sn={href:"https://github.com/ikatyang/emoji-cheat-sheet",target:"_blank",rel:"noopener noreferrer"},en=n("p",null,[n("strong",null,"Input")],-1),an=n("div",{class:"language-markdown line-numbers-mode","data-ext":"md"},[n("pre",{class:"language-markdown"},[n("code",null,`VuePress 2 is out :tada: !
+`)]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"})])],-1),tn=n("p",null,[n("strong",null,"Output")],-1),on=n("p",null,"VuePress 2 is out 🎉 !",-1),ln={class:"hint-container tip"},pn=n("p",{class:"hint-container-title"},"Tips",-1),cn={href:"https://github.com/markdown-it/markdown-it-emoji",target:"_blank",rel:"noopener noreferrer"},rn=i(`
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
[[toc]]
+
Output
`,5),dn={class:"table-of-contents"},un=n("p",null,[s("The headers in TOC will link to the corresponding "),n("a",{href:"#header-anchors"},"header anchors"),s(", so TOC won't work well if you disable header anchors.")],-1),mn={class:"hint-container tip"},kn=n("p",{class:"hint-container-title"},"Tips",-1),hn={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc",target:"_blank",rel:"noopener noreferrer"},gn=i(`
You must have noticed that the number of lines is displayed on the left side of code blocks. This is enabled by default and you can disable it in config.
You can add :line-numbers / :no-line-numbers mark in your fenced code blocks to override the value set in config.
Input
\`\`\`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
// line-numbers is enabled by default
+const line2 ="This is line 2";
+const line3 ="This is line 3";
+
// line-numbers is disabled
+const line2 ='This is line 2'
+const line3 ='This is line 3'
+
`,8),wn={class:"hint-container tip"},yn=n("p",{class:"hint-container-title"},"Tips",-1),xn=n("p",null,"This line numbers extension is supported by our built-in plugin.",-1),Tn=n("h4",{id:"wrap-with-v-pre",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#wrap-with-v-pre","aria-hidden":"true"},"#"),s(" Wrap with v-pre")],-1),Cn=n("p",null,[s("As "),n("a",{href:"#template-syntax"},"template syntax is allowed in Markdown"),s(", it would also work in code blocks, too.")],-1),qn={href:"https://vuejs.org/api/built-in-directives.html#v-pre",target:"_blank",rel:"noopener noreferrer"},jn=i(`
You can add :v-pre / :no-v-pre mark in your fenced code blocks to override the value set in config.
Note
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
+<!-- This will be kept as is by default -->
+
+1 + 2 + 3 = {{ 1 + 2 + 3 }}
+\`\`\`
+
+\`\`\`md:no-v-pre
+<!-- This will be compiled by Vue -->
+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
<!-- This will be kept as is -->
+
+1 + 2 + 3 = {{ 1 + 2 + 3 }}
+
<!-- This will be compiled by Vue -->
+1 + 2 + 3 = 6
+
`,7),Mn=i(`
// This won't be compiled correctly because of js syntax highlighting
+const onePlusTwoPlusThree ={{1+2+3}}
+
`,1),Ln={class:"hint-container tip"},Rn=n("p",{class:"hint-container-title"},"Tips",-1),Vn=n("p",null,"This v-pre extension is supported by our built-in plugin.",-1),En=i(`
You can import code blocks from files with following syntax:
<!-- minimal syntax -->
+
+@[code](../foo.js)
+
If you want to partially import the file:
<!-- partial import, from line 1 to line 10 -->
+
+@[code{1-10}](../foo.js)
+
The code language is inferred from the file extension, while it is recommended to specify it explicitly:
<!-- specify the code language -->
+
+@[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 section:
<!-- line highlighting -->
+
+@[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
@[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:
<!-- it will be resolved to 'path/to/src/foo.js' -->
+
+@[code](@src/foo.js)
+
`,15),Hn={class:"hint-container tip"},In=n("p",{class:"hint-container-title"},"Tips",-1),Sn=n("p",null,"This import code extension is supported by our built-in plugin.",-1),On=n("h2",{id:"using-vue-in-markdown",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#using-vue-in-markdown","aria-hidden":"true"},"#"),s(" Using Vue in Markdown")],-1),Bn=n("p",null,"This section will introduce some basic usage of Vue in Markdown.",-1),Pn=n("h3",{id:"template-syntax",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#template-syntax","aria-hidden":"true"},"#"),s(" Template Syntax")],-1),Nn=n("p",null,"As we know:",-1),Dn=n("ul",null,[n("li",null,"HTML is allowed in Markdown."),n("li",null,"Vue template syntax is compatible with HTML.")],-1),Gn={href:"https://vuejs.org/guide/essentials/template-syntax.html",target:"_blank",rel:"noopener noreferrer"},Un=i(`
Input
One plus one equals: {{ 1 + 1 }}
+
+<spanv-for="i in 3"> span: {{ i }} </span>
+
This is default theme built-in `<Badge />` component <Badgetext="demo"/>\n
Output
',5),An=n("code",null,"",-1),Fn={class:"hint-container tip"},Wn=n("p",{class:"hint-container-title"},"Tips",-1),zn=n("h2",{id:"cautions",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#cautions","aria-hidden":"true"},"#"),s(" Cautions")],-1),Jn=n("h3",{id:"non-standard-html-tags",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#non-standard-html-tags","aria-hidden":"true"},"#"),s(" Non-Standard HTML Tags")],-1),Xn=n("p",null,"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:",-1),Zn={href:"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/center",target:"_blank",rel:"noopener noreferrer"},$n={href:"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/font",target:"_blank",rel:"noopener noreferrer"},Kn={href:"https://developer.mozilla.org/en-US/docs/Web/MathML",target:"_blank",rel:"noopener noreferrer"},Qn=n("p",null,"If you want to use those tags anyway, try either of the following workarounds:",-1),ns={href:"https://vuejs.org/api/built-in-directives.html#v-pre",target:"_blank",rel:"noopener noreferrer"},ss={href:"https://vuejs.org/api/application.html#app-config-compileroptions",target:"_blank",rel:"noopener noreferrer"},es=n("code",null,"@bundler-webpack",-1),as=n("code",null,"@bundler-vite",-1);function ts(os,ls){const o=p("ExternalLinkIcon"),t=p("RouterLink"),l=p("router-link"),d=p("Badge");return c(),r("div",null,[f,n("p",null,[s("Make sure you already know Markdown well before reading this section. If not, please learn some "),n("a",_,[s("Markdown tutorials"),e(o)]),s(" first.")]),w,n("p",null,[s("The Markdown content in VuePress will be parsed by "),n("a",y,[s("markdown-it"),e(o)]),s(", which supports "),n("a",x,[s("syntax extensions"),e(o)]),s(" via markdown-it plugins.")]),T,n("p",null,[s("You can also configure those built-in extensions, load more markdown-it plugins and implement your own extensions via "),e(t,{to:"/reference/config.html#markdown"},{default:a(()=>[s("markdown")]),_:1}),s(" option and "),e(t,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:a(()=>[s("extendsMarkdown")]),_:1}),s(" option.")]),C,q,n("ul",null,[n("li",null,[n("a",j,[s("Tables"),e(o)]),s(" (GFM)")]),n("li",null,[n("a",M,[s("Strikethrough"),e(o)]),s(" (GFM)")])]),L,R,n("div",V,[E,n("p",null,[s("This header anchors extension is supported by "),n("a",H,[s("markdown-it-anchor"),e(o)]),s(".")]),n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-anchor"},{default:a(()=>[s("markdown.anchor")]),_:1})])]),I,n("p",null,[s("When using Markdown "),n("a",S,[s("link syntax"),e(o)]),s(", VuePress will implement some conversions for you.")]),O,n("p",null,[e(t,{to:"/"},{default:a(()=>[s("Home")]),_:1}),B,e(t,{to:"/reference/config.html"},{default:a(()=>[s("Config Reference")]),_:1}),P,e(t,{to:"/guide/getting-started.html"},{default:a(()=>[s("Getting Started")]),_:1}),N,e(t,{to:"/guide/"},{default:a(()=>[s("Guide")]),_:1}),D,e(t,{to:"/reference/config.html#links"},{default:a(()=>[s("Config Reference > markdown.links")]),_:1}),G,n("a",U,[s("GitHub"),e(o)])]),Y,n("ul",null,[A,n("li",null,[s("Internal links to "),F,s(" files will be converted to the "),e(t,{to:"/guide/page.html#routing"},{default:a(()=>[s("page route path")]),_:1}),s(", and both absolute path and relative path are supported.")]),W]),z,J,X,n("div",Z,[$,K,n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-links"},{default:a(()=>[s("markdown.links")]),_:1})])]),Q,nn,n("p",null,[s("For a full list of available emoji and codes, check out "),n("a",sn,[s("emoji-cheat-sheet"),e(o)]),s(".")]),en,an,tn,on,n("div",ln,[pn,n("p",null,[s("This emoji extension is supported by "),n("a",cn,[s("markdown-it-emoji"),e(o)]),s(".")]),n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-emoji"},{default:a(()=>[s("markdown.emoji")]),_:1})])]),rn,n("nav",dn,[n("ul",null,[n("li",null,[e(l,{to:"#syntax-extensions"},{default:a(()=>[s("Syntax Extensions")]),_:1}),n("ul",null,[n("li",null,[e(l,{to:"#embedded"},{default:a(()=>[s("Embedded")]),_:1})]),n("li",null,[e(l,{to:"#header-anchors"},{default:a(()=>[s("Header Anchors")]),_:1})]),n("li",null,[e(l,{to:"#links"},{default:a(()=>[s("Links")]),_:1})]),n("li",null,[e(l,{to:"#emoji"},{default:a(()=>[s("Emoji 🎉")]),_:1})]),n("li",null,[e(l,{to:"#table-of-contents"},{default:a(()=>[s("Table of Contents")]),_:1})]),n("li",null,[e(l,{to:"#code-blocks"},{default:a(()=>[s("Code Blocks")]),_:1})]),n("li",null,[e(l,{to:"#import-code-blocks"},{default:a(()=>[s("Import Code Blocks")]),_:1})])])]),n("li",null,[e(l,{to:"#using-vue-in-markdown"},{default:a(()=>[s("Using Vue in Markdown")]),_:1}),n("ul",null,[n("li",null,[e(l,{to:"#template-syntax"},{default:a(()=>[s("Template Syntax")]),_:1})]),n("li",null,[e(l,{to:"#components"},{default:a(()=>[s("Components")]),_:1})])])]),n("li",null,[e(l,{to:"#cautions"},{default:a(()=>[s("Cautions")]),_:1}),n("ul",null,[n("li",null,[e(l,{to:"#non-standard-html-tags"},{default:a(()=>[s("Non-Standard HTML Tags")]),_:1})])])])])]),un,n("div",mn,[kn,n("p",null,[s("This toc extension is supported by "),n("a",hn,[s("@mdit-vue/plugin-toc"),e(o)]),s(".")]),n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-toc"},{default:a(()=>[s("markdown.toc")]),_:1})])]),gn,n("div",vn,[bn,n("p",null,[s("This line highlighting extension is supported by our built-in plugin, which is forked and modified from "),n("a",fn,[s("markdown-it-highlight-lines"),e(o)]),s(".")]),n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-code-highlightlines"},{default:a(()=>[s("markdown.code.highlightLines")]),_:1})])]),_n,n("div",wn,[yn,xn,n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-code-linenumbers"},{default:a(()=>[s("markdown.code.lineNumbers")]),_:1})])]),Tn,Cn,n("p",null,[s("To avoid your code blocks being compiled by Vue, VuePress will add "),n("a",qn,[s("v-pre"),e(o)]),s(" directive to your code blocks by default, which can be disabled in config.")]),jn,k(`
+using :no-v-pre on JS code blocks has potential issue with shiki, so we are
+not actually using :no-v-pre here, just as an example of incorrect usage
+`),Mn,n("div",Ln,[Rn,Vn,n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-code-vpre-block"},{default:a(()=>[s("markdown.code.vPre.block")]),_:1})])]),En,n("div",Hn,[In,Sn,n("p",null,[s("Config reference: "),e(t,{to:"/reference/config.html#markdown-importcode"},{default:a(()=>[s("markdown.importCode")]),_:1})])]),On,Bn,n("p",null,[s("Check out "),e(t,{to:"/advanced/cookbook/markdown-and-vue-sfc.html"},{default:a(()=>[s("Cookbook > Markdown and Vue SFC")]),_:1}),s(" for more details.")]),Pn,Nn,Dn,n("p",null,[s("That means, "),n("a",Gn,[s("Vue template syntax"),e(o)]),s(" is allowed in Markdown.")]),Un,n("p",null,[(c(),r(h,null,g(3,u=>n("span",null," span: "+v(u),1)),64))]),Yn,n("p",null,[s("This is default theme built-in "),An,s(" component "),e(d,{text:"demo"})]),n("div",Fn,[Wn,n("p",null,[s("Check out the "),e(t,{to:"/reference/components.html"},{default:a(()=>[s("Built-in Components")]),_:1}),s(" for a full list of built-in components.")]),n("p",null,[s("Check out the "),e(t,{to:"/reference/default-theme/components.html"},{default:a(()=>[s("Default Theme > Built-in Components")]),_:1}),s(" for a full list of default theme built-in components.")])]),zn,Jn,Xn,n("ul",null,[n("li",null,[s("Deprecated HTML tags such as "),n("a",Zn,[s("
"),e(o)]),s(" and "),n("a",$n,[s(""),e(o)]),s(".")]),n("li",null,[n("a",Kn,[s("MathML tags"),e(o)]),s(", which might be used by some markdown-it LaTeX plugin.")])]),Qn,n("ul",null,[n("li",null,[s("Adding a "),n("a",ns,[s("v-pre"),e(o)]),s(" directive to skip the compilation of the element and its children. Notice that the template syntax would also be invalid.")]),n("li",null,[s("Using "),n("a",ss,[s("compilerOptions.isCustomElement"),e(o)]),s(" to tell Vue template compiler not try to resolve them as components. "),n("ul",null,[n("li",null,[s("For "),es,s(", set "),e(t,{to:"/reference/bundler/webpack.html#vue"},{default:a(()=>[s("vue.compilerOptions")]),_:1})]),n("li",null,[s("For "),as,s(", set "),e(t,{to:"/reference/bundler/vite.html#vuepluginoptions"},{default:a(()=>[s("vuePluginOptions.template.compilerOptions")]),_:1})])])])])])}const ps=m(b,[["render",ts],["__file","markdown.html.vue"]]);export{ps as default};
diff --git a/assets/markdown.html-daca0316.js b/assets/markdown.html-daca0316.js
new file mode 100644
index 00000000..efad1b81
--- /dev/null
+++ b/assets/markdown.html-daca0316.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-0978b044","path":"/guide/markdown.html","title":"Markdown","lang":"en-US","frontmatter":{"icon":"fa6-brands:markdown","description":"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 Ma...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/markdown.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/guide/markdown.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Markdown"}],["meta",{"property":"og:description","content":"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 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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Markdown\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Syntax Extensions","slug":"syntax-extensions","link":"#syntax-extensions","children":[{"level":3,"title":"Embedded","slug":"embedded","link":"#embedded","children":[]},{"level":3,"title":"Header Anchors","slug":"header-anchors","link":"#header-anchors","children":[]},{"level":3,"title":"Links","slug":"links","link":"#links","children":[]},{"level":3,"title":"Emoji 🎉","slug":"emoji","link":"#emoji","children":[]},{"level":3,"title":"Table of Contents","slug":"table-of-contents","link":"#table-of-contents","children":[]},{"level":3,"title":"Code Blocks","slug":"code-blocks","link":"#code-blocks","children":[]},{"level":3,"title":"Import Code Blocks","slug":"import-code-blocks","link":"#import-code-blocks","children":[]}]},{"level":2,"title":"Using Vue in Markdown","slug":"using-vue-in-markdown","link":"#using-vue-in-markdown","children":[{"level":3,"title":"Template Syntax","slug":"template-syntax","link":"#template-syntax","children":[]},{"level":3,"title":"Components","slug":"components","link":"#components","children":[]}]},{"level":2,"title":"Cautions","slug":"cautions","link":"#cautions","children":[{"level":3,"title":"Non-Standard HTML Tags","slug":"non-standard-html-tags","link":"#non-standard-html-tags","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":6.08,"words":1825},"filePathRelative":"guide/markdown.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/markdown.html-f0b871b8.js b/assets/markdown.html-f0b871b8.js
new file mode 100644
index 00000000..48019c88
--- /dev/null
+++ b/assets/markdown.html-f0b871b8.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6a0a3d62","path":"/zh/guide/markdown.html","title":"Markdown","lang":"zh-CN","frontmatter":{"icon":"fa6-brands:markdown","description":"在阅读本章节之前，请确保你已经对 Markdown 有所了解。如果你还不了解 Markdown ，请先学习一些 Markdown 教程 (https://commonmark.org/help/)。 语法扩展 VuePress 会使用 markdown-it (https://github.com/markdown-it/markdown-it) 来解...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/markdown.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/markdown.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Markdown"}],["meta",{"property":"og:description","content":"在阅读本章节之前，请确保你已经对 Markdown 有所了解。如果你还不了解 Markdown ，请先学习一些 Markdown 教程 (https://commonmark.org/help/)。 语法扩展 VuePress 会使用 markdown-it (https://github.com/markdown-it/markdown-it) 来解..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Markdown\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"语法扩展","slug":"语法扩展","link":"#语法扩展","children":[{"level":3,"title":"内置","slug":"内置","link":"#内置","children":[]},{"level":3,"title":"标题锚点","slug":"标题锚点","link":"#标题锚点","children":[]},{"level":3,"title":"链接","slug":"链接","link":"#链接","children":[]},{"level":3,"title":"Emoji 🎉","slug":"emoji","link":"#emoji","children":[]},{"level":3,"title":"目录","slug":"目录","link":"#目录","children":[]},{"level":3,"title":"代码块","slug":"代码块","link":"#代码块","children":[]},{"level":3,"title":"导入代码块","slug":"导入代码块","link":"#导入代码块","children":[]}]},{"level":2,"title":"在 Markdown 中使用 Vue","slug":"在-markdown-中使用-vue","link":"#在-markdown-中使用-vue","children":[{"level":3,"title":"模板语法","slug":"模板语法","link":"#模板语法","children":[]},{"level":3,"title":"组件","slug":"组件","link":"#组件","children":[]}]},{"level":2,"title":"注意事项","slug":"注意事项","link":"#注意事项","children":[{"level":3,"title":"非标准的 HTML 标签","slug":"非标准的-html-标签","link":"#非标准的-html-标签","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":8.43,"words":2530},"filePathRelative":"zh/guide/markdown.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/markdown.html-f26fa0b6.js b/assets/markdown.html-f26fa0b6.js
new file mode 100644
index 00000000..c479605b
--- /dev/null
+++ b/assets/markdown.html-f26fa0b6.js
@@ -0,0 +1,59 @@
+import{_ as p,W as v,X as m,Y as e,$ as n,Z as a,a0 as s,a1 as t,D as i}from"./framework-46b0e263.js";const b={},g=n("h1",{id:"markdown",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown","aria-hidden":"true"},"#"),s(" Markdown")],-1),k=n("h2",{id:"自定义容器",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#自定义容器","aria-hidden":"true"},"#"),s(" 自定义容器")],-1),h=t(`
`,1);function q(N,B){const i=t("NpmBadge"),e=t("ExternalLinkIcon");return l(),c("div",null,[d,a(i,{package:"@vuepress/plugin-medium-zoom"}),n("p",null,[s("将 "),n("a",r,[s("medium-zoom"),a(e)]),s(" 集成到 VuePress 中，为图片提供可缩放的功能。")]),m,n("ul",null,[h,k,n("li",null,[v,n("ul",null,[n("li",null,[n("a",b,[s("medium-zoom > Options"),a(e)])])])])]),_,n("ul",null,[n("li",null,[f,n("p",null,[s("返回该插件使用的 "),g,s(" 实例，便于你直接使用实例上的 "),n("a",z,[s("methods"),a(e)]),s(" 。")]),x,y]),w]),Z])}const O=p(u,[["render",q],["__file","medium-zoom.html.vue"]]);export{O as default};
diff --git a/assets/medium-zoom.html-926244f2.js b/assets/medium-zoom.html-926244f2.js
new file mode 100644
index 00000000..3eac8909
--- /dev/null
+++ b/assets/medium-zoom.html-926244f2.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-2ad6454d","path":"/reference/plugin/medium-zoom.html","title":"medium-zoom","lang":"en-US","frontmatter":{"description":"Integrate medium-zoom (https://github.com/francoischalifour/medium-zoom#readme) into VuePress, which can provide the ability to zoom images. This plugin has been integrated into...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/medium-zoom.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/medium-zoom.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"medium-zoom"}],["meta",{"property":"og:description","content":"Integrate medium-zoom (https://github.com/francoischalifour/medium-zoom#readme) into VuePress, which can provide the ability to zoom images. This plugin has been integrated into..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"medium-zoom\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"selector","slug":"selector","link":"#selector","children":[]},{"level":3,"title":"delay","slug":"delay","link":"#delay","children":[]},{"level":3,"title":"zoomOptions","slug":"zoomoptions","link":"#zoomoptions","children":[]}]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]},{"level":2,"title":"Composition API","slug":"composition-api","link":"#composition-api","children":[{"level":3,"title":"useMediumZoom","slug":"usemediumzoom","link":"#usemediumzoom","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.03,"words":310},"filePathRelative":"reference/plugin/medium-zoom.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/medium-zoom.html-b884d404.js b/assets/medium-zoom.html-b884d404.js
new file mode 100644
index 00000000..5ceda26d
--- /dev/null
+++ b/assets/medium-zoom.html-b884d404.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-32cfa4fe","path":"/zh/reference/plugin/medium-zoom.html","title":"medium-zoom","lang":"zh-CN","frontmatter":{"description":"将 medium-zoom (https://github.com/francoischalifour/medium-zoom#readme) 集成到 VuePress 中，为图片提供可缩放的功能。 该插件已经集成到默认主题中。 使用方法 配置项 selector 类型： string; 默认值： ':not(a) > img'; 详情：; 可缩放的图...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/medium-zoom.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/medium-zoom.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"medium-zoom"}],["meta",{"property":"og:description","content":"将 medium-zoom (https://github.com/francoischalifour/medium-zoom#readme) 集成到 VuePress 中，为图片提供可缩放的功能。 该插件已经集成到默认主题中。 使用方法 配置项 selector 类型： string; 默认值： ':not(a) > img'; 详情：; 可缩放的图..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"medium-zoom\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"selector","slug":"selector","link":"#selector","children":[]},{"level":3,"title":"delay","slug":"delay","link":"#delay","children":[]},{"level":3,"title":"zoomOptions","slug":"zoomoptions","link":"#zoomoptions","children":[]}]},{"level":2,"title":"样式","slug":"样式","link":"#样式","children":[]},{"level":2,"title":"Composition API","slug":"composition-api","link":"#composition-api","children":[{"level":3,"title":"useMediumZoom","slug":"usemediumzoom","link":"#usemediumzoom","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.57,"words":471},"filePathRelative":"zh/reference/plugin/medium-zoom.md","localizedDate":"2023年2月22日","autoDesc":true}`);export{e as data};
diff --git a/assets/medium-zoom.html-bf739c54.js b/assets/medium-zoom.html-bf739c54.js
new file mode 100644
index 00000000..30488b67
--- /dev/null
+++ b/assets/medium-zoom.html-bf739c54.js
@@ -0,0 +1,26 @@
+import{_ as l,W as p,X as c,Y as a,$ as n,a0 as s,a1 as o,D as t}from"./framework-46b0e263.js";const u={},d=n("h1",{id:"medium-zoom",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#medium-zoom","aria-hidden":"true"},"#"),s(" medium-zoom")],-1),r={href:"https://github.com/francoischalifour/medium-zoom#readme",target:"_blank",rel:"noopener noreferrer"},m=o(`
This plugin has been integrated into the default theme.
',5),f=n("p",null,"Details:",-1),_=n("code",null,"Zoom",-1),y={href:"https://github.com/francoischalifour/medium-zoom#methods",target:"_blank",rel:"noopener noreferrer"},z=n("p",null,"This plugin will make images zoomable after navigating to current page. But if you are going to add new images dynamically, you may need this method to make those new images zoomable, too.",-1),x=n("p",null,[s("This plugin adds an extra "),n("code",null,"refresh"),s(" method on the "),n("code",null,"Zoom"),s(" instance, which will call "),n("code",null,"zoom.detach()"),s(" then "),n("code",null,"zoom.attach()"),s(" with the "),n("a",{href:"#selector"},"selector"),s(" as the default parameter. It will help you to refresh the zoomable images for current page.")],-1),w=n("li",null,[n("p",null,"Example:")],-1),D=o(`
import{ nextTick }from"vue";
+import{ useMediumZoom }from"@vuepress/plugin-medium-zoom/client";
+
+exportdefault{
+ setup(){
+ const zoom =useMediumZoom();
+
+ // ... do something to add new images in current page
+
+ // then you may need to call \`refresh\` manually to make those new images zoomable
+ nextTick(()=>{
+ zoom.refresh();
+ });
+ },
+};
+
`,1);function T(Z,B){const i=t("NpmBadge"),e=t("ExternalLinkIcon");return p(),c("div",null,[d,a(i,{package:"@vuepress/plugin-medium-zoom"}),n("p",null,[s("Integrate "),n("a",r,[s("medium-zoom"),a(e)]),s(" into VuePress, which can provide the ability to zoom images.")]),m,n("ul",null,[h,k,n("li",null,[v,n("ul",null,[n("li",null,[n("a",g,[s("medium-zoom > Options"),a(e)])])])])]),b,n("ul",null,[n("li",null,[f,n("p",null,[s("Returns the "),_,s(" instance that used by this plugin, so that you can use the instance "),n("a",y,[s("methods"),a(e)]),s(" directly.")]),z,x]),w]),D])}const N=l(u,[["render",T],["__file","medium-zoom.html.vue"]]);export{N as default};
diff --git a/assets/migration.html-2aa2394a.js b/assets/migration.html-2aa2394a.js
new file mode 100644
index 00000000..ecfe6817
--- /dev/null
+++ b/assets/migration.html-2aa2394a.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-d0112c92","path":"/guide/migration.html","title":"Migrating from v1","lang":"en-US","frontmatter":{"icon":"fa6-solid:code-compare","description":"Plugins and themes of VuePress v1 are not compatible with VuePress v2. You need to update them to corresponding v2 version. Some major changes and enhancements of VuePress v2: V...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/migration.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/guide/migration.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Migrating from v1"}],["meta",{"property":"og:description","content":"Plugins and themes of VuePress v1 are not compatible with VuePress v2. You need to update them to corresponding v2 version. Some major changes and enhancements of VuePress v2: V..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Migrating from v1\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"For Users","slug":"for-users","link":"#for-users","children":[{"level":3,"title":"User Config Change","slug":"user-config-change","link":"#user-config-change","children":[]},{"level":3,"title":"Frontmatter Change","slug":"frontmatter-change","link":"#frontmatter-change","children":[]},{"level":3,"title":"Permalink Patterns Change","slug":"permalink-patterns-change","link":"#permalink-patterns-change","children":[]},{"level":3,"title":"Palette System Change","slug":"palette-system-change","link":"#palette-system-change","children":[]},{"level":3,"title":"Conventional Files Change","slug":"conventional-files-change","link":"#conventional-files-change","children":[]},{"level":3,"title":"Markdown slot Change","slug":"markdown-slot-change","link":"#markdown-slot-change","children":[]},{"level":3,"title":"CLI Change","slug":"cli-change","link":"#cli-change","children":[]},{"level":3,"title":"Default Theme Change","slug":"default-theme-change","link":"#default-theme-change","children":[]},{"level":3,"title":"Official Plugins Change","slug":"official-plugins-change","link":"#official-plugins-change","children":[]},{"level":3,"title":"Community Themes and Plugins","slug":"community-themes-and-plugins","link":"#community-themes-and-plugins","children":[]}]},{"level":2,"title":"For Plugin Authors","slug":"for-plugin-authors","link":"#for-plugin-authors","children":[{"level":3,"title":"Plugin API Change","slug":"plugin-api-change","link":"#plugin-api-change","children":[]}]},{"level":2,"title":"For Theme Authors","slug":"for-theme-authors","link":"#for-theme-authors","children":[{"level":3,"title":"Theme API Change","slug":"theme-api-change","link":"#theme-api-change","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":5.52,"words":1657},"filePathRelative":"guide/migration.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/migration.html-41dd8c51.js b/assets/migration.html-41dd8c51.js
new file mode 100644
index 00000000..bc1d190a
--- /dev/null
+++ b/assets/migration.html-41dd8c51.js
@@ -0,0 +1,72 @@
+import{_ as i,W as d,X as o,$ as n,a0 as e,Y as a,Z as t,a1 as l,D as c}from"./framework-46b0e263.js";const r={},p=l(`
Plugins and themes of VuePress v1 are not compatible with VuePress v2. You need to update them to corresponding v2 version.
Some major changes and enhancements of VuePress v2:
VuePress v2 is now using Vue 3, so make sure your components and other client files are compatible with Vue 3.
VuePress v2 is developed with TypeScript, so it provides better TS support now. It's highly recommended to use TypeScript to develop plugins and themes. VuePress config file also supports TypeScript, and you can use .vuepress/config.ts directly.
VuePress v2 supports both Webpack and Vite as bundler. Now Vite is the default bundler, while you can still choose to use Webpack. You can even use Vite in dev mode to get better development experience, and use Webpack in build mode to get better browser compatibility.
VuePress v2 is now released as pure ESM packages, and CommonJS config files are no longer supported.
Core ideas and processes of VuePress v2 are the same with v1, while v2 API has been re-designed and becomes more normalized. So you might encounter breaking changes when migrating an existing v1 project to v2. This guide is here to help you migrating v1 sites / plugins / themes to v2.
If you are a common user, you need to read the guide for users.
If you are a plugin author, you need to read the guide for plugin authors.
If you are a theme author, you need to read the guide for theme authors.
`,22),u=n("h4",{id:"patterns",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#patterns","aria-hidden":"true"},"#"),e(" patterns")],-1),h=n("p",null,[e("Renamed to "),n("code",null,"pagePatterns")],-1),m=n("h4",{id:"markdown-linenumbers",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-linenumbers","aria-hidden":"true"},"#"),e(" markdown.lineNumbers")],-1),f=n("p",null,[e("Default value is changed from "),n("code",null,"false"),e(" to "),n("code",null,"true"),e(".")],-1),g=n("h4",{id:"markdown-pagesuffix",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-pagesuffix","aria-hidden":"true"},"#"),e(" markdown.pageSuffix")],-1),v=n("p",null,"Removed.",-1),k=n("h4",{id:"markdown-externallinks",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-externallinks","aria-hidden":"true"},"#"),e(" markdown.externalLinks")],-1),b=n("h4",{id:"markdown-toc",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-toc","aria-hidden":"true"},"#"),e(" markdown.toc")],-1),_=n("p",null,"Changed.",-1),x=n("h4",{id:"markdown-plugins",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-plugins","aria-hidden":"true"},"#"),e(" markdown.plugins")],-1),y=n("p",null,"Removed.",-1),w=n("h4",{id:"markdown-extendmarkdown",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-extendmarkdown","aria-hidden":"true"},"#"),e(" markdown.extendMarkdown")],-1),C=n("p",null,"Removed.",-1),P=n("h4",{id:"markdown-extractheaders",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-extractheaders","aria-hidden":"true"},"#"),e(" markdown.extractHeaders")],-1),S=i(`
`,5),X=n("h3",{id:"palette-system-change",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#palette-system-change","aria-hidden":"true"},"#"),e(" Palette System Change")],-1),q=n("p",null,[e("The stylus palette system of VuePress v1 (i.e. "),n("code",null,"styles/palette.styl"),e(" and "),n("code",null,"styles/index.styl"),e(") is no longer provided by VuePress Core.")],-1),M=n("p",null,"Theme authors can use their own way to allow users to customize styles, and not be limited with stylus.",-1),j=n("h3",{id:"conventional-files-change",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#conventional-files-change","aria-hidden":"true"},"#"),e(" Conventional Files Change")],-1),I=n("h4",{id:"vuepress-enhanceapp-js",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vuepress-enhanceapp-js","aria-hidden":"true"},"#"),e(" .vuepress/enhanceApp.js")],-1),D=n("p",null,[e("Renamed to "),n("code",null,".vuepress/client.{js,ts}"),e(", and the usage has been changed, too.")],-1),W=n("h4",{id:"vuepress-components",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vuepress-components","aria-hidden":"true"},"#"),e(" .vuepress/components/")],-1),Y=n("p",null,"Files in this directory will not be registered as Vue components automatically.",-1),R=n("code",null,".vuepress/client.{js,ts}",-1),B=n("h4",{id:"vuepress-theme",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vuepress-theme","aria-hidden":"true"},"#"),e(" .vuepress/theme/")],-1),N=n("p",null,"This directory will not be used as local theme implicitly if it is existed.",-1),U=i('
-c, --cache [cache]: changed to --cache <cache>, which means that the shorthand -c is not for cache option, and the value of cache option is not optional.
The palette system of default theme has migrated to SASS and CSS variables.
',12),G=n("h4",{id:"theme-config",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#theme-config","aria-hidden":"true"},"#"),e(" Theme Config")],-1),E=n("p",null,"Default theme config has been changed a lot. You'd better check the config reference of v2 default theme to migrate it properly.",-1),L=i('
',7),$=n("li",null,"You cannot use other plugins in your plugin anymore, which avoids lots of potential issues caused by plugin nesting. If your plugin depends on other plugins, you could list them in the docs to ask users import them manually. Alternatively, you can provide users with an array of plugins for convenience.",-1),z=n("li",null,[e("Most of the v1 hooks have equivalents in v2. The only exception is "),n("code",null,"extendsCli"),e(", which has been removed.")],-1),H=i('
additionalPages: removed, use app.pages.push(createPage()) in onInitialized hook
clientDynamicModules: removed, use app.writeTemp() in onPrepared hook
enhanceAppFiles: removed, use clientConfigFile hook
globalUIComponents: removed, use clientConfigFile hook
clientRootMixin: removed, use clientConfigFile hook
extendMarkdown: renamed to extendsMarkdown
chainMarkdown: removed
extendPageData: renamed to extendsPage
extendsCli: removed
configureWebpack: removed
chainWebpack: removed
beforeDevServer: removed
afterDevServer: removed
',2),J=n("h2",{id:"for-theme-authors",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#for-theme-authors","aria-hidden":"true"},"#"),e(" For Theme Authors")],-1),O=n("p",null,"Although we do not allow using other plugins in a plugin anymore, you can still use plugins in your theme.",-1),Z=n("p",null,"Some major breaking changes:",-1),K=n("strong",null,"conventional theme directory structure",-1),Q=n("li",null,[e("The file "),n("code",null,"theme/enhanceApp.js"),e(" will not be used as client app enhance file implicitly. You need to specify it explicitly in "),n("code",null,"clientConfigFile"),e(" hook.")],-1),ee=n("code",null,"theme/global-components/",-1),ne=n("code",null,"clientConfigFile",-1),ae=i("
Files in theme/layouts/ directory will not be registered as layout components automatically. You need to specify it explicitly in layouts option in clientConfigFile.
Files in theme/templates/ directory will not be used as dev / ssr template automatically. You need to specify theme explicitly in templateBuild and templateDev option.
Always provide a valid js entry file, and do not use "main": "layouts/Layout.vue" as the theme entry anymore.
",3),se=n("code",null,"themeConfig",-1),te=n("code",null,"themeConfig",-1),ie=n("code",null,"this.$site.themeConfig",-1),oe=n("code",null,"useThemeData",-1),le=n("li",null,[e("For scalability concerns, "),n("code",null,"this.$site.pages"),e(" is not available any more.")],-1),de=n("h3",{id:"theme-api-change",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#theme-api-change","aria-hidden":"true"},"#"),e(" Theme API Change")],-1),re=n("h4",{id:"layouts",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#layouts","aria-hidden":"true"},"#"),e(" layouts")],-1),ce=n("p",null,"Removed.",-1),pe=n("p",null,"Now you need to specify layout component in the client config file of your theme.",-1),ue=n("h4",{id:"extend",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#extend","aria-hidden":"true"},"#"),e(" extend")],-1),he=n("p",null,[e("Renamed to "),n("code",null,"extends"),e(".")],-1),me=n("p",null,[e("You can still inherit a parent theme with "),n("code",null,"extends: parentTheme()"),e(", which will extends the plugins, layouts, etc.")],-1),fe=n("code",null,"@theme",-1),ge=n("code",null,"@parent-theme",-1);function ve(ke,be){const a=r("RouterLink");return l(),d("div",null,[p,n("p",null,[e("You can watch files manually in "),s(a,{to:"/reference/plugin-api.html#onwatched"},{default:t(()=>[e("onWatched")]),_:1}),e(" hook.")]),u,h,m,n("p",null,[e("Moved to "),s(a,{to:"/reference/config.html#markdown-code-linenumbers"},{default:t(()=>[e("markdown.code.lineNumbers")]),_:1}),e(".")]),f,g,v,k,n("p",null,[e("Moved to "),s(a,{to:"/reference/config.html#markdown-links"},{default:t(()=>[e("markdown.links.externalAttrs")]),_:1}),e(".")]),b,_,n("p",null,[e("See "),s(a,{to:"/reference/config.html#markdown-toc"},{default:t(()=>[e("Config > markdown.toc")]),_:1})]),x,y,n("p",null,[e("Use markdown-it plugins in "),s(a,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:t(()=>[e("extendsMarkdown")]),_:1}),e(" hook.")]),w,C,n("p",null,[e("Use "),s(a,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:t(()=>[e("extendsMarkdown")]),_:1}),e(" hook.")]),P,n("p",null,[e("Moved to "),s(a,{to:"/reference/config.html#markdown-headers"},{default:t(()=>[e("markdown.headers")]),_:1}),e(".")]),S,n("p",null,[e("Please refer to "),s(a,{to:"/guide/bundler.html"},{default:t(()=>[e("Guide > Bundler")]),_:1}),e(".")]),T,A,V,n("p",null,[e("Use "),s(a,{to:"/reference/frontmatter.html#head"},{default:t(()=>[e("head")]),_:1}),e(" instead. For example:")]),F,n("p",null,[e("See "),s(a,{to:"/reference/frontmatter.html#permalinkpattern"},{default:t(()=>[e("Frontmatter > permalinkPattern")]),_:1}),e(".")]),X,q,n("p",null,[e("The palette system is extracted to "),s(a,{to:"/reference/plugin/palette.html"},{default:t(()=>[e("@vuepress/plugin-palette")]),_:1}),e(".")]),M,n("p",null,[e("If you are using default theme, the palette system is still available but migrated to SASS, while most variables have been migrated to CSS variables. See "),s(a,{to:"/reference/default-theme/styles.html"},{default:t(()=>[e("Default Theme > Styles")]),_:1}),e(".")]),j,I,D,n("p",null,[e("See "),s(a,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:t(()=>[e("Advanced > Cookbook > Usage of Client Config")]),_:1}),e(".")]),W,Y,n("p",null,[e("You need to use "),s(a,{to:"/reference/plugin/register-components.html"},{default:t(()=>[e("@vuepress/plugin-register-components")]),_:1}),e(", or register your components manually in "),R,e(".")]),B,N,n("p",null,[e("You need to import and set your local theme via "),s(a,{to:"/reference/config.html#theme"},{default:t(()=>[e("theme")]),_:1}),e(" option.")]),U,n("p",null,[e("See "),s(a,{to:"/reference/default-theme/styles.html"},{default:t(()=>[e("Default Theme > Styles")]),_:1}),e(".")]),G,E,n("p",null,[e("See "),s(a,{to:"/reference/default-theme/config.html"},{default:t(()=>[e("Default Theme > Config")]),_:1}),e(".")]),L,n("ul",null,[$,z,n("li",null,[e("Webpack related hooks are removed, because VuePress Core has decoupled with webpack. You can try to use "),s(a,{to:"/reference/plugin-api.html#extendsbundleroptions"},{default:t(()=>[e("extendsBundlerOptions")]),_:1}),e(" hook for similar purpose, and make sure to work with all bundlers.")])]),n("p",null,[e("For more detailed guide about how to write a plugin in v2, see "),s(a,{to:"/advanced/plugin.html"},{default:t(()=>[e("Advanced > Writing a Plugin")]),_:1}),e(".")]),H,n("p",null,[e("See "),s(a,{to:"/reference/plugin-api.html"},{default:t(()=>[e("Plugin API")]),_:1}),e(".")]),J,O,Z,n("ul",null,[n("li",null,[e("There is no "),K,e(" anymore. "),n("ul",null,[Q,n("li",null,[e("Files in "),ee,e(" directory will not be registered as Vue components automatically. You need to use "),s(a,{to:"/reference/plugin/register-components.html"},{default:t(()=>[e("@vuepress/plugin-register-components")]),_:1}),e(", or register components manually in "),ne,e(".")]),ae])]),n("li",null,[se,e(" is removed from user config and site data. To access the "),te,e(" as you would via "),ie,e(" in v1, we now recommend using the "),s(a,{to:"/reference/plugin/theme-data.html"},{default:t(()=>[e("@vuepress/plugin-theme-data")]),_:1}),e(" plugin and its "),oe,e(" composition API.")]),n("li",null,[e("Stylus is no longer the default CSS pre-processor, and the stylus palette system is not embedded. If you still want to use similar palette system as v1, "),s(a,{to:"/reference/plugin/palette.html"},{default:t(()=>[e("@vuepress/plugin-palette")]),_:1}),e(" may help.")]),n("li",null,[e("Markdown code blocks syntax highlighting by Prism.js is not embedded by default. You can use either "),s(a,{to:"/reference/plugin/prismjs.html"},{default:t(()=>[e("@vuepress/plugin-prismjs")]),_:1}),e(" or "),s(a,{to:"/reference/plugin/shiki.html"},{default:t(()=>[e("@vuepress/plugin-shiki")]),_:1}),e(", or implement syntax highlighting in your own way.")]),le]),n("p",null,[e("For more detailed guide about how to write a theme in v2, see "),s(a,{to:"/advanced/theme.html"},{default:t(()=>[e("Advanced > Writing a Theme")]),_:1}),e(".")]),de,re,ce,pe,n("p",null,[e("See "),s(a,{to:"/advanced/theme.html"},{default:t(()=>[e("Advanced > Writing a theme")]),_:1}),e(".")]),ue,he,me,n("p",null,[e("You can refer to "),s(a,{to:"/reference/default-theme/extending.html"},{default:t(()=>[e("Default Theme > Extending")]),_:1}),e(" for how to extend default theme.")]),n("p",null,[e("The "),fe,e(" and "),ge,e(" aliases are removed by default, but you can still make a extendable theme with similar approach, see "),s(a,{to:"/advanced/cookbook/making-a-theme-extendable.html"},{default:t(()=>[e("Advanced > Cookbook > Making a Theme Extendable")]),_:1}),e(".")])])}const xe=o(c,[["render",ve],["__file","migration.html.vue"]]);export{xe as default};
diff --git a/assets/node-api.html-18ff42ee.js b/assets/node-api.html-18ff42ee.js
new file mode 100644
index 00000000..0738a450
--- /dev/null
+++ b/assets/node-api.html-18ff42ee.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4986678d","path":"/reference/node-api.html","title":"Node API","lang":"en-US","frontmatter":{"icon":"fa6-brands:node-js","description":"Node API is provided by @vuepress/core (https://www.npmjs.com/package/@vuepress/core) package. It is a dependency of the vuepress (https://www.npmjs.com/package/vuepress) packag...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/node-api.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/node-api.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Node API"}],["meta",{"property":"og:description","content":"Node API is provided by @vuepress/core (https://www.npmjs.com/package/@vuepress/core) package. It is a dependency of the vuepress (https://www.npmjs.com/package/vuepress) packag..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Node API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"App","slug":"app","link":"#app","children":[{"level":3,"title":"createBuildApp","slug":"createbuildapp","link":"#createbuildapp","children":[]},{"level":3,"title":"createDevApp","slug":"createdevapp","link":"#createdevapp","children":[]}]},{"level":2,"title":"App Properties","slug":"app-properties","link":"#app-properties","children":[{"level":3,"title":"options","slug":"options","link":"#options","children":[]},{"level":3,"title":"siteData","slug":"sitedata","link":"#sitedata","children":[]},{"level":3,"title":"version","slug":"version","link":"#version","children":[]},{"level":3,"title":"env.isBuild","slug":"env-isbuild","link":"#env-isbuild","children":[]},{"level":3,"title":"env.isDev","slug":"env-isdev","link":"#env-isdev","children":[]},{"level":3,"title":"env.isDebug","slug":"env-isdebug","link":"#env-isdebug","children":[]},{"level":3,"title":"markdown","slug":"markdown","link":"#markdown","children":[]},{"level":3,"title":"pages","slug":"pages","link":"#pages","children":[]}]},{"level":2,"title":"App Methods","slug":"app-methods","link":"#app-methods","children":[{"level":3,"title":"dir","slug":"dir","link":"#dir","children":[]},{"level":3,"title":"writeTemp","slug":"writetemp","link":"#writetemp","children":[]},{"level":3,"title":"init","slug":"init","link":"#init","children":[]},{"level":3,"title":"prepare","slug":"prepare","link":"#prepare","children":[]},{"level":3,"title":"build","slug":"build","link":"#build","children":[]},{"level":3,"title":"dev","slug":"dev","link":"#dev","children":[]}]},{"level":2,"title":"Page","slug":"page","link":"#page","children":[{"level":3,"title":"createPage","slug":"createpage","link":"#createpage","children":[]}]},{"level":2,"title":"Page Properties","slug":"page-properties","link":"#page-properties","children":[{"level":3,"title":"key","slug":"key","link":"#key","children":[]},{"level":3,"title":"path","slug":"path","link":"#path","children":[]},{"level":3,"title":"title","slug":"title","link":"#title","children":[]},{"level":3,"title":"lang","slug":"lang","link":"#lang","children":[]},{"level":3,"title":"frontmatter","slug":"frontmatter","link":"#frontmatter","children":[]},{"level":3,"title":"headers","slug":"headers","link":"#headers","children":[]},{"level":3,"title":"data","slug":"data","link":"#data","children":[]},{"level":3,"title":"content","slug":"content","link":"#content","children":[]},{"level":3,"title":"contentRendered","slug":"contentrendered","link":"#contentrendered","children":[]},{"level":3,"title":"date","slug":"date","link":"#date","children":[]},{"level":3,"title":"deps","slug":"deps","link":"#deps","children":[]},{"level":3,"title":"links","slug":"links","link":"#links","children":[]},{"level":3,"title":"pathInferred","slug":"pathinferred","link":"#pathinferred","children":[]},{"level":3,"title":"pathLocale","slug":"pathlocale","link":"#pathlocale","children":[]},{"level":3,"title":"permalink","slug":"permalink","link":"#permalink","children":[]},{"level":3,"title":"routeMeta","slug":"routemeta","link":"#routemeta","children":[]},{"level":3,"title":"sfcBlocks","slug":"sfcblocks","link":"#sfcblocks","children":[]},{"level":3,"title":"slug","slug":"slug","link":"#slug","children":[]},{"level":3,"title":"filePath","slug":"filepath","link":"#filepath","children":[]},{"level":3,"title":"filePathRelative","slug":"filepathrelative","link":"#filepathrelative","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":5.11,"words":1532},"filePathRelative":"reference/node-api.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/node-api.html-3f616fc7.js b/assets/node-api.html-3f616fc7.js
new file mode 100644
index 00000000..c34d6c43
--- /dev/null
+++ b/assets/node-api.html-3f616fc7.js
@@ -0,0 +1,104 @@
+import{_ as c,W as u,X as d,Y as s,$ as n,a0 as a,Z as t,a1 as l,D as i}from"./framework-46b0e263.js";const r={},h=n("h1",{id:"node-api",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#node-api","aria-hidden":"true"},"#"),a(" Node API")],-1),k={href:"https://www.npmjs.com/package/@vuepress/core",target:"_blank",rel:"noopener noreferrer"},v={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},m=l(`
`,3),F=n("li",null,[n("p",null,"Details:"),n("p",null,"Generate static site files."),n("p",null,[e("This method is only available in "),n("code",null,"BuildApp"),e(".")])],-1),N=n("p",null,"Also see:",-1),q=n("li",null,[n("a",{href:"#createbuildapp"},"Node API > App > createBuildApp")],-1),V=l(`
`,3),H=n("li",null,[n("p",null,"Details:"),n("p",null,"Start dev server."),n("p",null,[e("This method is only available in "),n("code",null,"DevApp"),e(".")])],-1),z=n("p",null,"Also see:",-1),L=n("li",null,[n("a",{href:"#createdevapp"},"Node API > App > createDevApp")],-1),j=l(`
`,8),G=n("li",null,[n("a",{href:"#pages"},"Node API > App Properties > pages")],-1),O=n("h2",{id:"page-properties",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#page-properties","aria-hidden":"true"},"#"),e(" Page Properties")],-1),W=n("h3",{id:"key",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#key","aria-hidden":"true"},"#"),e(" key")],-1),U=n("li",null,[n("p",null,[e("Type: "),n("code",null,"string")])],-1),$=n("p",null,"Details:",-1),X=n("p",null,"Identifier of the page.",-1),Y={href:"https://router.vuejs.org/api/#name-2",target:"_blank",rel:"noopener noreferrer"},Z=n("p",null,"Also see:",-1),J=n("h3",{id:"path",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#path","aria-hidden":"true"},"#"),e(" path")],-1),K=n("li",null,[n("p",null,[e("Type: "),n("code",null,"string")])],-1),Q=n("li",null,[n("p",null,"Details:"),n("p",null,"Route path of the page.")],-1),nn=n("p",null,"Also see:",-1),en=n("li",null,[n("a",{href:"#pathinferred"},"Node API > Page Properties > pathInferred")],-1),an=n("h3",{id:"title",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#title","aria-hidden":"true"},"#"),e(" title")],-1),sn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"string")])],-1),tn=n("li",null,[n("p",null,"Details:"),n("p",null,"Title of the page.")],-1),ln=n("p",null,"Also see:",-1),on=n("h3",{id:"lang",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#lang","aria-hidden":"true"},"#"),e(" lang")],-1),pn=l("
Type: string
Details:
Language of the page.
Example:
'en-US'
'zh-CN'
",3),cn=n("p",null,"Also see:",-1),rn=n("h3",{id:"frontmatter",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),e(" frontmatter")],-1),dn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"PageFrontmatter")])],-1),un=n("li",null,[n("p",null,"Details:"),n("p",null,"Frontmatter of the page.")],-1),hn=n("p",null,"Also see:",-1),kn=l(`
`,3),gn=n("li",null,[n("p",null,"Details:"),n("p",null,"Data of the page."),n("p",null,"Page data would be available in client side.")],-1),bn=n("p",null,"Also see:",-1),_n=l('
",3),wn=n("p",null,"Also see:",-1),xn=n("h3",{id:"deps",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#deps","aria-hidden":"true"},"#"),e(" deps")],-1),An=n("li",null,[n("p",null,[e("Type: "),n("code",null,"string[]")])],-1),Pn=n("li",null,[n("p",null,"Details:"),n("p",null,"Dependencies of the page."),n("p",null,[e("For example, if users import code snippet in the page, the absolute file path of the imported file would be added to "),n("code",null,"deps"),e(".")])],-1),Dn=n("p",null,"Also see:",-1),Tn=l(`
Route path of the page that inferred from file path.
By default, the route path is inferred from the relative file path of the Markdown source file. However, users may explicitly set the route path, e.g. permalink, which would be used as the final route path of the page. So we keep the inferred path as a page property in case you may need it.
It would be null if the page does not come from a Markdown source file.
Example:
'/'
'/foo.html'
',3),Cn=n("p",null,"Also see:",-1),En=n("li",null,[n("a",{href:"#path"},"Node API > Page Properties > path")],-1),Mn=n("h3",{id:"pathlocale",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#pathlocale","aria-hidden":"true"},"#"),e(" pathLocale")],-1),Sn=l("
Type: string
Details:
Locale prefix of the page route path.
It is inferred from the relative file path of the Markdown source file and the key of locales option in user config.
Example:
'/'
'/en/'
'/zh/'
",3),Bn=n("p",null,"Also see:",-1),Rn=n("h3",{id:"permalink",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#permalink","aria-hidden":"true"},"#"),e(" permalink")],-1),Fn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"string | null")])],-1),Nn=n("li",null,[n("p",null,"Details:"),n("p",null,"Permalink of the page.")],-1),qn=n("p",null,"Also see:",-1),Vn=n("h3",{id:"routemeta",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#routemeta","aria-hidden":"true"},"#"),e(" routeMeta")],-1),Hn=n("li",null,[n("p",null,[e("Type: "),n("code",null,"Record")])],-1),zn=n("li",null,[n("p",null,"Details:"),n("p",null,"Custom data to be attached to the route record of vue-router.")],-1),Ln=n("p",null,"Also see:",-1),jn={href:"https://router.vuejs.org/api/#meta",target:"_blank",rel:"noopener noreferrer"},Gn=l('
What's the difference between route meta and page data?
Both route meta and page data is available in client side. However, route meta is attached to the route record, so the route meta of all pages would be loaded at once when users enter your site. In the contrast, page data is saved in separated files, which would be loaded only when users enter the corresponding page.
Therefore, it's not recommended to store large amounts of info into route meta, otherwise the initial loading speed will be affected a lot when your site has a large number of pages.
',2),On=n("li",null,[n("p",null,[e("Type: "),n("code",null,"MarkdownSfcBlocks")])],-1),Wn=n("li",null,[n("p",null,"Details:"),n("p",null,"Extracted vue SFC blocks of the page.")],-1),Un=n("p",null,"Also see:",-1),$n=l('
Relative path of the Markdown source file of the page.
It would be null if the page does not come from a Markdown source file.
',6);function Xn(Yn,Zn){const p=o("NpmBadge"),i=o("ExternalLinkIcon"),s=o("RouterLink");return r(),d("div",null,[h,a(p,{package:"@vuepress/core"}),n("p",null,[e("Node API is provided by "),n("a",k,[e("@vuepress/core"),a(i)]),e(" package. It is a dependency of the "),n("a",v,[e("vuepress"),a(i)]),e(" package, and you can also install it separately:")]),m,n("p",null,[e("The app instance is available in all hooks of "),a(s,{to:"/reference/plugin-api.html"},{default:t(()=>[e("Plugin API")]),_:1}),e(".")]),f,n("ul",null,[g,n("li",null,[b,n("p",null,[e("Site data that set by user, including all the "),a(s,{to:"/reference/config.html#site-config"},{default:t(()=>[e("site config")]),_:1}),e(", which will be used in client side.")])])]),_,n("ul",null,[y,n("li",null,[w,n("p",null,[e("The "),n("a",x,[e("markdown-it"),a(i)]),e(" instance used for parsing markdown content.")]),n("p",null,[e("It is only available in and after "),a(s,{to:"/reference/plugin-api.html#oninitialized"},{default:t(()=>[e("onInitialized")]),_:1}),e(" hook.")])])]),A,n("ul",null,[P,n("li",null,[D,T,n("p",null,[e("It is only available in and after "),a(s,{to:"/reference/plugin-api.html#oninitialized"},{default:t(()=>[e("onInitialized")]),_:1}),e(" hook.")])])]),I,n("ul",null,[C,n("li",null,[E,n("ul",null,[n("li",null,[a(s,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:t(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),M,n("ul",null,[S,n("li",null,[B,n("ul",null,[n("li",null,[a(s,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:t(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),R,n("ul",null,[F,n("li",null,[N,n("ul",null,[q,n("li",null,[a(s,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:t(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),V,n("ul",null,[H,n("li",null,[z,n("ul",null,[L,n("li",null,[a(s,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:t(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),j,n("ul",null,[n("li",null,[e("Also see: "),n("ul",null,[G,n("li",null,[a(s,{to:"/advanced/cookbook/adding-extra-pages.html"},{default:t(()=>[e("Cookbook > Adding Extra Pages")]),_:1})])])])]),O,W,n("ul",null,[U,n("li",null,[$,X,n("p",null,[e("The page key would be used as the "),n("a",Y,[e("name"),a(i)]),e(" of the page route.")])]),n("li",null,[Z,n("ul",null,[n("li",null,[a(s,{to:"/reference/components.html#content"},{default:t(()=>[e("Built-in Components > Content")]),_:1})])])])]),J,n("ul",null,[K,Q,n("li",null,[nn,n("ul",null,[n("li",null,[a(s,{to:"/guide/page.html#routing"},{default:t(()=>[e("Guide > Page > Routing")]),_:1})]),en])])]),an,n("ul",null,[sn,tn,n("li",null,[ln,n("ul",null,[n("li",null,[a(s,{to:"/reference/frontmatter.html#title"},{default:t(()=>[e("Frontmatter > title")]),_:1})])])])]),on,n("ul",null,[pn,n("li",null,[cn,n("ul",null,[n("li",null,[a(s,{to:"/reference/frontmatter.html#title"},{default:t(()=>[e("Frontmatter > lang")]),_:1})])])])]),rn,n("ul",null,[dn,un,n("li",null,[hn,n("ul",null,[n("li",null,[a(s,{to:"/reference/frontmatter.html"},{default:t(()=>[e("Frontmatter")]),_:1})])])])]),kn,n("ul",null,[vn,n("li",null,[mn,n("ul",null,[n("li",null,[a(s,{to:"/reference/config.html#markdown-headers"},{default:t(()=>[e("Config > markdown.headers")]),_:1})])])])]),fn,n("ul",null,[gn,n("li",null,[bn,n("ul",null,[n("li",null,[a(s,{to:"/reference/client-api.html#usepagedata"},{default:t(()=>[e("Client API > usePageData")]),_:1})]),n("li",null,[a(s,{to:"/reference/plugin-api.html#extendspage"},{default:t(()=>[e("Plugin API > extendsPage")]),_:1})])])])]),_n,n("ul",null,[yn,n("li",null,[wn,n("ul",null,[n("li",null,[a(s,{to:"/reference/frontmatter.html#date"},{default:t(()=>[e("Frontmatter > date")]),_:1})])])])]),xn,n("ul",null,[An,Pn,n("li",null,[Dn,n("ul",null,[n("li",null,[a(s,{to:"/reference/config.html#markdown-importcode"},{default:t(()=>[e("Config > markdown.importCode")]),_:1})])])])]),Tn,n("ul",null,[In,n("li",null,[Cn,n("ul",null,[n("li",null,[a(s,{to:"/guide/page.html#routing"},{default:t(()=>[e("Guide > Page > Routing")]),_:1})]),En])])]),Mn,n("ul",null,[Sn,n("li",null,[Bn,n("ul",null,[n("li",null,[a(s,{to:"/reference/config.html#locales"},{default:t(()=>[e("Config > locales")]),_:1})])])])]),Rn,n("ul",null,[Fn,Nn,n("li",null,[qn,n("ul",null,[n("li",null,[a(s,{to:"/reference/frontmatter.html#permalink"},{default:t(()=>[e("Frontmatter > permalink")]),_:1})]),n("li",null,[a(s,{to:"/reference/frontmatter.html#permalinkpattern"},{default:t(()=>[e("Frontmatter > permalinkPattern")]),_:1})])])])]),Vn,n("ul",null,[Hn,zn,n("li",null,[Ln,n("ul",null,[n("li",null,[a(s,{to:"/reference/frontmatter.html#routemeta"},{default:t(()=>[e("Frontmatter > routeMeta")]),_:1})]),n("li",null,[n("a",jn,[e("vue-router > API Reference > RouteRecordRaw > meta"),a(i)])])])])]),Gn,n("ul",null,[On,Wn,n("li",null,[Un,n("ul",null,[n("li",null,[a(s,{to:"/reference/config.html#markdown-sfc"},{default:t(()=>[e("Config > markdown.sfc")]),_:1})])])])]),$n])}const Kn=c(u,[["render",Xn],["__file","node-api.html.vue"]]);export{Kn as default};
diff --git a/assets/nprogress.html-1022e6a7.js b/assets/nprogress.html-1022e6a7.js
new file mode 100644
index 00000000..1b7d1388
--- /dev/null
+++ b/assets/nprogress.html-1022e6a7.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-46d4f19d","path":"/reference/plugin/nprogress.html","title":"nprogress","lang":"en-US","frontmatter":{"title":"nprogress","description":"Integrate nprogress (https://github.com/rstacruz/nprogress) into VuePress, which can provide a progress bar when navigating to another page. This plugin has been integrated into...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/nprogress.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/nprogress.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"nprogress"}],["meta",{"property":"og:description","content":"Integrate nprogress (https://github.com/rstacruz/nprogress) into VuePress, which can provide a progress bar when navigating to another page. This plugin has been integrated into..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"nprogress\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.39,"words":118},"filePathRelative":"reference/plugin/nprogress.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/nprogress.html-64571246.js b/assets/nprogress.html-64571246.js
new file mode 100644
index 00000000..6aa814c0
--- /dev/null
+++ b/assets/nprogress.html-64571246.js
@@ -0,0 +1,7 @@
+import{_ as i,W as p,X as c,a2 as n,Y as a,$ as s,a0 as e,a1 as l,D as t}from"./framework-46b0e263.js";const d={},u=s("h1",{id:"nprogress-plugin",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#nprogress-plugin","aria-hidden":"true"},"#"),e(" nprogress Plugin")],-1),g={href:"https://github.com/rstacruz/nprogress",target:"_blank",rel:"noopener noreferrer"},h=l(`
This plugin has been integrated into the default theme.
You can customize the style of the progress bar via CSS variables:
File not found
`,7);function m(v,k){const r=t("NpmBadge"),o=t("ExternalLinkIcon");return p(),c("div",null,[n(' `# nprogress` will be rendered as `
`, and the id will conflict with the nprogress bar (stupid) '),n(" so we add a 'plugin' suffix in the h1 title, and use title frontmatter to set the page title "),u,a(r,{package:"@vuepress/plugin-nprogress"}),s("p",null,[e("Integrate "),s("a",g,[e("nprogress"),a(o)]),e(" into VuePress, which can provide a progress bar when navigating to another page.")]),h])}const f=i(d,[["render",m],["__file","nprogress.html.vue"]]);export{f as default};
diff --git a/assets/nprogress.html-aaaab1e3.js b/assets/nprogress.html-aaaab1e3.js
new file mode 100644
index 00000000..a3d63c8a
--- /dev/null
+++ b/assets/nprogress.html-aaaab1e3.js
@@ -0,0 +1,7 @@
+import{_ as p,W as c,X as i,a2 as e,Y as a,$ as n,a0 as s,a1 as l,D as t}from"./framework-46b0e263.js";const d={},u=n("h1",{id:"nprogress-插件",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#nprogress-插件","aria-hidden":"true"},"#"),s(" nprogress 插件")],-1),g={href:"https://github.com/rstacruz/nprogress",target:"_blank",rel:"noopener noreferrer"},h=l(`
`,6),m=t("code",null,"docs",-1),p=t("code",null,"vuepress dev docs",-1),f=s("
Relative Path
Route Path
/README.md
/
/index.md
/
/contributing.md
/contributing.html
/guide/README.md
/guide/
/guide/getting-started.md
/guide/getting-started.html
",1),_={class:"hint-container tip"},g=t("p",{class:"hint-container-title"},"Tips",-1),k=t("p",null,[e("By default, both "),t("code",null,"README.md"),e(" and "),t("code",null,"index.md"),e(" would be converted to "),t("code",null,"index.html"),e(" and generate a slash-ending route path. However, it might cause conflicts if you want to keep both of the two files.")],-1),v=t("code",null,"['**/*.md', '!**/README.md', '!.vuepress', '!node_modules']",-1),b=t("code",null,"README.md",-1),w=t("h2",{id:"frontmatter",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),e(" Frontmatter")],-1),y={href:"https://yaml.org/",target:"_blank",rel:"noopener noreferrer"},x=s(`
---
+lang: en-US
+title: Title of this page
+description: Description of this page
+---
+
`,1),E=t("code",null,"lang",-1),M=t("code",null,"title",-1),R=t("code",null,"description",-1),V=t("p",null,"Also, VuePress has built-in support for some frontmatter fields, and your theme may have its own special frontmatter, too.",-1),A={class:"hint-container tip"},D=t("p",{class:"hint-container-title"},"Tips",-1),T=t("h2",{id:"content",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#content","aria-hidden":"true"},"#"),e(" Content")],-1),P=t("p",null,[e("The main content of your page is written in Markdown. VuePress will firstly transform your Markdown to HTML code, then treat the HTML code as "),t("code",null,""),e(" of Vue SFC.")],-1),C={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"};function L(B,F){const o=i("RouterLink"),d=i("ExternalLinkIcon");return l(),c("div",null,[h,t("p",null,[e("Take the "),m,e(" directory as your "),n(o,{to:"/reference/cli.html"},{default:a(()=>[e("sourceDir")]),_:1}),e(", e.g. you are running "),p,e(" command. Then the route paths of your markdown files would be:")]),f,t("div",_,[g,k,t("p",null,[e("In such case, you can set the "),n(o,{to:"/reference/config.html#pagepatterns"},{default:a(()=>[e("pagePatterns")]),_:1}),e(" to avoid one of them being processed by VuePress, e.g. use "),v,e(" to exclude all "),b,e(" files.")])]),w,t("p",null,[e("A markdown file could contain a "),t("a",y,[e("YAML"),n(d)]),e(" frontmatter. The frontmatter must be at the top of the Markdown file and must be wrapped with a couple of triple-dashed lines. Here is a basic example:")]),x,t("p",null,[e("You must have noticed that those fields are similar with the "),n(o,{to:"/guide/configuration.html#site-config"},{default:a(()=>[e("Site Config")]),_:1}),e(" in the "),n(o,{to:"/guide/configuration.html#config-file"},{default:a(()=>[e("Config File")]),_:1}),e(". You can override "),E,e(", "),M,e(", "),R,e(", etc., of current page via frontmatter. So you can take frontmatter as page scope config.")]),V,t("div",A,[D,t("p",null,[e("Check out the "),n(o,{to:"/reference/frontmatter.html"},{default:a(()=>[e("Frontmatter Reference")]),_:1}),e(" for a full list of VuePress built-in frontmatter.")]),t("p",null,[e("Check out the "),n(o,{to:"/reference/default-theme/frontmatter.html"},{default:a(()=>[e("Default Theme > Frontmatter Reference")]),_:1}),e(" for the frontmatter of default theme.")])]),T,P,t("p",null,[e("With the power of "),t("a",C,[e("markdown-it"),n(d)]),e(" and Vue template syntax, the basic Markdown can be extended a lot. Next, check out the "),n(o,{to:"/guide/markdown.html"},{default:a(()=>[e("Markdown")]),_:1}),e(" guide for all the extensions of Markdown in VuePress.")])])}const S=r(u,[["render",L],["__file","page.html.vue"]]);export{S as default};
diff --git a/assets/page.html-c8245648.js b/assets/page.html-c8245648.js
new file mode 100644
index 00000000..e98142fd
--- /dev/null
+++ b/assets/page.html-c8245648.js
@@ -0,0 +1,12 @@
+import{_ as i,W as l,X as c,$ as t,a0 as e,Y as n,Z as a,a1 as o,D as r}from"./framework-46b0e263.js";const u={},h=o(`
This plugin will provide a @vuepress/plugin-palette/palette (palette file) and a @vuepress/plugin-palette/style (style file) to be imported in your theme styles.
Import the plugin's palette file where your theme needs to use the corresponding variables, such as in the Layout.vue file:
<template>
+ <h1class="palette-title">Hello, Palette!</h1>
+</template>
+
+<stylelang="scss">
+/* import variables from the plugin's palette file */
+@import"@vuepress/plugin-palette/palette";
+
+/* set default value for variables */
+$color: red !default;
+
+/* use variables in your styles */
+.palette-title{
+ color: $color;
+}
+</style>
+
Then users can customize variables in .vuepress/styles/palette.scss:
This option is used for generating tempPaletteFile and tempStyleFile, and you don't need to change this option in most cases.
`,27);function g(y,b){const i=t("NpmBadge"),n=t("ExternalLinkIcon");return o(),c("div",null,[d,a(i,{package:"@vuepress/plugin-palette"}),u,s("p",null,[e("The palette file is used for defining style variables, so it's likely to be imported at the beginning of your theme styles. For example, users can define "),s("a",h,[e("CSS variables"),a(n)]),e(", "),s("a",v,[e("SASS variables"),a(n)]),e(", "),s("a",m,[e("LESS variables"),a(n)]),e(" or "),s("a",f,[e("Stylus variables"),a(n)]),e(" in the palette, and then you can use those variables in your theme styles.")]),k])}const _=p(r,[["render",g],["__file","palette.html.vue"]]);export{_ as default};
diff --git a/assets/palette.html-5cc582af.js b/assets/palette.html-5cc582af.js
new file mode 100644
index 00000000..77b14b59
--- /dev/null
+++ b/assets/palette.html-5cc582af.js
@@ -0,0 +1,39 @@
+import{_ as i,W as c,X as o,Y as a,$ as e,a0 as s,a1 as l,D as t}from"./framework-46b0e263.js";const r={},d=e("h1",{id:"palette",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#palette","aria-hidden":"true"},"#"),s(" palette")],-1),u=l(`
`,27);function b(f,y){const p=t("NpmBadge"),n=t("ExternalLinkIcon");return c(),o("div",null,[d,a(p,{package:"@vuepress/plugin-palette"}),u,e("p",null,[s("调色板文件用于定义样式变量，因此它一般会在你主题样式的开头引入。举例来说，用户可以在调色板中定义 "),e("a",v,[s("CSS 变量"),a(n)]),s(" 、 "),e("a",k,[s("SASS 变量"),a(n)]),s(" 、 "),e("a",h,[s("LESS 变量"),a(n)]),s(" 或 "),e("a",m,[s("Stylus 变量"),a(n)]),s(" ，然后你可以在你的主题样式中使用这些变量。")]),g])}const _=i(r,[["render",b],["__file","palette.html.vue"]]);export{_ as default};
diff --git a/assets/palette.html-96b6024a.js b/assets/palette.html-96b6024a.js
new file mode 100644
index 00000000..51ea1e60
--- /dev/null
+++ b/assets/palette.html-96b6024a.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5fd3efae","path":"/zh/reference/plugin/palette.html","title":"palette","lang":"zh-CN","frontmatter":{"description":"为你的主题提供调色板功能。 该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。 对于主题作者，该插件可以帮助你提供用户自定义样式的能力。 使用方法 调色板和样式 该插件会提供一个 @vuepress/plugin-palette/palette （调色板文件）和一个 @vuepress/plugin-palette/st...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/palette.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/palette.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"palette"}],["meta",{"property":"og:description","content":"为你的主题提供调色板功能。 该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。 对于主题作者，该插件可以帮助你提供用户自定义样式的能力。 使用方法 调色板和样式 该插件会提供一个 @vuepress/plugin-palette/palette （调色板文件）和一个 @vuepress/plugin-palette/st..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"palette\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"调色板和样式","slug":"调色板和样式","link":"#调色板和样式","children":[]},{"level":2,"title":"使用","slug":"使用","link":"#使用","children":[{"level":3,"title":"使用调色板","slug":"使用调色板","link":"#使用调色板","children":[]},{"level":3,"title":"使用样式","slug":"使用样式","link":"#使用样式","children":[]}]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"preset","slug":"preset","link":"#preset","children":[]},{"level":3,"title":"userPaletteFile","slug":"userpalettefile","link":"#userpalettefile","children":[]},{"level":3,"title":"tempPaletteFile","slug":"temppalettefile","link":"#temppalettefile","children":[]},{"level":3,"title":"userStyleFile","slug":"userstylefile","link":"#userstylefile","children":[]},{"level":3,"title":"tempStyleFile","slug":"tempstylefile","link":"#tempstylefile","children":[]},{"level":3,"title":"importCode","slug":"importcode","link":"#importcode","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":3.55,"words":1066},"filePathRelative":"zh/reference/plugin/palette.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/palette.html-e4b95f90.js b/assets/palette.html-e4b95f90.js
new file mode 100644
index 00000000..1570f40d
--- /dev/null
+++ b/assets/palette.html-e4b95f90.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-37c5e106","path":"/reference/plugin/palette.html","title":"palette","lang":"en-US","frontmatter":{"description":"Provide palette support for your theme. This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most c...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/palette.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/palette.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"palette"}],["meta",{"property":"og:description","content":"Provide palette support for your theme. This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most c..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"palette\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Palette and Style","slug":"palette-and-style","link":"#palette-and-style","children":[]},{"level":2,"title":"Usage","slug":"usage-1","link":"#usage-1","children":[{"level":3,"title":"Usage of Palette","slug":"usage-of-palette","link":"#usage-of-palette","children":[]},{"level":3,"title":"Usage of Style","slug":"usage-of-style","link":"#usage-of-style","children":[]}]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"preset","slug":"preset","link":"#preset","children":[]},{"level":3,"title":"userPaletteFile","slug":"userpalettefile","link":"#userpalettefile","children":[]},{"level":3,"title":"tempPaletteFile","slug":"temppalettefile","link":"#temppalettefile","children":[]},{"level":3,"title":"userStyleFile","slug":"userstylefile","link":"#userstylefile","children":[]},{"level":3,"title":"tempStyleFile","slug":"tempstylefile","link":"#tempstylefile","children":[]},{"level":3,"title":"importCode","slug":"importcode","link":"#importcode","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.44,"words":731},"filePathRelative":"reference/plugin/palette.md","localizedDate":"February 22, 2023","autoDesc":true}`);export{e as data};
diff --git a/assets/passing-data-to-client-code.html-74bf54bf.js b/assets/passing-data-to-client-code.html-74bf54bf.js
new file mode 100644
index 00000000..4069e024
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-74bf54bf.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-10b13bae","path":"/zh/advanced/cookbook/passing-data-to-client-code.html","title":"向客户端代码传递数据","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:right-to-bracket","description":"我们知道，VuePress 插件入口和主题入口是在 Node 端处理的，但有时候你可能需要向客户端动态传递数据。例如，你希望在用户传入不同的选项时生成不同的数据。 使用 define Hook 插件 API 提供了一个 define (../../reference/plugin-api.md#define) Hook 来定义客户端代码中的全局常量。你...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/cookbook/passing-data-to-client-code.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/advanced/cookbook/passing-data-to-client-code.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"向客户端代码传递数据"}],["meta",{"property":"og:description","content":"我们知道，VuePress 插件入口和主题入口是在 Node 端处理的，但有时候你可能需要向客户端动态传递数据。例如，你希望在用户传入不同的选项时生成不同的数据。 使用 define Hook 插件 API 提供了一个 define (../../reference/plugin-api.md#define) Hook 来定义客户端代码中的全局常量。你..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"向客户端代码传递数据\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用 define Hook","slug":"使用-define-hook","link":"#使用-define-hook","children":[]},{"level":2,"title":"写入并加载临时文件","slug":"写入并加载临时文件","link":"#写入并加载临时文件","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.28,"words":384},"filePathRelative":"zh/advanced/cookbook/passing-data-to-client-code.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/passing-data-to-client-code.html-a8002c66.js b/assets/passing-data-to-client-code.html-a8002c66.js
new file mode 100644
index 00000000..d19afc2b
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-a8002c66.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3bc3633f","path":"/advanced/cookbook/passing-data-to-client-code.html","title":"Passing Data to Client Code","lang":"en-US","frontmatter":{"icon":"fa6-solid:right-to-bracket","description":"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 dif...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/passing-data-to-client-code.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/cookbook/passing-data-to-client-code.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Passing Data to Client Code"}],["meta",{"property":"og:description","content":"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 dif..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Passing Data to Client Code\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Use define Hook","slug":"use-define-hook","link":"#use-define-hook","children":[]},{"level":2,"title":"Write and Load Temp Files","slug":"write-and-load-temp-files","link":"#write-and-load-temp-files","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.87,"words":260},"filePathRelative":"advanced/cookbook/passing-data-to-client-code.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/passing-data-to-client-code.html-e724cdf3.js b/assets/passing-data-to-client-code.html-e724cdf3.js
new file mode 100644
index 00000000..1df455a4
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-e724cdf3.js
@@ -0,0 +1,26 @@
+import{_ as o,W as c,X as i,$ as s,a0 as n,Y as e,Z as t,a1 as p,D as l}from"./framework-46b0e263.js";const u={},r=s("h1",{id:"向客户端代码传递数据",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#向客户端代码传递数据","aria-hidden":"true"},"#"),n(" 向客户端代码传递数据")],-1),d=s("p",null,"我们知道，VuePress 插件入口和主题入口是在 Node 端处理的，但有时候你可能需要向客户端动态传递数据。例如，你希望在用户传入不同的选项时生成不同的数据。",-1),k=s("h2",{id:"使用-define-hook",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#使用-define-hook","aria-hidden":"true"},"#"),n(" 使用 "),s("code",null,"define"),n(" Hook")],-1),v=p(`
`,5);function b(g,f){const a=l("RouterLink");return c(),i("div",null,[r,d,k,s("p",null,[n("插件 API 提供了一个 "),e(a,{to:"/zh/reference/plugin-api.html#define"},{default:t(()=>[n("define")]),_:1}),n(" Hook 来定义客户端代码中的全局常量。你可以利用它来向客户端传递数据。")]),v,s("p",null,[n("首先，写入一个名为 "),m,n(" 的临时文件，它将会生成在 "),e(a,{to:"/zh/reference/config.html#temp"},{default:t(()=>[n("temp")]),_:1}),n(" 目录中：")]),_])}const y=o(u,[["render",b],["__file","passing-data-to-client-code.html.vue"]]);export{y as default};
diff --git a/assets/passing-data-to-client-code.html-e7881e68.js b/assets/passing-data-to-client-code.html-e7881e68.js
new file mode 100644
index 00000000..b1adb376
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-e7881e68.js
@@ -0,0 +1,26 @@
+import{_ as p,W as i,X as c,$ as s,a0 as n,Y as e,Z as t,a1 as o,D as l}from"./framework-46b0e263.js";const u={},d=s("h1",{id:"passing-data-to-client-code",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#passing-data-to-client-code","aria-hidden":"true"},"#"),n(" Passing Data to Client Code")],-1),r=s("p",null,"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.",-1),k=s("h2",{id:"use-define-hook",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#use-define-hook","aria-hidden":"true"},"#"),n(" Use "),s("code",null,"define"),n(" Hook")],-1),m=o(`
`,4),y=n("h3",{id:"extendsmarkdown",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#extendsmarkdown","aria-hidden":"true"},"#"),s(" extendsMarkdown")],-1),_=n("li",null,[n("p",null,[s("Type: "),n("code",null,"(md: Markdown, app: App) => void | Promise")])],-1),x=n("p",null,"Details:",-1),P=n("p",null,"Markdown enhancement.",-1),O=n("code",null,"Markdown",-1),T={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"},A=n("p",null,"This hook can be used for using extra markdown-it plugins and implementing customizations.",-1),q=n("li",null,[n("p",null,"Example:")],-1),C=p(`
This hook will be invoked once VuePress app has started dev-server and watched files change.
The watchers is an array of file watchers. When changing config file, the dev command will be restarted and those watchers will be closed. If you are adding new watchers in this hook, you should push your watchers to the watchers array, so that they can be closed correctly when restarting.
The restart is a method to restart the dev command. When calling this method, the watchers array will be closed automatically.
This hook will be invoked once VuePress app has generated static files.
',9);function I(B,N){const l=i("NpmBadge"),o=i("ExternalLinkIcon"),e=i("RouterLink");return u(),r("div",null,[k,a(l,{package:"@vuepress/core"}),n("p",null,[s("Plugin API is supported by "),n("a",h,[s("@vuepress/core"),a(o)]),s(" package. You could check out "),a(e,{to:"/reference/node-api.html"},{default:t(()=>[s("Node API")]),_:1}),s(" for how to use the VuePress app instance in plugin hooks.")]),m,n("blockquote",null,[n("p",null,[s("Check out "),a(e,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:t(()=>[s("Advanced > Architecture > Core Process and Hooks")]),_:1}),s(" to understand the process better.")])]),v,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(e,{to:"/reference/client-api.html#defineclientconfig"},{default:t(()=>[s("Client API > defineClientConfig")]),_:1})]),n("li",null,[a(e,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:t(()=>[s("Advanced > Cookbook > Usage of Client Config")]),_:1})])])])]),g,n("p",null,[s("Adding default "),n("a",b,[s("app.compilerOptions.isCustomElement"),a(o)]),s(" option:")]),f,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(e,{to:"/reference/bundler/vite.html"},{default:t(()=>[s("Bundlers > Vite")]),_:1})]),n("li",null,[a(e,{to:"/reference/bundler/webpack.html"},{default:t(()=>[s("Bundlers > Webpack")]),_:1})])])])]),w,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(e,{to:"/reference/config.html#markdown"},{default:t(()=>[s("Config > markdown")]),_:1})])])])]),y,n("ul",null,[_,n("li",null,[x,P,n("p",null,[s("This hook accepts a function that will receive an instance of "),O,s(" powered by "),n("a",T,[s("markdown-it"),a(o)]),s(" in its arguments.")]),A]),q]),C,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(e,{to:"/reference/node-api.html#createpage"},{default:t(()=>[s("Node API > Page > createPage")]),_:1})])])])]),D,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(e,{to:"/reference/client-api.html#usepagedata"},{default:t(()=>[s("Client API > usePageData")]),_:1})]),n("li",null,[a(e,{to:"/reference/node-api.html#data"},{default:t(()=>[s("Node API > Page Properties > data")]),_:1})]),n("li",null,[a(e,{to:"/reference/node-api.html#routemeta"},{default:t(()=>[s("Node API > Page Properties > routeMeta")]),_:1})])])])]),E])}const L=c(d,[["render",I],["__file","plugin-api.html.vue"]]);export{L as default};
diff --git a/assets/plugin-api.html-5e3b2303.js b/assets/plugin-api.html-5e3b2303.js
new file mode 100644
index 00000000..2c08584f
--- /dev/null
+++ b/assets/plugin-api.html-5e3b2303.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5e9d516d","path":"/zh/reference/plugin-api.html","title":"插件 API","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:plug","description":"插件 API 是由 @vuepress/core (https://www.npmjs.com/package/@vuepress/core) 包支持的。你可以查看 Node API (./node-api.md) 来了解如何使用插件 Hooks 中的 VuePress App 实例。 概览 插件需要在初始化之前使用。基础配置项会在使用插件时立即被处理...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin-api.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin-api.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"插件 API"}],["meta",{"property":"og:description","content":"插件 API 是由 @vuepress/core (https://www.npmjs.com/package/@vuepress/core) 包支持的。你可以查看 Node API (./node-api.md) 来了解如何使用插件 Hooks 中的 VuePress App 实例。 概览 插件需要在初始化之前使用。基础配置项会在使用插件时立即被处理..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"插件 API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"概览","slug":"概览","link":"#概览","children":[]},{"level":2,"title":"基础配置项","slug":"基础配置项","link":"#基础配置项","children":[{"level":3,"title":"name","slug":"name","link":"#name","children":[]},{"level":3,"title":"multiple","slug":"multiple","link":"#multiple","children":[]}]},{"level":2,"title":"开发 Hooks","slug":"开发-hooks","link":"#开发-hooks","children":[{"level":3,"title":"alias","slug":"alias","link":"#alias","children":[]},{"level":3,"title":"clientConfigFile","slug":"clientconfigfile","link":"#clientconfigfile","children":[]},{"level":3,"title":"define","slug":"define","link":"#define","children":[]},{"level":3,"title":"extendsBundlerOptions","slug":"extendsbundleroptions","link":"#extendsbundleroptions","children":[]},{"level":3,"title":"extendsMarkdownOptions","slug":"extendsmarkdownoptions","link":"#extendsmarkdownoptions","children":[]},{"level":3,"title":"extendsMarkdown","slug":"extendsmarkdown","link":"#extendsmarkdown","children":[]},{"level":3,"title":"extendsPageOptions","slug":"extendspageoptions","link":"#extendspageoptions","children":[]},{"level":3,"title":"extendsPage","slug":"extendspage","link":"#extendspage","children":[]}]},{"level":2,"title":"生命周期 Hooks","slug":"生命周期-hooks","link":"#生命周期-hooks","children":[{"level":3,"title":"onInitialized","slug":"oninitialized","link":"#oninitialized","children":[]},{"level":3,"title":"onPrepared","slug":"onprepared","link":"#onprepared","children":[]},{"level":3,"title":"onWatched","slug":"onwatched","link":"#onwatched","children":[]},{"level":3,"title":"onGenerated","slug":"ongenerated","link":"#ongenerated","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":5,"words":1501},"filePathRelative":"zh/reference/plugin-api.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/plugin-api.html-c8d9418d.js b/assets/plugin-api.html-c8d9418d.js
new file mode 100644
index 00000000..2b0e88f1
--- /dev/null
+++ b/assets/plugin-api.html-c8d9418d.js
@@ -0,0 +1,91 @@
+import{_ as c,W as u,X as r,Y as s,$ as n,a0 as a,Z as t,a1 as p,D as i}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"插件-api",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#插件-api","aria-hidden":"true"},"#"),a(" 插件 API")],-1),v={href:"https://www.npmjs.com/package/@vuepress/core",target:"_blank",rel:"noopener noreferrer"},m=p('
',9);function z(I,M){const l=i("NpmBadge"),o=i("ExternalLinkIcon"),e=i("RouterLink");return u(),r("div",null,[k,s(l,{package:"@vuepress/core"}),n("p",null,[a("插件 API 是由 "),n("a",v,[a("@vuepress/core"),s(o)]),a(" 包支持的。你可以查看 "),s(e,{to:"/zh/reference/node-api.html"},{default:t(()=>[a("Node API")]),_:1}),a(" 来了解如何使用插件 Hooks 中的 VuePress App 实例。")]),m,n("blockquote",null,[n("p",null,[a("查看 "),s(e,{to:"/zh/advanced/architecture.html#%E6%A0%B8%E5%BF%83%E6%B5%81%E7%A8%8B%E4%B8%8E-hooks"},{default:t(()=>[a("深入 > 架构 > 核心流程与 Hooks")]),_:1}),a(" 来更好地理解该流程。")])]),h,n("ul",null,[n("li",null,[a("参考： "),n("ul",null,[n("li",null,[s(e,{to:"/zh/reference/client-api.html#defineclientconfig"},{default:t(()=>[a("客户端 API > defineClientConfig")]),_:1})]),n("li",null,[s(e,{to:"/zh/advanced/cookbook/usage-of-client-config.html"},{default:t(()=>[a("深入 > Cookbook > 客户端配置的使用方法")]),_:1})])])])]),b,n("p",null,[a("添加默认的 "),n("a",g,[a("app.compilerOptions.isCustomElement"),s(o)]),a(" 配置：")]),f,n("ul",null,[n("li",null,[a("参考： "),n("ul",null,[n("li",null,[s(e,{to:"/zh/reference/bundler/vite.html"},{default:t(()=>[a("打包工具 > Vite")]),_:1})]),n("li",null,[s(e,{to:"/zh/reference/bundler/webpack.html"},{default:t(()=>[a("打包工具 > Webpack")]),_:1})])])])]),_,n("ul",null,[n("li",null,[a("参考： "),n("ul",null,[n("li",null,[s(e,{to:"/zh/reference/config.html#markdown"},{default:t(()=>[a("配置 > markdown")]),_:1})])])])]),w,n("ul",null,[y,n("li",null,[x,P,n("p",null,[a("该 Hook 接收一个函数，在参数中会收到一个由 "),n("a",O,[a("markdown-it"),s(o)]),a(" 提供的 "),A,a(" 实例。")]),E]),q]),B,n("ul",null,[n("li",null,[a("参考： "),n("ul",null,[n("li",null,[s(e,{to:"/zh/reference/node-api.html#createPage"},{default:t(()=>[a("Node API > Page > createPage")]),_:1})])])])]),H,n("ul",null,[n("li",null,[a("参考： "),n("ul",null,[n("li",null,[s(e,{to:"/zh/reference/client-api.html#usepagedata"},{default:t(()=>[a("客户端 API > usePageData")]),_:1})]),n("li",null,[s(e,{to:"/zh/reference/node-api.html#data"},{default:t(()=>[a("Node API > Page 属性 > data")]),_:1})]),n("li",null,[s(e,{to:"/zh/reference/node-api.html#routemeta"},{default:t(()=>[a("Node API > Page 属性 > routeMeta")]),_:1})])])])]),C])}const D=c(d,[["render",z],["__file","plugin-api.html.vue"]]);export{D as default};
diff --git a/assets/plugin-api.html-e5d3923f.js b/assets/plugin-api.html-e5d3923f.js
new file mode 100644
index 00000000..93662515
--- /dev/null
+++ b/assets/plugin-api.html-e5d3923f.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-51569e88","path":"/reference/plugin-api.html","title":"Plugin API","lang":"en-US","frontmatter":{"icon":"fa6-solid:plug","description":"Plugin API is supported by @vuepress/core (https://www.npmjs.com/package/@vuepress/core) package. You could check out Node API (./node-api.md) for how to use the VuePress app in...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin-api.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin-api.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Plugin API"}],["meta",{"property":"og:description","content":"Plugin API is supported by @vuepress/core (https://www.npmjs.com/package/@vuepress/core) package. You could check out Node API (./node-api.md) for how to use the VuePress app in..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Plugin API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Overview","slug":"overview","link":"#overview","children":[]},{"level":2,"title":"Basic Options","slug":"basic-options","link":"#basic-options","children":[{"level":3,"title":"name","slug":"name","link":"#name","children":[]},{"level":3,"title":"multiple","slug":"multiple","link":"#multiple","children":[]}]},{"level":2,"title":"Development Hooks","slug":"development-hooks","link":"#development-hooks","children":[{"level":3,"title":"alias","slug":"alias","link":"#alias","children":[]},{"level":3,"title":"clientConfigFile","slug":"clientconfigfile","link":"#clientconfigfile","children":[]},{"level":3,"title":"define","slug":"define","link":"#define","children":[]},{"level":3,"title":"extendsBundlerOptions","slug":"extendsbundleroptions","link":"#extendsbundleroptions","children":[]},{"level":3,"title":"extendsMarkdownOptions","slug":"extendsmarkdownoptions","link":"#extendsmarkdownoptions","children":[]},{"level":3,"title":"extendsMarkdown","slug":"extendsmarkdown","link":"#extendsmarkdown","children":[]},{"level":3,"title":"extendsPageOptions","slug":"extendspageoptions","link":"#extendspageoptions","children":[]},{"level":3,"title":"extendsPage","slug":"extendspage","link":"#extendspage","children":[]}]},{"level":2,"title":"Lifecycle Hooks","slug":"lifecycle-hooks","link":"#lifecycle-hooks","children":[{"level":3,"title":"onInitialized","slug":"oninitialized","link":"#oninitialized","children":[]},{"level":3,"title":"onPrepared","slug":"onprepared","link":"#onprepared","children":[]},{"level":3,"title":"onWatched","slug":"onwatched","link":"#onwatched","children":[]},{"level":3,"title":"onGenerated","slug":"ongenerated","link":"#ongenerated","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":3.68,"words":1104},"filePathRelative":"reference/plugin-api.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/plugin.html-6b68f3b2.js b/assets/plugin.html-6b68f3b2.js
new file mode 100644
index 00000000..4579a61f
--- /dev/null
+++ b/assets/plugin.html-6b68f3b2.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-574aac41","path":"/zh/advanced/plugin.html","title":"开发插件","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:plug","description":"在阅读该指南之前，你最好先了解一下 VuePress 的 架构 (./architecture.md) 。 创建一个插件 插件是一个符合 插件 API (../reference/plugin-api.md) 的普通 JavaScript 对象，称之为 插件对象 ： 插件还可以是一个接收 App 实例 (../reference/node-api.md...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/plugin.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/advanced/plugin.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"开发插件"}],["meta",{"property":"og:description","content":"在阅读该指南之前，你最好先了解一下 VuePress 的 架构 (./architecture.md) 。 创建一个插件 插件是一个符合 插件 API (../reference/plugin-api.md) 的普通 JavaScript 对象，称之为 插件对象 ： 插件还可以是一个接收 App 实例 (../reference/node-api.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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"开发插件\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"创建一个插件","slug":"创建一个插件","link":"#创建一个插件","children":[]},{"level":2,"title":"发布到 NPM","slug":"发布到-npm","link":"#发布到-npm","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.15,"words":345},"filePathRelative":"zh/advanced/plugin.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/plugin.html-70d14bec.js b/assets/plugin.html-70d14bec.js
new file mode 100644
index 00000000..e0798385
--- /dev/null
+++ b/assets/plugin.html-70d14bec.js
@@ -0,0 +1,30 @@
+import{_ as l,W as c,X as u,$ as s,a0 as n,Y as a,Z as t,a1 as o,D as i}from"./framework-46b0e263.js";const r={},d=s("h1",{id:"writing-a-plugin",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#writing-a-plugin","aria-hidden":"true"},"#"),n(" Writing a Plugin")],-1),v={class:"hint-container tip"},k=s("p",{class:"hint-container-title"},"Tips",-1),m=s("h2",{id:"create-a-plugin",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-plugin","aria-hidden":"true"},"#"),n(" Create a Plugin")],-1),h=s("em",null,"Plugin Object",-1),g=o(`
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:
`,1),x=s("code",null,"name",-1),P=s("code",null,"vuepress-plugin-xxx",-1),q=s("code",null,"@org/vuepress-plugin-xxx",-1),j=s("em",null,"Plugin Object",-1),N=s("li",null,[n("Set "),s("code",null,"keywords"),n(" to include "),s("code",null,"vuepress-plugin"),n(", so that users can search your plugin on NPM.")],-1);function A(V,B){const e=i("RouterLink"),p=i("ExternalLinkIcon");return c(),u("div",null,[d,s("div",v,[k,s("p",null,[n("Before reading this guide, you'd better learn the VuePress "),a(e,{to:"/advanced/architecture.html"},{default:t(()=>[n("architecture")]),_:1}),n(" first.")])]),m,s("p",null,[n("A plugin should be a plain JavaScript object that satisfies the "),a(e,{to:"/reference/plugin-api.html"},{default:t(()=>[n("Plugin API")]),_:1}),n(", which is called a "),h,n(":")]),g,s("p",null,[n("A plugin could also be a function that receives the "),a(e,{to:"/reference/node-api.html#app"},{default:t(()=>[n("app instance")]),_:1}),n(" as the param and returns a "),b,n(", which is called a "),_,n(":")]),f,s("p",null,[n("After creating a plugin, you should follow some conventions in the "),s("a",y,[n("package.json"),a(p)]),n(" file before publishing it to NPM:")]),w,s("ul",null,[s("li",null,[n("Set "),x,n(" to follow the naming convention, i.e. "),P,n(" or "),q,n(", which should be consistent with the "),a(e,{to:"/reference/plugin-api.html#name"},{default:t(()=>[n("name")]),_:1}),n(" field of the "),j,n(".")]),N])])}const O=l(r,[["render",A],["__file","plugin.html.vue"]]);export{O as default};
diff --git a/assets/plugin.html-7408e888.js b/assets/plugin.html-7408e888.js
new file mode 100644
index 00000000..b3b227e6
--- /dev/null
+++ b/assets/plugin.html-7408e888.js
@@ -0,0 +1,30 @@
+import{_ as c,W as l,X as u,$ as s,a0 as n,Y as a,Z as t,a1 as o,D as p}from"./framework-46b0e263.js";const r={},d=s("h1",{id:"开发插件",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#开发插件","aria-hidden":"true"},"#"),n(" 开发插件")],-1),k={class:"hint-container tip"},v=s("p",{class:"hint-container-title"},"提示",-1),m=s("h2",{id:"创建一个插件",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#创建一个插件","aria-hidden":"true"},"#"),n(" 创建一个插件")],-1),h=s("em",null,"插件对象",-1),_=o(`
`,1),q=s("code",null,"name",-1),w=s("code",null,"vuepress-plugin-xxx",-1),P=s("code",null,"@org/vuepress-plugin-xxx",-1),N=s("em",null,"插件对象",-1),j=s("li",null,[n("在 "),s("code",null,"keywords"),n(" 中包含 "),s("code",null,"vuepress-plugin"),n(" ，这样用户可以在 NPM 上搜索到你的插件。")],-1);function V(z,L){const e=p("RouterLink"),i=p("ExternalLinkIcon");return l(),u("div",null,[d,s("div",k,[v,s("p",null,[n("在阅读该指南之前，你最好先了解一下 VuePress 的 "),a(e,{to:"/zh/advanced/architecture.html"},{default:t(()=>[n("架构")]),_:1}),n(" 。")])]),m,s("p",null,[n("插件是一个符合 "),a(e,{to:"/zh/reference/plugin-api.html"},{default:t(()=>[n("插件 API")]),_:1}),n(" 的普通 JavaScript 对象，称之为 "),h,n(" ：")]),_,s("p",null,[n("插件还可以是一个接收 "),a(e,{to:"/zh/reference/node-api.html#app"},{default:t(()=>[n("App 实例")]),_:1}),n(" 作为参数，且返回值为 "),g,n(" 的函数，称之为 "),b,n(" ：")]),f,s("p",null,[n("在创建了插件之后，你需要在 "),s("a",x,[n("package.json"),a(i)]),n(" 文件中遵循一定的约定，然后再将其发布到 NPM 上：")]),y,s("ul",null,[s("li",null,[n("将 "),q,n(" 按照约定命名，即 "),w,n(" 或 "),P,n(" ，它应该和 "),N,n(" 的 "),a(e,{to:"/zh/reference/plugin-api.html#name"},{default:t(()=>[n("name")]),_:1}),n(" 字段保持一致。")]),j])])}const E=c(r,[["render",V],["__file","plugin.html.vue"]]);export{E as default};
diff --git a/assets/plugin.html-95fad35f.js b/assets/plugin.html-95fad35f.js
new file mode 100644
index 00000000..7083db28
--- /dev/null
+++ b/assets/plugin.html-95fad35f.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-1d14d5cc","path":"/guide/plugin.html","title":"Plugin","lang":"en-US","frontmatter":{"icon":"fa6-solid:plug","description":"With the help of Plugin API (../reference/plugin-api.md), VuePress plugin can provide different features for you. Community Plugin Community users have created lots of plugins a...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/plugin.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/guide/plugin.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Plugin"}],["meta",{"property":"og:description","content":"With the help of Plugin API (../reference/plugin-api.md), VuePress plugin can provide different features for you. Community Plugin Community users have created lots of plugins a..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Plugin\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Community Plugin","slug":"community-plugin","link":"#community-plugin","children":[]},{"level":2,"title":"Local Plugin","slug":"local-plugin","link":"#local-plugin","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.03,"words":309},"filePathRelative":"guide/plugin.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/plugin.html-b89655ab.js b/assets/plugin.html-b89655ab.js
new file mode 100644
index 00000000..2807fef5
--- /dev/null
+++ b/assets/plugin.html-b89655ab.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-9043126a","path":"/zh/guide/plugin.html","title":"插件","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:plug","description":"借助于 插件 API (../reference/plugin-api.md) ， VuePress 插件可以为你提供各种不同的功能。 社区插件 社区用户创建了很多插件，并将它们发布到了 NPM (https://www.npmjs.com/search?q=keywords:vuepress-plugin) 上。 VuePress 团队也在 @vue...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/plugin.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/plugin.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"插件"}],["meta",{"property":"og:description","content":"借助于 插件 API (../reference/plugin-api.md) ， VuePress 插件可以为你提供各种不同的功能。 社区插件 社区用户创建了很多插件，并将它们发布到了 NPM (https://www.npmjs.com/search?q=keywords:vuepress-plugin) 上。 VuePress 团队也在 @vue..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"插件\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"社区插件","slug":"社区插件","link":"#社区插件","children":[]},{"level":2,"title":"本地插件","slug":"本地插件","link":"#本地插件","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.48,"words":444},"filePathRelative":"zh/guide/plugin.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/plugin.html-bed3198b.js b/assets/plugin.html-bed3198b.js
new file mode 100644
index 00000000..b04e8c0d
--- /dev/null
+++ b/assets/plugin.html-bed3198b.js
@@ -0,0 +1,15 @@
+import{_ as u,W as p,X as c,$ as e,a0 as n,Y as s,Z as t,a1 as l,D as i}from"./framework-46b0e263.js";const r={},d=e("h1",{id:"plugin",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugin","aria-hidden":"true"},"#"),n(" Plugin")],-1),g=e("h2",{id:"community-plugin",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#community-plugin","aria-hidden":"true"},"#"),n(" Community Plugin")],-1),h={href:"https://www.npmjs.com/search?q=keywords:vuepress-plugin",target:"_blank",rel:"noopener noreferrer"},m={href:"https://www.npmjs.com/search?q=%40vuepress%20keywords%3Aplugin",target:"_blank",rel:"noopener noreferrer"},f=l(`
`,1),k={class:"hint-container tip"},v=e("p",{class:"hint-container-title"},"Tips",-1),_=e("p",null,"Most plugins can only be used once. If the same plugin is used multiple times, only the last one will take effect.",-1),y=e("h2",{id:"local-plugin",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#local-plugin","aria-hidden":"true"},"#"),n(" Local Plugin")],-1),b=e("p",null,"If you want to use your own plugin but don't want to publish it, you can create a local plugin.",-1),w=l(`
But if you have too many things to do in your config file, you can consider to extract them into separate plugins, and use them in your config file:
`,2);function x(P,X){const a=i("RouterLink"),o=i("ExternalLinkIcon");return p(),c("div",null,[d,e("p",null,[n("With the help of "),s(a,{to:"/reference/plugin-api.html"},{default:t(()=>[n("Plugin API")]),_:1}),n(", VuePress plugin can provide different features for you.")]),g,e("p",null,[n("Community users have created lots of plugins and published them to "),e("a",h,[n("NPM"),s(o)]),n(". VuePress team also maintains some official plugins under the "),e("a",m,[n("@vuepress"),s(o)]),n(" scope. You should check the plugin's own documentation for detailed guide.")]),e("p",null,[n("In general, you need to import the plugin and use it in your config file via the "),s(a,{to:"/reference/config.html#plugins"},{default:t(()=>[n("plugins")]),_:1}),n(" option. For example, use the "),s(a,{to:"/reference/plugin/google-analytics.html"},{default:t(()=>[n("@vuepress/plugin-google-analytics")]),_:1}),n(" to integrate Google Analytics:")]),f,e("div",k,[v,_,e("p",null,[n("However, some plugins can be used multiple times (e.g. "),s(a,{to:"/reference/plugin/container.html"},{default:t(()=>[n("@vuepress/plugin-container")]),_:1}),n("), and you should check the documentation of the plugin itself for detailed guide.")])]),y,b,e("p",null,[n("It is recommended to use the "),s(a,{to:"/guide/configuration.html#config-file"},{default:t(()=>[n("Config File")]),_:1}),n(" directly as a plugin, because "),s(a,{to:"/reference/config.html#plugin-api"},{default:t(()=>[n("almost all of the Plugin APIs are available")]),_:1}),n(", which would be more convenient in most cases.")]),w,e("p",null,[n("You can refer to "),s(a,{to:"/advanced/plugin.html"},{default:t(()=>[n("Advanced > Writing a Plugin")]),_:1}),n(" for how to write your own plugin.")])])}const I=u(r,[["render",x],["__file","plugin.html.vue"]]);export{I as default};
diff --git a/assets/plugin.html-d44754d7.js b/assets/plugin.html-d44754d7.js
new file mode 100644
index 00000000..8268b620
--- /dev/null
+++ b/assets/plugin.html-d44754d7.js
@@ -0,0 +1,15 @@
+import{_ as l,W as c,X as u,$ as s,a0 as n,Y as a,Z as t,a1 as i,D as p}from"./framework-46b0e263.js";const r={},d=s("h1",{id:"插件",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#插件","aria-hidden":"true"},"#"),n(" 插件")],-1),k=s("h2",{id:"社区插件",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#社区插件","aria-hidden":"true"},"#"),n(" 社区插件")],-1),h={href:"https://www.npmjs.com/search?q=keywords:vuepress-plugin",target:"_blank",rel:"noopener noreferrer"},g={href:"https://www.npmjs.com/search?q=%40vuepress%20keywords%3Aplugin",target:"_blank",rel:"noopener noreferrer"},m=i(`
`,2);function x(X,B){const e=p("RouterLink"),o=p("ExternalLinkIcon");return c(),u("div",null,[d,s("p",null,[n("借助于 "),a(e,{to:"/zh/reference/plugin-api.html"},{default:t(()=>[n("插件 API")]),_:1}),n(" ， VuePress 插件可以为你提供各种不同的功能。")]),k,s("p",null,[n("社区用户创建了很多插件，并将它们发布到了 "),s("a",h,[n("NPM"),a(o)]),n(" 上。 VuePress 团队也在 "),s("a",g,[n("@vuepress"),a(o)]),n(" Scope 下维护了一些官方插件。查看插件本身的文档可以获取更详细的指引。")]),s("p",null,[n("一般而言，你需要导入插件并通过配置文件的 "),a(e,{to:"/zh/reference/config.html#plugins"},{default:t(()=>[n("plugins")]),_:1}),n(" 配置项来使用它。举例来说，你可以使用 "),a(e,{to:"/zh/reference/plugin/google-analytics.html"},{default:t(()=>[n("@vuepress/plugin-google-analytics")]),_:1}),n(" 来使用 Google Analytics ：")]),m,s("div",v,[_,f,s("p",null,[n("然而，部分插件是可以被多次使用的（例如 "),a(e,{to:"/zh/reference/plugin/container.html"},{default:t(()=>[n("@vuepress/plugin-container")]),_:1}),n("），你应该查看插件本身的文档来获取详细指引。")])]),b,y,s("p",null,[n("我们推荐你直接将 "),a(e,{to:"/zh/guide/configuration.html#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"},{default:t(()=>[n("配置文件")]),_:1}),n(" 作为插件使用，因为 "),a(e,{to:"/zh/reference/config.html#%E6%8F%92%E4%BB%B6-api"},{default:t(()=>[n("几乎所有的插件 API 都可以在配置文件中使用")]),_:1}),n("，这在绝大多数场景下都更为方便。")]),w,s("p",null,[n("前往 "),a(e,{to:"/zh/advanced/plugin.html"},{default:t(()=>[n("深入 > 开发插件")]),_:1}),n(" 学习如何开发你自己的插件。")])])}const P=l(r,[["render",x],["__file","plugin.html.vue"]]);export{P as default};
diff --git a/assets/plugin.html-ebe09bff.js b/assets/plugin.html-ebe09bff.js
new file mode 100644
index 00000000..ec26cc41
--- /dev/null
+++ b/assets/plugin.html-ebe09bff.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-301ab792","path":"/advanced/plugin.html","title":"Writing a Plugin","lang":"en-US","frontmatter":{"icon":"fa6-solid:plug","description":"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 th...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/plugin.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/plugin.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Writing a Plugin"}],["meta",{"property":"og:description","content":"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 th..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Writing a Plugin\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Create a Plugin","slug":"create-a-plugin","link":"#create-a-plugin","children":[]},{"level":2,"title":"Publish to NPM","slug":"publish-to-npm","link":"#publish-to-npm","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.82,"words":247},"filePathRelative":"advanced/plugin.md","localizedDate":"February 22, 2023","autoDesc":true}`);export{e as data};
diff --git a/assets/prismjs.html-1adf5589.js b/assets/prismjs.html-1adf5589.js
new file mode 100644
index 00000000..70af9ae7
--- /dev/null
+++ b/assets/prismjs.html-1adf5589.js
@@ -0,0 +1,11 @@
+import{_ as l,W as o,X as p,Y as a,$ as n,a0 as s,a1 as r,D as t}from"./framework-46b0e263.js";const c={},d=n("h1",{id:"prismjs",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#prismjs","aria-hidden":"true"},"#"),s(" prismjs")],-1),u={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},m=r(`
该插件已经集成到默认主题中。
需要注意的是，该插件仅会给代码块添加 HTML 标记，而不会添加样式。当你在一个自定义主题中使用它时，可能需要自己选择并引入 Prism.js 样式主题。
`,7),h=n("li",null,[n("p",null,[s("类型： "),n("code",null,"string[]")])],-1),k=n("li",null,[n("p",null,[s("默认值： "),n("code",null,"['markdown', 'jsdoc', 'yaml']")])],-1),_=n("p",null,"详情：",-1),v=n("p",null,"需要预加载的语言。",-1),g=n("p",null,"默认情况下，语言会在解析 Markdown 文件时按需加载。",-1),b={href:"https://github.com/PrismJS/prism/issues/2716",target:"_blank",rel:"noopener noreferrer"};function f(j,x){const i=t("NpmBadge"),e=t("ExternalLinkIcon");return o(),p("div",null,[d,a(i,{package:"@vuepress/plugin-prismjs"}),n("p",null,[s("该插件使用 "),n("a",u,[s("Prism.js"),a(e)]),s(" 来为 Markdown 代码块启用代码高亮。")]),m,n("ul",null,[h,k,n("li",null,[_,v,g,n("p",null,[s("然而， Prism.js 在动态加载语言时可能会遇到 "),n("a",b,[s("一些潜在的问题"),a(e)]),s(" 。为了避免这些问题，你可以使用该配置项来预加载一些语言。")])])])])}const y=l(c,[["render",f],["__file","prismjs.html.vue"]]);export{y as default};
diff --git a/assets/prismjs.html-22d9c496.js b/assets/prismjs.html-22d9c496.js
new file mode 100644
index 00000000..829f7dd0
--- /dev/null
+++ b/assets/prismjs.html-22d9c496.js
@@ -0,0 +1,11 @@
+import{_ as o,W as l,X as p,Y as e,$ as n,a0 as s,a1 as r,D as t}from"./framework-46b0e263.js";const c={},d=n("h1",{id:"prismjs",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#prismjs","aria-hidden":"true"},"#"),s(" prismjs")],-1),u={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},h=r(`
This plugin has been integrated into the default theme.
Notice that this plugin would only tokenize the code fence without adding styles. When using it with a custom theme, you may need to choose and import Prism.js style theme yourself.
`,7),m=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string[]")])],-1),g=n("li",null,[n("p",null,[s("Default: "),n("code",null,"['markdown', 'jsdoc', 'yaml']")])],-1),k=n("p",null,"Details:",-1),v=n("p",null,"Languages to preload.",-1),_=n("p",null,"By default, languages will be loaded on demand when parsing markdown files.",-1),b={href:"https://github.com/PrismJS/prism/issues/2716",target:"_blank",rel:"noopener noreferrer"};function f(y,j){const i=t("NpmBadge"),a=t("ExternalLinkIcon");return l(),p("div",null,[d,e(i,{package:"@vuepress/plugin-prismjs"}),n("p",null,[s("This plugin will enable syntax highlighting for markdown code fence with "),n("a",u,[s("Prism.js"),e(a)]),s(".")]),h,n("ul",null,[m,g,n("li",null,[k,v,_,n("p",null,[s("However, Prism.js has "),n("a",b,[s("some potential issues"),e(a)]),s(" about loading languages dynamically. To avoid them, you can preload languages via this option.")])])])])}const x=o(c,[["render",f],["__file","prismjs.html.vue"]]);export{x as default};
diff --git a/assets/prismjs.html-b41398b8.js b/assets/prismjs.html-b41398b8.js
new file mode 100644
index 00000000..2e11ff83
--- /dev/null
+++ b/assets/prismjs.html-b41398b8.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-9cba4982","path":"/zh/reference/plugin/prismjs.html","title":"prismjs","lang":"zh-CN","frontmatter":{"description":"该插件使用 Prism.js (https://prismjs.com/) 来为 Markdown 代码块启用代码高亮。 该插件已经集成到默认主题中。 需要注意的是，该插件仅会给代码块添加 HTML 标记，而不会添加样式。当你在一个自定义主题中使用它时，可能需要自己选择并引入 Prism.js 样式主题。 使用方法 配置项 preloadLanguag...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/prismjs.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/prismjs.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"prismjs"}],["meta",{"property":"og:description","content":"该插件使用 Prism.js (https://prismjs.com/) 来为 Markdown 代码块启用代码高亮。 该插件已经集成到默认主题中。 需要注意的是，该插件仅会给代码块添加 HTML 标记，而不会添加样式。当你在一个自定义主题中使用它时，可能需要自己选择并引入 Prism.js 样式主题。 使用方法 配置项 preloadLanguag..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"prismjs\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"preloadLanguages","slug":"preloadlanguages","link":"#preloadlanguages","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.74,"words":223},"filePathRelative":"zh/reference/plugin/prismjs.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/prismjs.html-c9458bed.js b/assets/prismjs.html-c9458bed.js
new file mode 100644
index 00000000..f7016f92
--- /dev/null
+++ b/assets/prismjs.html-c9458bed.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-35ebfb0e","path":"/reference/plugin/prismjs.html","title":"prismjs","lang":"en-US","frontmatter":{"description":"This plugin will enable syntax highlighting for markdown code fence with Prism.js (https://prismjs.com/). This plugin has been integrated into the default theme. Notice that thi...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/prismjs.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/prismjs.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"prismjs"}],["meta",{"property":"og:description","content":"This plugin will enable syntax highlighting for markdown code fence with Prism.js (https://prismjs.com/). This plugin has been integrated into the default theme. Notice that thi..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"prismjs\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"preloadLanguages","slug":"preloadlanguages","link":"#preloadlanguages","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.45,"words":136},"filePathRelative":"reference/plugin/prismjs.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/pwa-popup.html-7ff33522.js b/assets/pwa-popup.html-7ff33522.js
new file mode 100644
index 00000000..eb835a99
--- /dev/null
+++ b/assets/pwa-popup.html-7ff33522.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6df47ee0","path":"/zh/reference/plugin/pwa-popup.html","title":"pwa-popup","lang":"zh-CN","frontmatter":{"description":"提供一个弹窗组件，允许用户手动刷新 PWA Service Worker 。 该插件必须和 pwa 插件 (./pwa.md) 一起使用，并且 skipWaiting 配置项不能设置为 true 。 当新的 Service Worker 就绪时，会在页面右下角出现一个弹窗，询问用户是否需要激活处于 Waiting 状态的 Service Worker ...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/pwa-popup.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/pwa-popup.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"pwa-popup"}],["meta",{"property":"og:description","content":"提供一个弹窗组件，允许用户手动刷新 PWA Service Worker 。 该插件必须和 pwa 插件 (./pwa.md) 一起使用，并且 skipWaiting 配置项不能设置为 true 。 当新的 Service Worker 就绪时，会在页面右下角出现一个弹窗，询问用户是否需要激活处于 Waiting 状态的 Service Worker ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"pwa-popup\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"样式","slug":"样式","link":"#样式","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.85,"words":255},"filePathRelative":"zh/reference/plugin/pwa-popup.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/pwa-popup.html-a135b6f9.js b/assets/pwa-popup.html-a135b6f9.js
new file mode 100644
index 00000000..28dc8b46
--- /dev/null
+++ b/assets/pwa-popup.html-a135b6f9.js
@@ -0,0 +1,30 @@
+import{_ as l,W as c,X as u,Y as a,$ as n,a0 as s,Z as p,a1 as o,D as t}from"./framework-46b0e263.js";const r={},d=n("h1",{id:"pwa-popup",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#pwa-popup","aria-hidden":"true"},"#"),s(" pwa-popup")],-1),k=n("p",null,"提供一个弹窗组件，允许用户手动刷新 PWA Service Worker 。",-1),v=n("code",null,"skipWaiting",-1),m=n("code",null,"true",-1),h=o(`
当新的 Service Worker 就绪时，会在页面右下角出现一个弹窗，询问用户是否需要激活处于 Waiting 状态的 Service Worker 。
',3);function b(_,w){const i=t("NpmBadge"),e=t("RouterLink");return c(),u("div",null,[d,a(i,{package:"@vuepress/plugin-pwa-popup"}),k,n("p",null,[s("该插件必须和 "),a(e,{to:"/zh/reference/plugin/pwa.html"},{default:p(()=>[s("pwa 插件")]),_:1}),s(" 一起使用，并且 "),v,s(" 配置项不能设置为 "),m,s(" 。")]),h,n("ul",null,[n("li",null,[s("参考： "),n("ul",null,[n("li",null,[a(e,{to:"/zh/guide/i18n.html"},{default:p(()=>[s("指南 > 多语言支持")]),_:1})])])])]),g])}const x=l(r,[["render",b],["__file","pwa-popup.html.vue"]]);export{x as default};
diff --git a/assets/pwa-popup.html-bb82625d.js b/assets/pwa-popup.html-bb82625d.js
new file mode 100644
index 00000000..74f85f78
--- /dev/null
+++ b/assets/pwa-popup.html-bb82625d.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5f86289f","path":"/reference/plugin/pwa-popup.html","title":"pwa-popup","lang":"en-US","frontmatter":{"description":"Provide a popup component for users to activate the new PWA service worker manually. This plugin must be used together with pwa plugin (./pwa.md), and the skipWaiting option mus...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/pwa-popup.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/pwa-popup.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"pwa-popup"}],["meta",{"property":"og:description","content":"Provide a popup component for users to activate the new PWA service worker manually. This plugin must be used together with pwa plugin (./pwa.md), and the skipWaiting option mus..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"pwa-popup\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.67,"words":202},"filePathRelative":"reference/plugin/pwa-popup.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/pwa-popup.html-f245bee2.js b/assets/pwa-popup.html-f245bee2.js
new file mode 100644
index 00000000..bb8d6f9f
--- /dev/null
+++ b/assets/pwa-popup.html-f245bee2.js
@@ -0,0 +1,30 @@
+import{_ as l,W as c,X as u,Y as a,$ as n,a0 as s,Z as t,a1 as o,D as p}from"./framework-46b0e263.js";const r={},d=n("h1",{id:"pwa-popup",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#pwa-popup","aria-hidden":"true"},"#"),s(" pwa-popup")],-1),k=n("p",null,"Provide a popup component for users to activate the new PWA service worker manually.",-1),v=n("code",null,"skipWaiting",-1),m=n("code",null,"true",-1),h=o(`
When the new service worker is ready, a popup will appear in the right bottom of the page to ask users to activate the waiting service worker.
You can customize the style of the popup via CSS variables:
File not found
',3);function b(f,w){const i=p("NpmBadge"),e=p("RouterLink");return c(),u("div",null,[d,a(i,{package:"@vuepress/plugin-pwa-popup"}),k,n("p",null,[s("This plugin must be used together with "),a(e,{to:"/reference/plugin/pwa.html"},{default:t(()=>[s("pwa plugin")]),_:1}),s(", and the "),v,s(" option must not be set to "),m,s(".")]),h,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(e,{to:"/guide/i18n.html"},{default:t(()=>[s("Guide > I18n")]),_:1})])])])]),g])}const y=l(r,[["render",b],["__file","pwa-popup.html.vue"]]);export{y as default};
diff --git a/assets/pwa.html-48090ed1.js b/assets/pwa.html-48090ed1.js
new file mode 100644
index 00000000..68c0dd95
--- /dev/null
+++ b/assets/pwa.html-48090ed1.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-01fcaa4f","path":"/zh/reference/plugin/pwa.html","title":"pwa","lang":"zh-CN","frontmatter":{"description":"使你的 VuePress 站点成为一个 渐进式 Web 应用 (PWA) (https://developer.mozilla.org/zh-CN/docs/Web/Progressivewebapps). 该插件使用 workbox-build (https://developers.google.com/web/tools/workbox/modu...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/pwa.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/pwa.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"pwa"}],["meta",{"property":"og:description","content":"使你的 VuePress 站点成为一个 渐进式 Web 应用 (PWA) (https://developer.mozilla.org/zh-CN/docs/Web/Progressivewebapps). 该插件使用 workbox-build (https://developers.google.com/web/tools/workbox/modu..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"pwa\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"Web App Manifests","slug":"web-app-manifests","link":"#web-app-manifests","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"serviceWorkerFilename","slug":"serviceworkerfilename","link":"#serviceworkerfilename","children":[]}]},{"level":2,"title":"Composition API","slug":"composition-api","link":"#composition-api","children":[{"level":3,"title":"usePwaEvent","slug":"usepwaevent","link":"#usepwaevent","children":[]},{"level":3,"title":"useSkipWaiting","slug":"useskipwaiting","link":"#useskipwaiting","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.68,"words":803},"filePathRelative":"zh/reference/plugin/pwa.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/pwa.html-4dcccf61.js b/assets/pwa.html-4dcccf61.js
new file mode 100644
index 00000000..ee8edb89
--- /dev/null
+++ b/assets/pwa.html-4dcccf61.js
@@ -0,0 +1,68 @@
+import{_ as c,W as u,X as r,Y as a,$ as n,a0 as s,Z as p,a1 as t,D as i}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"pwa",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#pwa","aria-hidden":"true"},"#"),s(" pwa")],-1),v={href:"https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps",target:"_blank",rel:"noopener noreferrer"},m={href:"https://developers.google.com/web/tools/workbox/modules/workbox-build",target:"_blank",rel:"noopener noreferrer"},h={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},g=t(`
But if you omit skipWaiting or set it to false, you have to activate the new service worker manually:
`,3),D=n("li",null,[s("For developers, you can use our "),n("a",{href:"#composition-api"},"composition API"),s(" to take control of the service worker behavior.")],-1),V=n("h3",{id:"serviceworkerfilename",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#serviceworkerfilename","aria-hidden":"true"},"#"),s(" serviceWorkerFilename")],-1),F=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),z=n("li",null,[n("p",null,[s("Default: "),n("code",null,"'service-worker.js'")])],-1),B=n("p",null,"Details:",-1),I=n("p",null,[s("The service worker file will only be generated in "),n("code",null,"build"),s(" mode.")],-1),N=n("h2",{id:"composition-api",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#composition-api","aria-hidden":"true"},"#"),s(" Composition API")],-1),C=n("h3",{id:"usepwaevent",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#usepwaevent","aria-hidden":"true"},"#"),s(" usePwaEvent")],-1),M=n("p",null,"Details:",-1),U=n("p",null,"Returns the event emitter of this plugin.",-1),j={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},G=n("li",null,[n("p",null,"Example:")],-1),L=t(`
import{ usePwaEvent, useSkipWaiting }from"@vuepress/plugin-pwa/client";
+
+exportdefault{
+ setup(){
+ const event =usePwaEvent();
+ event.on("updated",(registration)=>{
+ console.log("The waiting service worker is available.");
+ // activate the waiting service worker
+ useSkipWaiting(registration);
+ });
+ },
+};
+
`,1);function Z($,H){const l=i("NpmBadge"),e=i("ExternalLinkIcon"),o=i("RouterLink");return u(),r("div",null,[k,a(l,{package:"@vuepress/plugin-pwa"}),n("p",null,[s("Make your VuePress site a "),n("a",v,[s("Progressive Web Application (PWA)"),a(e)]),s(".")]),n("p",null,[s("This plugin uses "),n("a",m,[s("workbox-build"),a(e)]),s(" to generate service worker file, and uses "),n("a",h,[s("register-service-worker"),a(e)]),s(" to register service worker.")]),g,n("p",null,[s("To make your website fully compliant with PWA, you need to create a "),n("a",b,[s("Web app manifests"),a(e)]),s(" file and set the icons, colors, etc. for your PWA.")]),n("p",null,[s("You need to put your manifest file and icons into the "),a(o,{to:"/guide/assets.html#public-files"},{default:p(()=>[s("public files directory")]),_:1}),s(". In the following example, we assume that you are using the default public directory "),f,s(".")]),_,n("div",w,[y,n("p",null,[s("Some tools can help to do that. For example, "),n("a",q,[s("Favicon Generator"),a(e)]),s(" would help you to generate icons together with a sample manifest file.")])]),x,n("p",null,[s("You also need to set some tags via "),a(o,{to:"/reference/config.html#head"},{default:p(()=>[s("head")]),_:1}),s(" option to "),n("a",W,[s("deploy the manifest"),a(e)]),s(":")]),P,n("p",null,[s("This plugin accepts all parameters of workbox-build's "),n("a",S,[s("generateSW method"),a(e)]),s(" in its options, except "),T,s(" and "),A,s(".")]),E,n("ul",null,[n("li",null,[s("For users, you can use our "),a(o,{to:"/reference/plugin/pwa-popup.html"},{default:p(()=>[s("pwa-popup")]),_:1}),s(" plugin together.")]),D]),V,n("ul",null,[F,z,n("li",null,[B,n("p",null,[s("File path of the generated service worker file, which is relative to the "),a(o,{to:"/reference/config.html#dest"},{default:p(()=>[s("dest")]),_:1}),s(" directory.")]),I])]),N,C,n("ul",null,[n("li",null,[M,U,n("p",null,[s("You can add listener function to events that provided by "),n("a",j,[s("register-service-worker"),a(e)]),s(".")])]),G]),L,n("ul",null,[n("li",null,[R,n("p",null,[s("Call "),n("a",Y,[s("skipWaiting()"),a(e)]),s(" to activate the waiting service worker.")])]),O]),X])}const K=c(d,[["render",Z],["__file","pwa.html.vue"]]);export{K as default};
diff --git a/assets/pwa.html-80ca55ab.js b/assets/pwa.html-80ca55ab.js
new file mode 100644
index 00000000..3a14c87f
--- /dev/null
+++ b/assets/pwa.html-80ca55ab.js
@@ -0,0 +1,68 @@
+import{_ as l,W as u,X as r,Y as a,$ as n,a0 as s,Z as p,a1 as t,D as i}from"./framework-46b0e263.js";const d={},k=n("h1",{id:"pwa",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#pwa","aria-hidden":"true"},"#"),s(" pwa")],-1),v={href:"https://developer.mozilla.org/zh-CN/docs/Web/Progressive_web_apps",target:"_blank",rel:"noopener noreferrer"},m={href:"https://developers.google.com/web/tools/workbox/modules/workbox-build",target:"_blank",rel:"noopener noreferrer"},h={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},b=t(`
`,16),m=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string[]")])],-1),k=n("li",null,[n("p",null,[s("Default: "),n("code",null,"['**/*.vue']")])],-1),v=n("p",null,"Details:",-1),h={href:"https://github.com/sindresorhus/globby",target:"_blank",rel:"noopener noreferrer"},g=n("p",null,[s("The patterns are relative to "),n("a",{href:"#componentsdir"},"componentsDir"),s(".")],-1),b=t('
',2);function f(_,y){const p=e("NpmBadge"),o=e("ExternalLinkIcon");return c(),l("div",null,[r,a(p,{package:"@vuepress/plugin-register-components"}),d,n("ul",null,[k,m,n("li",null,[v,n("p",null,[s("使用 "),n("a",g,[s("globby"),a(o)]),s(" 来匹配组件文件的 Patterns 。")]),h])]),b])}const q=i(u,[["render",f],["__file","register-components.html.vue"]]);export{q as default};
diff --git a/assets/search.html-41912ea0.js b/assets/search.html-41912ea0.js
new file mode 100644
index 00000000..dedb55a1
--- /dev/null
+++ b/assets/search.html-41912ea0.js
@@ -0,0 +1,41 @@
+import{_ as c,W as u,X as r,Y as a,$ as n,a0 as s,Z as o,a1 as e,D as t}from"./framework-46b0e263.js";const d={},h=n("h1",{id:"search",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#search","aria-hidden":"true"},"#"),s(" search")],-1),k=e(`
Provide local search to your documentation site.
Tips
Default theme will add search box to the navbar once you configure this plugin correctly.
This plugin may not be used directly in other themes, so you'd better refer to the documentation of your theme for more details.
This plugin will generate search index from your pages locally, and load the search index file when users enter your site. In other words, this is a lightweight built-in search which does not require any external requests.
',3),g=n("li",null,[n("p",null,[s("Default: "),n("code",null,"['s', '/']")])],-1),b=n("p",null,"Details:",-1),f={href:"http://keycode.info/",target:"_blank",rel:"noopener noreferrer"},y=n("p",null,"When hotkeys are pressed, the search box input will be focused.",-1),x=n("p",null,"Set to an empty array to disable hotkeys.",-1),_=e(`
This plugin will register a <SearchBox /> component globally, and you can use it without any props.
Put this component to where you want to place the search box. For example, default theme puts this component to the end of the navbar.
Tips
This component is mainly used for theme development. You don't need to use it directly in most cases.
`,15);function w(q,S){const p=t("NpmBadge"),i=t("RouterLink"),l=t("ExternalLinkIcon");return u(),r("div",null,[h,a(p,{package:"@vuepress/plugin-search"}),k,n("p",null,[s("However, when your site has a large number of pages, the size of search index file would be very large, which could slow down the page loading speed. In this case, we recommend you to use a more professional solution - "),a(i,{to:"/reference/plugin/docsearch.html"},{default:o(()=>[s("docsearch")]),_:1}),s(".")]),v,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[a(i,{to:"/guide/i18n.html"},{default:o(()=>[s("Guide > I18n")]),_:1})])])])]),m,n("ul",null,[g,n("li",null,[b,n("p",null,[s("Specify the "),n("a",f,[s("event.key"),a(l)]),s(" of the hotkeys.")]),y,x])]),_])}const D=c(d,[["render",w],["__file","search.html.vue"]]);export{D as default};
diff --git a/assets/search.html-52d32298.js b/assets/search.html-52d32298.js
new file mode 100644
index 00000000..2f47a7a0
--- /dev/null
+++ b/assets/search.html-52d32298.js
@@ -0,0 +1,41 @@
+import{_ as o,W as u,X as r,Y as a,$ as n,a0 as s,Z as i,a1 as e,D as t}from"./framework-46b0e263.js";const d={},h=n("h1",{id:"search",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#search","aria-hidden":"true"},"#"),s(" search")],-1),k=e(`
`,15);function q(w,S){const l=t("NpmBadge"),p=t("RouterLink"),c=t("ExternalLinkIcon");return u(),r("div",null,[h,a(l,{package:"@vuepress/plugin-search"}),k,n("p",null,[s("然而，当你的站点包含大量页面时，搜索索引文件也会变得非常大，它可能会拖慢你的页面加载速度。在这种情况下，我们建议你使用更成熟的解决方案 - "),a(p,{to:"/zh/reference/plugin/docsearch.html"},{default:i(()=>[s("docsearch")]),_:1}),s(" 。")]),v,n("ul",null,[n("li",null,[s("参考： "),n("ul",null,[n("li",null,[a(p,{to:"/zh/guide/i18n.html"},{default:i(()=>[s("指南 > 多语言支持")]),_:1})])])])]),m,n("ul",null,[g,n("li",null,[b,n("p",null,[s("指定热键的 "),n("a",f,[s("event.key"),a(c)]),s(" 。")]),x,_])]),y])}const B=o(d,[["render",q],["__file","search.html.vue"]]);export{B as default};
diff --git a/assets/search.html-61d47ae9.js b/assets/search.html-61d47ae9.js
new file mode 100644
index 00000000..9cdb4990
--- /dev/null
+++ b/assets/search.html-61d47ae9.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-42d1e5c1","path":"/zh/reference/plugin/search.html","title":"search","lang":"zh-CN","frontmatter":{"description":"为你的文档网站提供本地搜索能力。 当你正确配置该插件后，默认主题会把搜索框添加到导航栏。 该插件不一定能在其他主题中直接使用，因此你应参考主题本身的文档来获取更多信息。 使用方法 本地搜索索引 该插件会根据你的页面，在本地生成搜索索引，然后在用户访问站点时加载搜索索引文件。换句话说，这是一个轻量级的内置搜索能力，不会进行任何外部请求。 然而，当你的站点...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/search.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/search.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"search"}],["meta",{"property":"og:description","content":"为你的文档网站提供本地搜索能力。 当你正确配置该插件后，默认主题会把搜索框添加到导航栏。 该插件不一定能在其他主题中直接使用，因此你应参考主题本身的文档来获取更多信息。 使用方法 本地搜索索引 该插件会根据你的页面，在本地生成搜索索引，然后在用户访问站点时加载搜索索引文件。换句话说，这是一个轻量级的内置搜索能力，不会进行任何外部请求。 然而，当你的站点..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"search\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"本地搜索索引","slug":"本地搜索索引","link":"#本地搜索索引","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]},{"level":3,"title":"hotKeys","slug":"hotkeys","link":"#hotkeys","children":[]},{"level":3,"title":"maxSuggestions","slug":"maxsuggestions","link":"#maxsuggestions","children":[]},{"level":3,"title":"isSearchable","slug":"issearchable","link":"#issearchable","children":[]},{"level":3,"title":"getExtraFields","slug":"getextrafields","link":"#getextrafields","children":[]}]},{"level":2,"title":"样式","slug":"样式","link":"#样式","children":[]},{"level":2,"title":"组件","slug":"组件","link":"#组件","children":[{"level":3,"title":"SearchBox","slug":"searchbox","link":"#searchbox","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.34,"words":701},"filePathRelative":"zh/reference/plugin/search.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/search.html-c7cf299c.js b/assets/search.html-c7cf299c.js
new file mode 100644
index 00000000..232c8f12
--- /dev/null
+++ b/assets/search.html-c7cf299c.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-260e1012","path":"/reference/plugin/search.html","title":"search","lang":"en-US","frontmatter":{"description":"Provide local search to your documentation site. Default theme will add search box to the navbar once you configure this plugin correctly. This plugin may not be used directly i...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/search.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/search.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"search"}],["meta",{"property":"og:description","content":"Provide local search to your documentation site. Default theme will add search box to the navbar once you configure this plugin correctly. This plugin may not be used directly 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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"search\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Local Search Index","slug":"local-search-index","link":"#local-search-index","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]},{"level":3,"title":"hotKeys","slug":"hotkeys","link":"#hotkeys","children":[]},{"level":3,"title":"maxSuggestions","slug":"maxsuggestions","link":"#maxsuggestions","children":[]},{"level":3,"title":"isSearchable","slug":"issearchable","link":"#issearchable","children":[]},{"level":3,"title":"getExtraFields","slug":"getextrafields","link":"#getextrafields","children":[]}]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]},{"level":2,"title":"Components","slug":"components","link":"#components","children":[{"level":3,"title":"SearchBox","slug":"searchbox","link":"#searchbox","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.57,"words":470},"filePathRelative":"reference/plugin/search.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/shiki.html-c91adaea.js b/assets/shiki.html-c91adaea.js
new file mode 100644
index 00000000..22c741fe
--- /dev/null
+++ b/assets/shiki.html-c91adaea.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-bb2079f4","path":"/reference/plugin/shiki.html","title":"shiki","lang":"en-US","frontmatter":{"description":"This plugin will enable syntax highlighting for markdown code fence with Shiki (https://shiki.matsu.io/). Shiki (https://shiki.matsu.io/) is the syntax highlighter being used by...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/shiki.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/shiki.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"shiki"}],["meta",{"property":"og:description","content":"This plugin will enable syntax highlighting for markdown code fence with Shiki (https://shiki.matsu.io/). Shiki (https://shiki.matsu.io/) is the syntax highlighter being used 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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"shiki\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"theme","slug":"theme","link":"#theme","children":[]},{"level":3,"title":"langs","slug":"langs","link":"#langs","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.53,"words":158},"filePathRelative":"reference/plugin/shiki.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/shiki.html-d52b252b.js b/assets/shiki.html-d52b252b.js
new file mode 100644
index 00000000..b69f60a0
--- /dev/null
+++ b/assets/shiki.html-d52b252b.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-7a12fb77","path":"/zh/reference/plugin/shiki.html","title":"shiki","lang":"zh-CN","frontmatter":{"description":"该插件使用 Shiki (https://shiki.matsu.io/) 来为 Markdown 代码块启用代码高亮。 Shiki (https://shiki.matsu.io/) 是 VSCode 正在使用的代码高亮器。它具有更高的保真度，但比 Prism.js (https://prismjs.com/) 要慢一些，特别是在有大量代码块需要处理...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/shiki.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/shiki.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"shiki"}],["meta",{"property":"og:description","content":"该插件使用 Shiki (https://shiki.matsu.io/) 来为 Markdown 代码块启用代码高亮。 Shiki (https://shiki.matsu.io/) 是 VSCode 正在使用的代码高亮器。它具有更高的保真度，但比 Prism.js (https://prismjs.com/) 要慢一些，特别是在有大量代码块需要处理..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"shiki\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"theme","slug":"theme","link":"#theme","children":[]},{"level":3,"title":"langs","slug":"langs","link":"#langs","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.79,"words":236},"filePathRelative":"zh/reference/plugin/shiki.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/shiki.html-d54efc8e.js b/assets/shiki.html-d54efc8e.js
new file mode 100644
index 00000000..f4f62ecb
--- /dev/null
+++ b/assets/shiki.html-d54efc8e.js
@@ -0,0 +1,11 @@
+import{_ as l,W as r,X as c,Y as s,$ as n,a0 as e,a1 as i,D as t}from"./framework-46b0e263.js";const p={},d=n("h1",{id:"shiki",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#shiki","aria-hidden":"true"},"#"),e(" shiki")],-1),h={href:"https://shiki.matsu.io/",target:"_blank",rel:"noopener noreferrer"},u={class:"hint-container tip"},k=n("p",{class:"hint-container-title"},"提示",-1),_={href:"https://shiki.matsu.io/",target:"_blank",rel:"noopener noreferrer"},m={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},g=n("p",null,[e("你可以考虑在 "),n("code",null,"dev"),e(" 模式下禁用该插件来获取更好的开发体验。")],-1),v=i(`
",3),N=n("p",null,"参考：",-1),w={href:"https://github.com/shikijs/shiki/blob/master/docs/languages.md",target:"_blank",rel:"noopener noreferrer"};function B(V,j){const o=t("NpmBadge"),a=t("ExternalLinkIcon");return r(),c("div",null,[d,s(o,{package:"@vuepress/plugin-shiki"}),n("p",null,[e("该插件使用 "),n("a",h,[e("Shiki"),s(a)]),e(" 来为 Markdown 代码块启用代码高亮。")]),n("div",u,[k,n("p",null,[n("a",_,[e("Shiki"),s(a)]),e(" 是 VSCode 正在使用的代码高亮器。它具有更高的保真度，但比 "),n("a",m,[e("Prism.js"),s(a)]),e(" 要慢一些，特别是在有大量代码块需要处理的时候。")]),g]),v,n("ul",null,[b,n("li",null,[f,n("ul",null,[n("li",null,[n("a",x,[e("shiki > themes"),s(a)])])])])]),S,n("ul",null,[y,n("li",null,[N,n("ul",null,[n("li",null,[n("a",w,[e("shiki > languages"),s(a)])])])])])])}const L=l(p,[["render",B],["__file","shiki.html.vue"]]);export{L as default};
diff --git a/assets/shiki.html-e11165ea.js b/assets/shiki.html-e11165ea.js
new file mode 100644
index 00000000..02d29d65
--- /dev/null
+++ b/assets/shiki.html-e11165ea.js
@@ -0,0 +1,11 @@
+import{_ as l,W as r,X as p,Y as s,$ as e,a0 as n,a1 as i,D as t}from"./framework-46b0e263.js";const c={},d=e("h1",{id:"shiki",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#shiki","aria-hidden":"true"},"#"),n(" shiki")],-1),h={href:"https://shiki.matsu.io/",target:"_blank",rel:"noopener noreferrer"},u={class:"hint-container tip"},k=e("p",{class:"hint-container-title"},"Tips",-1),g={href:"https://shiki.matsu.io/",target:"_blank",rel:"noopener noreferrer"},m={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},_=e("p",null,[n("You could consider disabling this plugin in "),e("code",null,"dev"),n(" mode to get better development experience.")],-1),b=i(`
`,12);function h(v,_){const t=n("NpmBadge"),l=n("ExternalLinkIcon");return r(),d("div",null,[p,a(t,{package:"@vuepress/theme-default"}),s("p",null,[e("默认主题使用 "),s("a",u,[e("SASS"),a(l)]),e(" 作为 CSS 预处理器。")]),m])}const S=c(i,[["render",h],["__file","styles.html.vue"]]);export{S as default};
diff --git a/assets/styles.html-2c440e5c.js b/assets/styles.html-2c440e5c.js
new file mode 100644
index 00000000..4a88b646
--- /dev/null
+++ b/assets/styles.html-2c440e5c.js
@@ -0,0 +1,4 @@
+import{_ as i,W as r,X as d,Y as a,$ as s,a0 as e,a1 as o,D as t}from"./framework-46b0e263.js";const c={},p=s("h1",{id:"styles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#styles","aria-hidden":"true"},"#"),e(" Styles")],-1),u={href:"https://sass-lang.com/",target:"_blank",rel:"noopener noreferrer"},h=o(`
Users can customize style variables via a palette file, and add extra styles via a style file.
All of the Theme API of the parent theme will be inherited, but the child theme will not override the parent theme directly. Theme specific options will override according to following rules:
plugins: When a same plugin is used in both child and parent theme, if the plugin does not support to be used multiple times, only the one used in the child theme will take effect.
Multi-level inheritance is supported, i.e. theme B could be extended from theme A, and then theme C could be extended from theme B. In other words, a theme could have a parent theme, a grandparent theme and so on.
`,10),m=e("li",null,[e("p",null,[n("Type: "),e("code",null,"(Plugin | Plugin[])[]")])],-1),f=e("li",null,[e("p",null,"Details:"),e("p",null,"Plugins to use in the theme.")],-1),_=e("p",null,"Also see:",-1),v=e("h3",{id:"templatebuild",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#templatebuild","aria-hidden":"true"},"#"),n(" templateBuild")],-1),k=e("li",null,[e("p",null,[n("Type: "),e("code",null,"string")])],-1),g=e("p",null,"Details:",-1),b=e("p",null,"Specify the HTML template for build.",-1),w=e("p",null,"Also see:",-1),x=e("h3",{id:"templatedev",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#templatedev","aria-hidden":"true"},"#"),n(" templateDev")],-1),y=e("li",null,[e("p",null,[n("Type: "),e("code",null,"string")])],-1),T=e("p",null,"Details:",-1),D=e("p",null,"Specify the HTML template for dev.",-1),A=e("p",null,"Also see:",-1);function B(P,I){const i=s("NpmBadge"),a=s("RouterLink");return p(),u("div",null,[r,t(i,{package:"@vuepress/core"}),e("p",null,[n("VuePress theme also works as a plugin, so Theme API can accept all the options of "),t(a,{to:"/reference/plugin-api.html"},{default:l(()=>[n("Plugin API")]),_:1}),n(" with following differences.")]),h,e("ul",null,[m,f,e("li",null,[_,e("ul",null,[e("li",null,[t(a,{to:"/reference/config.html#plugins"},{default:l(()=>[n("Config > plugins")]),_:1})])])])]),v,e("ul",null,[k,e("li",null,[g,b,e("p",null,[n("It would override the default value of "),t(a,{to:"/reference/config.html#templatebuild"},{default:l(()=>[n("templateBuild")]),_:1}),n(", but could be overridden by user config.")])]),e("li",null,[w,e("ul",null,[e("li",null,[t(a,{to:"/reference/config.html#templatebuild"},{default:l(()=>[n("Config > templateBuild")]),_:1})])])])]),x,e("ul",null,[y,e("li",null,[T,D,e("p",null,[n("It would override the default value of "),t(a,{to:"/reference/config.html#templatedev"},{default:l(()=>[n("templateDev")]),_:1}),n(", but could be overridden by user config.")])]),e("li",null,[A,e("ul",null,[e("li",null,[t(a,{to:"/reference/config.html#templatedev"},{default:l(()=>[n("Config > templateDev")]),_:1})])])])])])}const C=o(c,[["render",B],["__file","theme-api.html.vue"]]);export{C as default};
diff --git a/assets/theme-api.html-a169223d.js b/assets/theme-api.html-a169223d.js
new file mode 100644
index 00000000..8ed84f22
--- /dev/null
+++ b/assets/theme-api.html-a169223d.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6b76c1c0","path":"/reference/theme-api.html","title":"Theme API","lang":"en-US","frontmatter":{"icon":"fa6-solid:palette","description":"VuePress theme also works as a plugin, so Theme API can accept all the options of Plugin API (./plugin-api.md) with following differences. Basic Options name Type: string; Detai...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/theme-api.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/theme-api.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Theme API"}],["meta",{"property":"og:description","content":"VuePress theme also works as a plugin, so Theme API can accept all the options of Plugin API (./plugin-api.md) with following differences. Basic Options name Type: string; Detai..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Theme API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Basic Options","slug":"basic-options","link":"#basic-options","children":[{"level":3,"title":"name","slug":"name","link":"#name","children":[]},{"level":3,"title":"multiple","slug":"multiple","link":"#multiple","children":[]}]},{"level":2,"title":"Theme Specific Options","slug":"theme-specific-options","link":"#theme-specific-options","children":[{"level":3,"title":"extends","slug":"extends","link":"#extends","children":[]},{"level":3,"title":"plugins","slug":"plugins","link":"#plugins","children":[]},{"level":3,"title":"templateBuild","slug":"templatebuild","link":"#templatebuild","children":[]},{"level":3,"title":"templateDev","slug":"templatedev","link":"#templatedev","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.13,"words":338},"filePathRelative":"reference/theme-api.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/theme-api.html-b6aae4d8.js b/assets/theme-api.html-b6aae4d8.js
new file mode 100644
index 00000000..727b201c
--- /dev/null
+++ b/assets/theme-api.html-b6aae4d8.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-49a27222","path":"/zh/reference/theme-api.html","title":"主题 API","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:palette","description":"VuePress 主题同样是一个插件，因此主题 API 可以接收 插件 API (./plugin-api.md) 的所有选项，但存在以下差别： 基础配置项 name 类型： string; 详情：; 主题的名称。 它应遵从如下命名约定，并且在发布到 NPM 时应确保和包名保持一致： 非 Scoped: vuepress-theme-foo; Scop...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/theme-api.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/theme-api.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"主题 API"}],["meta",{"property":"og:description","content":"VuePress 主题同样是一个插件，因此主题 API 可以接收 插件 API (./plugin-api.md) 的所有选项，但存在以下差别： 基础配置项 name 类型： string; 详情：; 主题的名称。 它应遵从如下命名约定，并且在发布到 NPM 时应确保和包名保持一致： 非 Scoped: vuepress-theme-foo; Scop..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"主题 API\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"基础配置项","slug":"基础配置项","link":"#基础配置项","children":[{"level":3,"title":"name","slug":"name","link":"#name","children":[]},{"level":3,"title":"multiple","slug":"multiple","link":"#multiple","children":[]}]},{"level":2,"title":"主题特定配置项","slug":"主题特定配置项","link":"#主题特定配置项","children":[{"level":3,"title":"extends","slug":"extends","link":"#extends","children":[]},{"level":3,"title":"plugins","slug":"plugins","link":"#plugins","children":[]},{"level":3,"title":"templateBuild","slug":"templatebuild","link":"#templatebuild","children":[]},{"level":3,"title":"templateDev","slug":"templatedev","link":"#templatedev","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.56,"words":468},"filePathRelative":"zh/reference/theme-api.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/theme-api.html-c8d9fb01.js b/assets/theme-api.html-c8d9fb01.js
new file mode 100644
index 00000000..6212a747
--- /dev/null
+++ b/assets/theme-api.html-c8d9fb01.js
@@ -0,0 +1,10 @@
+import{_ as p,W as o,X as u,Y as a,$ as e,a0 as n,Z as l,a1 as c,D as t}from"./framework-46b0e263.js";const d={},r=e("h1",{id:"主题-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#主题-api","aria-hidden":"true"},"#"),n(" 主题 API")],-1),h=c(`
`,10),m=e("li",null,[e("p",null,[n("类型： "),e("code",null,"(Plugin | Plugin[])[]")])],-1),_=e("li",null,[e("p",null,"详情："),e("p",null,"主题中要使用的插件。")],-1),k=e("p",null,"参考：",-1),f=e("h3",{id:"templatebuild",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#templatebuild","aria-hidden":"true"},"#"),n(" templateBuild")],-1),v=e("li",null,[e("p",null,[n("类型： "),e("code",null,"string")])],-1),g=e("p",null,"详情：",-1),b=e("p",null,"指定构建时使用的 HTML 模板。",-1),x=e("p",null,"参考：",-1),y=e("h3",{id:"templatedev",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#templatedev","aria-hidden":"true"},"#"),n(" templateDev")],-1),B=e("li",null,[e("p",null,[n("类型： "),e("code",null,"string")])],-1),w=e("p",null,"详情：",-1),P=e("p",null,"指定开发时使用的 HTML 模板。",-1),A=e("p",null,"参考：",-1);function D(N,z){const i=t("NpmBadge"),s=t("RouterLink");return o(),u("div",null,[r,a(i,{package:"@vuepress/core"}),e("p",null,[n("VuePress 主题同样是一个插件，因此主题 API 可以接收 "),a(s,{to:"/zh/reference/plugin-api.html"},{default:l(()=>[n("插件 API")]),_:1}),n(" 的所有选项，但存在以下差别：")]),h,e("ul",null,[m,_,e("li",null,[k,e("ul",null,[e("li",null,[a(s,{to:"/zh/reference/config.html#plugins"},{default:l(()=>[n("配置 > plugins")]),_:1})])])])]),f,e("ul",null,[v,e("li",null,[g,b,e("p",null,[n("它会覆盖 "),a(s,{to:"/zh/reference/config.html#templatebuild"},{default:l(()=>[n("templateBuild")]),_:1}),n(" 的默认值，但是也会被用户配置覆盖。")])]),e("li",null,[x,e("ul",null,[e("li",null,[a(s,{to:"/zh/reference/config.html#templatebuild"},{default:l(()=>[n("配置 > templateBuild")]),_:1})])])])]),y,e("ul",null,[B,e("li",null,[w,P,e("p",null,[n("它会覆盖 "),a(s,{to:"/zh/reference/config.html#templatedev"},{default:l(()=>[n("templateDev")]),_:1}),n(" 的默认值，但是也会被用户配置覆盖。")])]),e("li",null,[A,e("ul",null,[e("li",null,[a(s,{to:"/zh/reference/config.html#templatedev"},{default:l(()=>[n("配置 > templateDev")]),_:1})])])])])])}const I=p(d,[["render",D],["__file","theme-api.html.vue"]]);export{I as default};
diff --git a/assets/theme-data.html-03afc4d1.js b/assets/theme-data.html-03afc4d1.js
new file mode 100644
index 00000000..32f0246d
--- /dev/null
+++ b/assets/theme-data.html-03afc4d1.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-411f140a","path":"/zh/reference/plugin/theme-data.html","title":"theme-data","lang":"zh-CN","frontmatter":{"description":"为你的主题提供客户端数据，包含 VuePress 的 多语言支持 (../../guide/i18n.md) 。 该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。 对于主题作者，该插件可以提供与 VuePress 及默认主题相同的多语言支持机制。但是如果你的主题不需要提供多语言支持，或者你想用你自己的方式来实现多语言支...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/theme-data.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/theme-data.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"theme-data"}],["meta",{"property":"og:description","content":"为你的主题提供客户端数据，包含 VuePress 的 多语言支持 (../../guide/i18n.md) 。 该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。 对于主题作者，该插件可以提供与 VuePress 及默认主题相同的多语言支持机制。但是如果你的主题不需要提供多语言支持，或者你想用你自己的方式来实现多语言支..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"theme-data\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"themeData","slug":"themedata","link":"#themedata","children":[]}]},{"level":2,"title":"Composition API","slug":"composition-api","link":"#composition-api","children":[{"level":3,"title":"useThemeData","slug":"usethemedata","link":"#usethemedata","children":[]},{"level":3,"title":"useThemeLocaleData","slug":"usethemelocaledata","link":"#usethemelocaledata","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.49,"words":447},"filePathRelative":"zh/reference/plugin/theme-data.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/theme-data.html-2029f336.js b/assets/theme-data.html-2029f336.js
new file mode 100644
index 00000000..667c3453
--- /dev/null
+++ b/assets/theme-data.html-2029f336.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-18fd0fcc","path":"/reference/plugin/theme-data.html","title":"theme-data","lang":"en-US","frontmatter":{"description":"Provide client data for your theme, with VuePress i18n (../../guide/i18n.md) support. This plugin is mainly used to develop themes, and has been integrated into the default them...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/theme-data.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/theme-data.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"theme-data"}],["meta",{"property":"og:description","content":"Provide client data for your theme, with VuePress i18n (../../guide/i18n.md) support. This plugin is mainly used to develop themes, and has been integrated into the default them..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"theme-data\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"themeData","slug":"themedata","link":"#themedata","children":[]}]},{"level":2,"title":"Composition API","slug":"composition-api","link":"#composition-api","children":[{"level":3,"title":"useThemeData","slug":"usethemedata","link":"#usethemedata","children":[]},{"level":3,"title":"useThemeLocaleData","slug":"usethemelocaledata","link":"#usethemelocaledata","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.06,"words":319},"filePathRelative":"reference/plugin/theme-data.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/theme-data.html-71846647.js b/assets/theme-data.html-71846647.js
new file mode 100644
index 00000000..3d0d5cf9
--- /dev/null
+++ b/assets/theme-data.html-71846647.js
@@ -0,0 +1,51 @@
+import{_ as o,W as i,X as c,Y as s,$ as a,a0 as n,Z as l,a1 as u,D as e}from"./framework-46b0e263.js";const r={},d=a("h1",{id:"theme-data",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#theme-data","aria-hidden":"true"},"#"),n(" theme-data")],-1),k=u(`
This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
For theme authors, this plugin will help you to use the same i18n mechanism as VuePress and the default theme. But if you don't want to provide i18n support, or you want to implement in your own way, you don't need this plugin.
The theme data object will be processed by JSON.stringify() before forwarding to client side, so you should ensure that you are providing a JSON-friendly object.
`,17);function m(v,h){const t=e("NpmBadge"),p=e("RouterLink");return i(),c("div",null,[d,s(t,{package:"@vuepress/plugin-theme-data"}),a("p",null,[n("Provide client data for your theme, with VuePress "),s(p,{to:"/guide/i18n.html"},{default:l(()=>[n("i18n")]),_:1}),n(" support.")]),k])}const g=o(r,[["render",m],["__file","theme-data.html.vue"]]);export{g as default};
diff --git a/assets/theme-data.html-a62c4182.js b/assets/theme-data.html-a62c4182.js
new file mode 100644
index 00000000..b240641c
--- /dev/null
+++ b/assets/theme-data.html-a62c4182.js
@@ -0,0 +1,51 @@
+import{_ as o,W as c,X as i,Y as s,$ as a,a0 as n,Z as l,a1 as u,D as e}from"./framework-46b0e263.js";const r={},d=a("h1",{id:"theme-data",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#theme-data","aria-hidden":"true"},"#"),n(" theme-data")],-1),k=u(`
`,17);function m(v,h){const t=e("NpmBadge"),p=e("RouterLink");return c(),i("div",null,[d,s(t,{package:"@vuepress/plugin-theme-data"}),a("p",null,[n("为你的主题提供客户端数据，包含 VuePress 的 "),s(p,{to:"/zh/guide/i18n.html"},{default:l(()=>[n("多语言支持")]),_:1}),n(" 。")]),k])}const g=o(r,[["render",m],["__file","theme-data.html.vue"]]);export{g as default};
diff --git a/assets/theme.html-18dd2f4e.js b/assets/theme.html-18dd2f4e.js
new file mode 100644
index 00000000..a716c314
--- /dev/null
+++ b/assets/theme.html-18dd2f4e.js
@@ -0,0 +1,58 @@
+import{_ as i,W as l,X as u,$ as s,a0 as n,Y as a,Z as t,a1 as o,D as p}from"./framework-46b0e263.js";const d={},r=s("h1",{id:"writing-a-theme",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#writing-a-theme","aria-hidden":"true"},"#"),n(" Writing a Theme")],-1),k={class:"hint-container tip"},m=s("p",{class:"hint-container-title"},"Tips",-1),v=s("h2",{id:"create-a-theme",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-theme","aria-hidden":"true"},"#"),n(" Create a Theme")],-1),h=s("em",null,"Theme Object",-1),g=s("em",null,"Theme Function",-1),b=o(`
import{ getDirname, path }from"@vuepress/utils";
+
+const __dirname =getDirname(import.meta.url);
+
+constfooTheme=(options)=>{
+ // returns a theme object
+ return{
+ 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 from \`@vuepress/client\` will be used
+ templateBuild: path.resolve(__dirname,"templates/build.html"),
+ templateDev: path.resolve(__dirname,"templates/dev.html"),
+
+ // use plugins
+ plugins:[
+ // ...
+ ],
+
+ // other plugin APIs are also available
+ };
+};
+
+constbarTheme=(options)=>{
+ // returns a theme function
+ return(app)=>{
+ return{
+ name:"vuepress-theme-bar",
+ // ...
+ };
+ };
+};
+
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 NotFound layout will be used for the 404.html page:
<template>
+ <div>404 Not Found</div>
+</template>
+
`,3),y=s("h2",{id:"publish-to-npm",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#publish-to-npm","aria-hidden":"true"},"#"),n(" Publish to NPM")],-1),w={href:"https://docs.npmjs.com/cli/v8/configuring-npm/package-json",target:"_blank",rel:"noopener noreferrer"},q=o(`
`,1),x=s("code",null,"name",-1),T=s("code",null,"vuepress-theme-xxx",-1),N=s("code",null,"@org/vuepress-theme-xxx",-1),j=s("em",null,"Theme Object",-1),C=s("li",null,[n("Set "),s("code",null,"keywords"),n(" to include "),s("code",null,"vuepress-theme"),n(", so that users can search your theme on NPM.")],-1);function L(F,P){const e=p("RouterLink"),c=p("ExternalLinkIcon");return l(),u("div",null,[r,s("div",k,[m,s("p",null,[n("Before reading this guide, you'd better learn the guide of "),a(e,{to:"/advanced/plugin.html"},{default:t(()=>[n("Writing a Plugin")]),_:1}),n(" first.")])]),v,s("p",null,[n("A VuePress theme is a special plugin, which should satisfy the "),a(e,{to:"/reference/theme-api.html"},{default:t(()=>[n("Theme API")]),_:1}),n(". Like plugins, a theme should also be a "),h,n(" or a "),g,n(", and could be wrapped with a function to receive options:")]),b,s("p",null,[n("The "),f,n(" layout should contain the "),a(e,{to:"/reference/components.html#content"},{default:t(()=>[n("Content")]),_:1}),n(" component to display the markdown content:")]),_,s("p",null,[n("You can provide more layouts, and users can change layout via "),a(e,{to:"/reference/frontmatter.html#layout"},{default:t(()=>[n("layout")]),_:1}),n(" frontmatter.")]),y,s("p",null,[n("Also, there are some conventions for theme in "),s("a",w,[n("package.json"),a(c)]),n(":")]),q,s("ul",null,[s("li",null,[n("Set "),x,n(" to follow the naming convention: "),T,n(" or "),N,n(", which should be consistent with the "),a(e,{to:"/reference/theme-api.html#name"},{default:t(()=>[n("name")]),_:1}),n(" field of the "),j,n(".")]),C])])}const B=i(d,[["render",L],["__file","theme.html.vue"]]);export{B as default};
diff --git a/assets/theme.html-2c740ba6.js b/assets/theme.html-2c740ba6.js
new file mode 100644
index 00000000..b0be76ef
--- /dev/null
+++ b/assets/theme.html-2c740ba6.js
@@ -0,0 +1,14 @@
+import{_ as p,W as i,X as l,$ as n,a0 as s,Y as e,Z as t,a1 as r,D as o}from"./framework-46b0e263.js";const u={},d=n("h1",{id:"主题",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#主题","aria-hidden":"true"},"#"),s(" 主题")],-1),h=n("p",null,"VuePress 主题为你提供了布局、样式和其他功能，帮助你专注于 Markdown 内容的写作。",-1),k=n("h2",{id:"默认主题",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#默认主题","aria-hidden":"true"},"#"),s(" 默认主题")],-1),m=n("p",null,"VuePress 有一个开箱即用的默认主题，正使用在你当前正在浏览的文档网站上。",-1),_=n("p",null,"如果你不指定要使用的主题，那么就会自动使用默认主题。",-1),v=r(`
`,1),f=n("p",null,"然而，你可能觉得默认主题不够出色，又或者你不想搭建一个文档网站，而是一个其他类型的网站，比如博客。此时，你可以尝试使用社区主题或者创建本地主题。",-1),b=n("h2",{id:"社区主题",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#社区主题","aria-hidden":"true"},"#"),s(" 社区主题")],-1),x={href:"https://www.npmjs.com/search?q=keywords:vuepress-theme",target:"_blank",rel:"noopener noreferrer"},g=n("h2",{id:"本地主题",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#本地主题","aria-hidden":"true"},"#"),s(" 本地主题")],-1);function w(q,y){const a=o("RouterLink"),c=o("ExternalLinkIcon");return i(),l("div",null,[d,h,k,m,_,n("p",null,[s("为了配置默认主题，你需要在你的配置文件中通过 "),e(a,{to:"/zh/reference/config.html#theme"},{default:t(()=>[s("theme")]),_:1}),s(" 配置项来使用它：")]),v,n("p",null,[s("默认主题为文档网站提供了基础且实用的功能，你可以前往 "),e(a,{to:"/zh/reference/default-theme/config.html"},{default:t(()=>[s("默认主题配置参考")]),_:1}),s(" 获取全部的配置列表。")]),f,b,n("p",null,[s("社区用户创建了很多主题，并将它们发布到了 "),n("a",x,[s("NPM"),e(c)]),s(" 上。查看主题本身的文档可以获取更详细的指引。")]),g,n("p",null,[s("如果你想要使用自己的自定义主题，但是又不想发布它，你可以创建一个本地主题。前往 "),e(a,{to:"/zh/advanced/theme.html"},{default:t(()=>[s("深入 > 开发主题")]),_:1}),s(" 学习如何开发你自己的主题。")])])}const N=p(u,[["render",w],["__file","theme.html.vue"]]);export{N as default};
diff --git a/assets/theme.html-3d462c1b.js b/assets/theme.html-3d462c1b.js
new file mode 100644
index 00000000..3cd76efa
--- /dev/null
+++ b/assets/theme.html-3d462c1b.js
@@ -0,0 +1,14 @@
+import{_ as c,W as u,X as l,$ as e,a0 as n,Y as t,Z as s,a1 as r,D as o}from"./framework-46b0e263.js";const p={},d=e("h1",{id:"theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme","aria-hidden":"true"},"#"),n(" Theme")],-1),h=e("p",null,"VuePress theme can provide layouts, styles and many other features for you, helping you to focus on writing Markdown content.",-1),m=e("h2",{id:"default-theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#default-theme","aria-hidden":"true"},"#"),n(" Default Theme")],-1),f=e("p",null,"VuePress has a default theme out of the box, which is applied to our documentation site you are currently browsing.",-1),k=e("p",null,"If you don't specify the theme to use, the default theme will be used automatically.",-1),v=r(`
`,1),_=e("p",null,"However, you might think it is not good enough. Or, you want to build a different type of site, for example, a blog, instead of a documentation. Then, you can try to use a community theme or create a local theme.",-1),y=e("h2",{id:"community-theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#community-theme","aria-hidden":"true"},"#"),n(" Community Theme")],-1),b={href:"https://www.npmjs.com/search?q=keywords:vuepress-theme",target:"_blank",rel:"noopener noreferrer"},g=e("h2",{id:"local-theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#local-theme","aria-hidden":"true"},"#"),n(" Local Theme")],-1);function w(x,T){const a=o("RouterLink"),i=o("ExternalLinkIcon");return u(),l("div",null,[d,h,m,f,k,e("p",null,[n("To configure the default theme, you need to import and use it in your config file via the "),t(a,{to:"/reference/config.html#theme"},{default:s(()=>[n("theme")]),_:1}),n(" option:")]),v,e("p",null,[n("The default theme provides basic but useful features for documentation site, you can check out "),t(a,{to:"/reference/default-theme/config.html"},{default:s(()=>[n("Default Theme Config Reference")]),_:1}),n(" for a full list of config.")]),_,y,e("p",null,[n("Community users have created lots of theme and published them to "),e("a",b,[n("NPM"),t(i)]),n(". You should check the theme's own documentation for detailed guide.")]),g,e("p",null,[n("If you want to use your own custom theme but don't want to publish it, you can create a local theme. Refer to "),t(a,{to:"/advanced/theme.html"},{default:s(()=>[n("Advanced > Writing a Theme")]),_:1}),n(" for how to write your own theme.")])])}const V=c(p,[["render",w],["__file","theme.html.vue"]]);export{V as default};
diff --git a/assets/theme.html-6daccb0c.js b/assets/theme.html-6daccb0c.js
new file mode 100644
index 00000000..02c145a3
--- /dev/null
+++ b/assets/theme.html-6daccb0c.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-2efcb26a","path":"/zh/guide/theme.html","title":"主题","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:palette","description":"VuePress 主题为你提供了布局、样式和其他功能，帮助你专注于 Markdown 内容的写作。 默认主题 VuePress 有一个开箱即用的默认主题，正使用在你当前正在浏览的文档网站上。 如果你不指定要使用的主题，那么就会自动使用默认主题。 为了配置默认主题，你需要在你的配置文件中通过 theme (../reference/config.md#t...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/guide/theme.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/guide/theme.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"主题"}],["meta",{"property":"og:description","content":"VuePress 主题为你提供了布局、样式和其他功能，帮助你专注于 Markdown 内容的写作。 默认主题 VuePress 有一个开箱即用的默认主题，正使用在你当前正在浏览的文档网站上。 如果你不指定要使用的主题，那么就会自动使用默认主题。 为了配置默认主题，你需要在你的配置文件中通过 theme (../reference/config.md#t..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"主题\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"默认主题","slug":"默认主题","link":"#默认主题","children":[]},{"level":2,"title":"社区主题","slug":"社区主题","link":"#社区主题","children":[]},{"level":2,"title":"本地主题","slug":"本地主题","link":"#本地主题","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.25,"words":375},"filePathRelative":"zh/guide/theme.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/theme.html-c65f5d90.js b/assets/theme.html-c65f5d90.js
new file mode 100644
index 00000000..0e7ce943
--- /dev/null
+++ b/assets/theme.html-c65f5d90.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4d76029c","path":"/guide/theme.html","title":"Theme","lang":"en-US","frontmatter":{"icon":"fa6-solid:palette","description":"VuePress theme can provide layouts, styles and many other features for you, helping you to focus on writing Markdown content. Default Theme VuePress has a default theme out of t...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/guide/theme.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/guide/theme.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Theme"}],["meta",{"property":"og:description","content":"VuePress theme can provide layouts, styles and many other features for you, helping you to focus on writing Markdown content. Default Theme VuePress has a default theme out of t..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Theme\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Default Theme","slug":"default-theme","link":"#default-theme","children":[]},{"level":2,"title":"Community Theme","slug":"community-theme","link":"#community-theme","children":[]},{"level":2,"title":"Local Theme","slug":"local-theme","link":"#local-theme","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.84,"words":252},"filePathRelative":"guide/theme.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/theme.html-cacc09fb.js b/assets/theme.html-cacc09fb.js
new file mode 100644
index 00000000..9ef08429
--- /dev/null
+++ b/assets/theme.html-cacc09fb.js
@@ -0,0 +1 @@
+const e=JSON.parse(`{"key":"v-06329db8","path":"/advanced/theme.html","title":"Writing a Theme","lang":"en-US","frontmatter":{"icon":"fa6-solid:palette","description":"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 Th...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/theme.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/theme.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Writing a Theme"}],["meta",{"property":"og:description","content":"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 Th..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Writing a Theme\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Create a Theme","slug":"create-a-theme","link":"#create-a-theme","children":[]},{"level":2,"title":"Publish to NPM","slug":"publish-to-npm","link":"#publish-to-npm","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.26,"words":379},"filePathRelative":"advanced/theme.md","localizedDate":"February 22, 2023","autoDesc":true}`);export{e as data};
diff --git a/assets/theme.html-cb66f31b.js b/assets/theme.html-cb66f31b.js
new file mode 100644
index 00000000..75e2b271
--- /dev/null
+++ b/assets/theme.html-cb66f31b.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-66c42ad6","path":"/zh/advanced/theme.html","title":"开发主题","lang":"zh-CN","frontmatter":{"icon":"fa6-solid:palette","description":"在阅读该指南之前，你最好先了解一下 开发插件 (./plugin.md) 指南。 创建一个主题 VuePress 主题是一个特殊的插件，它应该符合 主题 API (../reference/theme-api.md) 。和插件一样，主题可以是一个 主题对象 或一个 主题函数 ，并且通常通过一个函数来接收配置项： 然后，创建主题的客户端配置文件 clie...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/advanced/theme.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/advanced/theme.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"开发主题"}],["meta",{"property":"og:description","content":"在阅读该指南之前，你最好先了解一下 开发插件 (./plugin.md) 指南。 创建一个主题 VuePress 主题是一个特殊的插件，它应该符合 主题 API (../reference/theme-api.md) 。和插件一样，主题可以是一个 主题对象 或一个 主题函数 ，并且通常通过一个函数来接收配置项： 然后，创建主题的客户端配置文件 clie..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"开发主题\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"创建一个主题","slug":"创建一个主题","link":"#创建一个主题","children":[]},{"level":2,"title":"发布到 NPM","slug":"发布到-npm","link":"#发布到-npm","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.66,"words":497},"filePathRelative":"zh/advanced/theme.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/theme.html-ee0c13ce.js b/assets/theme.html-ee0c13ce.js
new file mode 100644
index 00000000..d993906e
--- /dev/null
+++ b/assets/theme.html-ee0c13ce.js
@@ -0,0 +1,58 @@
+import{_ as l,W as i,X as u,$ as s,a0 as n,Y as a,Z as e,a1 as o,D as p}from"./framework-46b0e263.js";const d={},r=s("h1",{id:"开发主题",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#开发主题","aria-hidden":"true"},"#"),n(" 开发主题")],-1),k={class:"hint-container tip"},v=s("p",{class:"hint-container-title"},"提示",-1),m=s("h2",{id:"创建一个主题",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#创建一个主题","aria-hidden":"true"},"#"),n(" 创建一个主题")],-1),b=s("em",null,"主题对象",-1),h=s("em",null,"主题函数",-1),g=o(`
`,20);function b(f,q){const l=o("NpmBadge"),t=o("RouterLink");return i(),u("div",null,[d,a(l,{package:"@vuepress/plugin-toc"}),k,s("p",null,[n("Similar to the "),a(t,{to:"/guide/markdown.html#table-of-contents"},{default:e(()=>[n("Table of Contents Markdown Syntax")]),_:1}),n(", the TOC component that provided by this plugin could be used in your markdown content directly:")]),v,s("p",null,[n("This plugin could work together with "),a(t,{to:"/reference/plugin/active-header-links.html"},{default:e(()=>[n("@vuepress/plugin-active-header-links")]),_:1}),n(" by setting the "),a(t,{to:"/reference/plugin/active-header-links.html#headerlinkselector"},{default:e(()=>[n("headerLinkSelector")]),_:1}),n(" to match the "),m,n(" option. When the page scroll to a certain header anchor, this corresponding link will be added "),g,n(" class name.")]),h])}const w=c(r,[["render",b],["__file","toc.html.vue"]]);export{w as default};
diff --git a/assets/toc.html-6a6abe62.js b/assets/toc.html-6a6abe62.js
new file mode 100644
index 00000000..ded4d99d
--- /dev/null
+++ b/assets/toc.html-6a6abe62.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-76709450","path":"/reference/plugin/toc.html","title":"toc","lang":"en-US","frontmatter":{"description":"This plugin will provide a table-of-contents (TOC) component. Usage Differences with Markdown TOC Syntax Similar to the Table of Contents Markdown Syntax (../../guide/markdown.m...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/plugin/toc.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/plugin/toc.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"toc"}],["meta",{"property":"og:description","content":"This plugin will provide a table-of-contents (TOC) component. Usage Differences with Markdown TOC Syntax Similar to the Table of Contents Markdown Syntax (../../guide/markdown.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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"toc\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Differences with Markdown TOC Syntax","slug":"differences-with-markdown-toc-syntax","link":"#differences-with-markdown-toc-syntax","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"componentName","slug":"componentname","link":"#componentname","children":[]},{"level":3,"title":"defaultPropsOptions","slug":"defaultpropsoptions","link":"#defaultpropsoptions","children":[]}]},{"level":2,"title":"Component Props","slug":"component-props","link":"#component-props","children":[{"level":3,"title":"headers","slug":"headers","link":"#headers","children":[]},{"level":3,"title":"options","slug":"options-1","link":"#options-1","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.59,"words":478},"filePathRelative":"reference/plugin/toc.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/toc.html-aac1b6d6.js b/assets/toc.html-aac1b6d6.js
new file mode 100644
index 00000000..4e1a8024
--- /dev/null
+++ b/assets/toc.html-aac1b6d6.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-048d95fe","path":"/zh/reference/plugin/toc.html","title":"toc","lang":"zh-CN","frontmatter":{"description":"该插件会提供一个目录 (table-of-contents, TOC) 组件。 使用方法 在 Build 模式中，它们都可以被正确地预渲染。然而，它们之间存在一些区别。 Markdown 语法 [[toc]] 仅能在 Markdown 文件中使用。它是由 markdown-it 解析的，生成的目录是静态内容。 组件 既可以用在 Markdown 文件中...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/plugin/toc.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/plugin/toc.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"toc"}],["meta",{"property":"og:description","content":"该插件会提供一个目录 (table-of-contents, TOC) 组件。 使用方法 在 Build 模式中，它们都可以被正确地预渲染。然而，它们之间存在一些区别。 Markdown 语法 [[toc]] 仅能在 Markdown 文件中使用。它是由 markdown-it 解析的，生成的目录是静态内容。 组件 既可以用在 Markdown 文件中..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"toc\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"componentName","slug":"componentname","link":"#componentname","children":[]},{"level":3,"title":"defaultPropsOptions","slug":"defaultpropsoptions","link":"#defaultpropsoptions","children":[]}]},{"level":2,"title":"组件 Props","slug":"组件-props","link":"#组件-props","children":[{"level":3,"title":"headers","slug":"headers","link":"#headers","children":[]},{"level":3,"title":"options","slug":"options","link":"#options","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.08,"words":625},"filePathRelative":"zh/reference/plugin/toc.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/toc.html-d4b62f4b.js b/assets/toc.html-d4b62f4b.js
new file mode 100644
index 00000000..d6204749
--- /dev/null
+++ b/assets/toc.html-d4b62f4b.js
@@ -0,0 +1,79 @@
+import{_ as c,W as i,X as u,Y as a,$ as s,a0 as n,Z as e,a1 as o,D as p}from"./framework-46b0e263.js";const r={},d=s("h1",{id:"toc",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#toc","aria-hidden":"true"},"#"),n(" toc")],-1),k=o(`
The enhance function could be either synchronous or asynchronous. It accepts a context param with following properties:
`,3),f=s("code",null,"app",-1),h={href:"https://vuejs.org/api/application.html#createapp",target:"_blank",rel:"noopener noreferrer"},g=s("code",null,"router",-1),b={href:"https://router.vuejs.org/api/#createrouter",target:"_blank",rel:"noopener noreferrer"},y=s("code",null,"siteData",-1),_=s("p",null,[n("The "),s("code",null,"enhance"),n(" function will be invoked after the client app is created. It's possible to implement any enhancements to the Vue application.")],-1),w=s("h3",{id:"register-vue-components",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#register-vue-components","aria-hidden":"true"},"#"),n(" Register Vue Components")],-1),C={href:"https://vuejs.org/api/application.html#app-component",target:"_blank",rel:"noopener noreferrer"},q=o(`
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.
`,3),V=s("code",null,"setup",-1),E={href:"https://vuejs.org/api/composition-api-setup.html",target:"_blank",rel:"noopener noreferrer"},P=s("h3",{id:"use-composition-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#use-composition-api","aria-hidden":"true"},"#"),n(" Use Composition API")],-1),j=s("code",null,"setup",-1),T={href:"https://vuejs.org/api/composition-api-setup.html",target:"_blank",rel:"noopener noreferrer"},U=o(`
import{ defineClientConfig }from"@vuepress/client";
+import{ provide, ref }from"vue";
+import{ useRoute, useRouter }from"vue-router";
+
+exportdefaultdefineClientConfig({
+ 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);
+ },
+});
+
`,5);function B(Y,G){const e=c("RouterLink"),p=c("ExternalLinkIcon");return u(),l("div",null,[d,s("p",null,[n("You can make use of the "),a(e,{to:"/guide/configuration.html#client-config-file"},{default:t(()=>[n("client config file")]),_:1}),n(" directly in your project, or specify the file path in your plugin or theme via "),a(e,{to:"/reference/plugin-api.html#clientconfigfile"},{default:t(()=>[n("clientConfigFile")]),_:1}),n(" hook:")]),k,s("p",null,[n("Inside the client config file, "),v,n(" package provides a helper function "),a(e,{to:"/reference/client-api.html#defineclientconfig"},{default:t(()=>[n("defineClientConfig")]),_:1}),n(" to help you define the client config:")]),m,s("ul",null,[s("li",null,[f,n(" is the Vue application instance that created by "),s("a",h,[n("createApp"),a(p)]),n(".")]),s("li",null,[g,n(" is the Vue Router instance that created by "),s("a",b,[n("createRouter"),a(p)]),n(".")]),s("li",null,[y,n(" is a ref of an object that generated from user config, including "),a(e,{to:"/reference/config.html#base"},{default:t(()=>[n("base")]),_:1}),n(", "),a(e,{to:"/reference/config.html#lang"},{default:t(()=>[n("lang")]),_:1}),n(", "),a(e,{to:"/reference/config.html#title"},{default:t(()=>[n("title")]),_:1}),n(", "),a(e,{to:"/reference/config.html#description"},{default:t(()=>[n("description")]),_:1}),n(", "),a(e,{to:"/reference/config.html#head"},{default:t(()=>[n("head")]),_:1}),n(" and "),a(e,{to:"/reference/config.html#locales"},{default:t(()=>[n("locales")]),_:1}),n(".")])]),_,w,s("p",null,[n("You can register global Vue components via the "),s("a",C,[n("app.component"),a(p)]),n(" method:")]),q,s("p",null,[n("We already provides a "),a(e,{to:"/reference/components.html#clientonly"},{default:t(()=>[n("ClientOnly")]),_:1}),n(" component to wrap non-SSR-friendly content.")]),s("p",null,[n("In the "),x,n(" function, you can make use of the "),a(e,{to:"/reference/client-api.html#ssr"},{default:t(()=>[S]),_:1}),n(" flag for that purpose.")]),R,s("p",null,[n("You can make use of the "),s("a",M,[n("Router Methods"),a(p)]),n(" that provided by vue-router. For example, add navigation guard:")]),I,s("p",null,[n("The "),V,n(" function would be invoked inside the "),s("a",E,[n("setup"),a(p)]),n(" hook of the client vue app.")]),P,s("p",null,[n("You can take the "),j,n(" function as part of the "),s("a",T,[n("setup"),a(p)]),n(" hook of the root component. Thus, all composition APIs are available here.")]),U,s("p",null,[n("In the "),F,n(" function, the "),a(e,{to:"/reference/client-api.html#ssr"},{default:t(()=>[N]),_:1}),n(" flag is also available.")]),s("p",null,[n("Another way to use non-ssr-friendly features is to put them inside the "),s("a",A,[n("onMounted"),a(p)]),n(" hook:")]),D,s("p",null,[n("The "),L,n(" options is to set layout components. After layout components are registered here, users can use it via "),a(e,{to:"/reference/frontmatter.html#layout"},{default:t(()=>[n("layout")]),_:1}),n(" frontmatter.")]),O])}const X=i(r,[["render",B],["__file","usage-of-client-config.html.vue"]]);export{X as default};
diff --git a/assets/usage-of-client-config.html-7ce03b78.js b/assets/usage-of-client-config.html-7ce03b78.js
new file mode 100644
index 00000000..db6b9d87
--- /dev/null
+++ b/assets/usage-of-client-config.html-7ce03b78.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3d6c80f5","path":"/advanced/cookbook/usage-of-client-config.html","title":"Usage of Client Config","lang":"en-US","frontmatter":{"icon":"fa6-solid:gear","description":"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 clien...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/advanced/cookbook/usage-of-client-config.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/advanced/cookbook/usage-of-client-config.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Usage of Client Config"}],["meta",{"property":"og:description","content":"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 clien..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Usage of Client Config\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"enhance","slug":"enhance","link":"#enhance","children":[{"level":3,"title":"Register Vue Components","slug":"register-vue-components","link":"#register-vue-components","children":[]},{"level":3,"title":"Use Non-SSR-Friendly Features","slug":"use-non-ssr-friendly-features","link":"#use-non-ssr-friendly-features","children":[]},{"level":3,"title":"Use Router Methods","slug":"use-router-methods","link":"#use-router-methods","children":[]}]},{"level":2,"title":"setup","slug":"setup","link":"#setup","children":[{"level":3,"title":"Use Composition API","slug":"use-composition-api","link":"#use-composition-api","children":[]},{"level":3,"title":"Use Non-SSR-Friendly Features","slug":"use-non-ssr-friendly-features-1","link":"#use-non-ssr-friendly-features-1","children":[]}]},{"level":2,"title":"layouts","slug":"layouts","link":"#layouts","children":[]},{"level":2,"title":"rootComponents","slug":"rootcomponents","link":"#rootcomponents","children":[]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":2.48,"words":745},"filePathRelative":"advanced/cookbook/usage-of-client-config.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/vite.html-1cf3b6bd.js b/assets/vite.html-1cf3b6bd.js
new file mode 100644
index 00000000..4d72c46d
--- /dev/null
+++ b/assets/vite.html-1cf3b6bd.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6ff623ea","path":"/zh/reference/bundler/vite.html","title":"Vite","lang":"zh-CN","frontmatter":{"icon":"simple-icons:vite","description":"Vite 打包工具是由 @vuepress/bundler-vite (https://www.npmjs.com/package/@vuepress/bundler-vite) 包提供的。它是 vuepress (https://www.npmjs.com/package/vuepress) 包的依赖之一，当然你也可以单独安装它： 配置项 Vite ...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://vuejs.press/reference/bundler/vite.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/zh/reference/bundler/vite.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Vite"}],["meta",{"property":"og:description","content":"Vite 打包工具是由 @vuepress/bundler-vite (https://www.npmjs.com/package/@vuepress/bundler-vite) 包提供的。它是 vuepress (https://www.npmjs.com/package/vuepress) 包的依赖之一，当然你也可以单独安装它： 配置项 Vite ..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Vite\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"viteOptions","slug":"viteoptions","link":"#viteoptions","children":[]},{"level":3,"title":"vuePluginOptions","slug":"vuepluginoptions","link":"#vuepluginoptions","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.5,"words":149},"filePathRelative":"zh/reference/bundler/vite.md","localizedDate":"2023年2月22日","autoDesc":true}');export{e as data};
diff --git a/assets/vite.html-27bceae1.js b/assets/vite.html-27bceae1.js
new file mode 100644
index 00000000..d4e3960e
--- /dev/null
+++ b/assets/vite.html-27bceae1.js
@@ -0,0 +1,11 @@
+import{_ as i,W as p,X as l,Y as s,$ as n,a0 as e,a1 as r,D as t}from"./framework-46b0e263.js";const c={},u=n("h1",{id:"vite",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vite","aria-hidden":"true"},"#"),e(" Vite")],-1),d={href:"https://www.npmjs.com/package/@vuepress/bundler-vite",target:"_blank",rel:"noopener noreferrer"},v={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},k=r(`
`,5),h=n("li",null,[n("p",null,"Details:"),n("p",null,"Accepts all options of Vite.")],-1),_=n("p",null,"Also see:",-1),f={href:"https://vitejs.dev/config/",target:"_blank",rel:"noopener noreferrer"},m=n("h3",{id:"vuepluginoptions",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vuepluginoptions","aria-hidden":"true"},"#"),e(" vuePluginOptions")],-1),g=n("p",null,"Details:",-1),b={href:"https://www.npmjs.com/package/@vitejs/plugin-vue",target:"_blank",rel:"noopener noreferrer"},w=n("p",null,"Also see:",-1),x={href:"https://vitejs.dev/plugins/#vitejs-plugin-vue",target:"_blank",rel:"noopener noreferrer"};function y(V,j){const o=t("NpmBadge"),a=t("ExternalLinkIcon");return p(),l("div",null,[u,s(o,{package:"@vuepress/bundler-vite"}),n("p",null,[e("Vite bundler is provided by "),n("a",d,[e("@vuepress/bundler-vite"),s(a)]),e(" package. It is a dependency of the "),n("a",v,[e("vuepress"),s(a)]),e(" package, and you can also install it separately.")]),k,n("ul",null,[h,n("li",null,[_,n("ul",null,[n("li",null,[n("a",f,[e("Vite > Config"),s(a)])])])])]),m,n("ul",null,[n("li",null,[g,n("p",null,[e("Accepts all options of "),n("a",b,[e("@vitejs/plugin-vue"),s(a)]),e(".")])]),n("li",null,[w,n("ul",null,[n("li",null,[n("a",x,[e("Vite > Plugins > Official Plugins"),s(a)])])])])])])}const N=i(c,[["render",y],["__file","vite.html.vue"]]);export{N as default};
diff --git a/assets/vite.html-9326e178.js b/assets/vite.html-9326e178.js
new file mode 100644
index 00000000..782fc04e
--- /dev/null
+++ b/assets/vite.html-9326e178.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-cf5a290e","path":"/reference/bundler/vite.html","title":"Vite","lang":"en-US","frontmatter":{"icon":"simple-icons:vite","description":"Vite bundler is provided by @vuepress/bundler-vite (https://www.npmjs.com/package/@vuepress/bundler-vite) package. It is a dependency of the vuepress (https://www.npmjs.com/pack...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/bundler/vite.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/bundler/vite.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Vite"}],["meta",{"property":"og:description","content":"Vite bundler is provided by @vuepress/bundler-vite (https://www.npmjs.com/package/@vuepress/bundler-vite) package. It is a dependency of the vuepress (https://www.npmjs.com/pack..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Vite\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"viteOptions","slug":"viteoptions","link":"#viteoptions","children":[]},{"level":3,"title":"vuePluginOptions","slug":"vuepluginoptions","link":"#vuepluginoptions","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":0.41,"words":122},"filePathRelative":"reference/bundler/vite.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/vite.html-a42b420e.js b/assets/vite.html-a42b420e.js
new file mode 100644
index 00000000..1eb7346d
--- /dev/null
+++ b/assets/vite.html-a42b420e.js
@@ -0,0 +1,11 @@
+import{_ as i,W as p,X as l,Y as s,$ as n,a0 as e,a1 as r,D as t}from"./framework-46b0e263.js";const c={},u=n("h1",{id:"vite",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vite","aria-hidden":"true"},"#"),e(" Vite")],-1),d={href:"https://www.npmjs.com/package/@vuepress/bundler-vite",target:"_blank",rel:"noopener noreferrer"},v={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},k=r(`
',4),ae=e("code",null,"base",-1),le=e("code",null,"base",-1),oe=e("h3",{id:"使用默认主题",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#使用默认主题","aria-hidden":"true"},"#"),n(" 使用默认主题")],-1),te={href:"https://sass-lang.com/",target:"_blank",rel:"noopener noreferrer"},re={href:"https://pnpm.io/",target:"_blank",rel:"noopener noreferrer"},ie={href:"https://www.npmjs.com/package/sass-loader",target:"_blank",rel:"noopener noreferrer"};function ce(pe,de){const t=l("NpmBadge"),a=l("ExternalLinkIcon"),r=l("RouterLink");return c(),p("div",null,[h,s(t,{package:"@vuepress/bundler-webpack"}),e("p",null,[n("Webpack 打包工具是由 "),e("a",_,[n("@vuepress/bundler-webpack"),s(a)]),n(" 包提供的。它是 "),e("a",b,[n("vuepress-webpack"),s(a)]),n(" 包的依赖之一，当然你也可以单独安装它：")]),k,e("ul",null,[v,e("li",null,[f,e("p",null,[n("通过 "),e("a",g,[n("webpack-chain"),s(a)]),n(" 来修改内部的 Webpack 配置。")]),m])]),w,e("ul",null,[x,S,e("li",null,[y,e("ul",null,[e("li",null,[e("a",W,[n("Webpack > Configuration > DevServer > devServer.setupMiddlewares"),s(a)])])])])]),B,e("ul",null,[C,L,e("li",null,[O,e("ul",null,[e("li",null,[e("a",M,[n("vue-loader > 选项参考"),s(a)])])])])]),N,e("ul",null,[V,j,e("li",null,[P,e("ul",null,[e("li",null,[e("a",q,[n("postcss-loader > Options"),s(a)])])])])]),z,e("ul",null,[D,E,e("li",null,[H,e("ul",null,[e("li",null,[e("a",I,[n("stylus-loader > Options"),s(a)])])])])]),R,e("ul",null,[U,A,e("li",null,[T,e("ul",null,[e("li",null,[e("a",X,[n("sass-loader > Options"),s(a)])])])])]),Y,e("ul",null,[Z,$,e("li",null,[F,e("ul",null,[e("li",null,[e("a",G,[n("sass-loader > Options"),s(a)])])])])]),J,e("ul",null,[K,Q,e("li",null,[ee,e("ul",null,[e("li",null,[e("a",ne,[n("less-loader > Options"),s(a)])])])])]),se,e("p",null,[n("与 Vite 不同， Webpack 不会为 Public 文件自动处理 "),ae,n("。因此如果你修改了网站的 "),le,n("，建议你在引用 Public 图片文件时使用 "),s(r,{to:"/zh/guide/assets.html#base-helper"},{default:d(()=>[n("Base Helper")]),_:1}),n("。")]),oe,e("p",null,[n("默认主题使用 "),e("a",te,[n("SASS"),s(a)]),n(" 作为 CSS 预处理器，因此你在使用 Webpack 时（特别是在使用 "),e("a",re,[n("pnpm"),s(a)]),n(" 时）可能需要手动安装 "),e("a",ie,[n("sass-loader"),s(a)]),n(" 来确保其正常工作。")])])}const he=i(u,[["render",ce],["__file","webpack.html.vue"]]);export{he as default};
diff --git a/assets/webpack.html-c03c48a3.js b/assets/webpack.html-c03c48a3.js
new file mode 100644
index 00000000..4a34dd5b
--- /dev/null
+++ b/assets/webpack.html-c03c48a3.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-d4319af0","path":"/reference/bundler/webpack.html","title":"Webpack","lang":"en-US","frontmatter":{"icon":"mdi:webpack","description":"Webpack bundler is provided by @vuepress/bundler-webpack (https://www.npmjs.com/package/@vuepress/bundler-webpack) package. It is a dependency of the vuepress-webpack (https://w...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuejs.press/zh/reference/bundler/webpack.html"}],["meta",{"property":"og:url","content":"https://vuejs.press/reference/bundler/webpack.html"}],["meta",{"property":"og:site_name","content":"VuePress"}],["meta",{"property":"og:title","content":"Webpack"}],["meta",{"property":"og:description","content":"Webpack bundler is provided by @vuepress/bundler-webpack (https://www.npmjs.com/package/@vuepress/bundler-webpack) package. It is a dependency of the vuepress-webpack (https://w..."}],["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":"2023-02-22T07:39:31.000Z"}],["meta",{"property":"article:modified_time","content":"2023-02-22T07:39:31.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Webpack\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-02-22T07:39:31.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"configureWebpack","slug":"configurewebpack","link":"#configurewebpack","children":[]},{"level":3,"title":"chainWebpack","slug":"chainwebpack","link":"#chainwebpack","children":[]},{"level":3,"title":"devServerSetupMiddlewares","slug":"devserversetupmiddlewares","link":"#devserversetupmiddlewares","children":[]},{"level":3,"title":"vue","slug":"vue","link":"#vue","children":[]},{"level":3,"title":"postcss","slug":"postcss","link":"#postcss","children":[]},{"level":3,"title":"stylus","slug":"stylus","link":"#stylus","children":[]},{"level":3,"title":"scss","slug":"scss","link":"#scss","children":[]},{"level":3,"title":"sass","slug":"sass","link":"#sass","children":[]},{"level":3,"title":"less","slug":"less","link":"#less","children":[]},{"level":3,"title":"evergreen","slug":"evergreen","link":"#evergreen","children":[]}]},{"level":2,"title":"FAQ","slug":"faq","link":"#faq","children":[{"level":3,"title":"Referencing Public Files after Changing base","slug":"referencing-public-files-after-changing-base","link":"#referencing-public-files-after-changing-base","children":[]},{"level":3,"title":"Using with Default Theme","slug":"using-with-default-theme","link":"#using-with-default-theme","children":[]}]}],"git":{"createdTime":1677051571000,"updatedTime":1677051571000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"readingTime":{"minutes":1.68,"words":504},"filePathRelative":"reference/bundler/webpack.md","localizedDate":"February 22, 2023","autoDesc":true}');export{e as data};
diff --git a/assets/webpack.html-c223bdb5.js b/assets/webpack.html-c223bdb5.js
new file mode 100644
index 00000000..5b56d96d
--- /dev/null
+++ b/assets/webpack.html-c223bdb5.js
@@ -0,0 +1,11 @@
+import{_ as r,W as c,X as p,Y as s,$ as e,a0 as n,Z as u,a1 as t,D as l}from"./framework-46b0e263.js";const d={},h=e("h1",{id:"webpack",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#webpack","aria-hidden":"true"},"#"),n(" Webpack")],-1),_={href:"https://www.npmjs.com/package/@vuepress/bundler-webpack",target:"_blank",rel:"noopener noreferrer"},b={href:"https://www.npmjs.com/package/vuepress-webpack",target:"_blank",rel:"noopener noreferrer"},f=t(`
`,5),k=e("li",null,[e("p",null,[n("Type: "),e("code",null,"(config: WebpackConfiguration, isServer: boolean, isBuild: boolean) => WebpackConfiguration | void")])],-1),g=e("p",null,"Details:",-1),v=e("p",null,"Edit the internal webpack config.",-1),m=e("code",null,"isServer",-1),w=e("code",null,"isBuild",-1),y={href:"https://github.com/survivejs/webpack-merge",target:"_blank",rel:"noopener noreferrer"},x=e("h3",{id:"chainwebpack",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#chainwebpack","aria-hidden":"true"},"#"),n(" chainWebpack")],-1),S=e("li",null,[e("p",null,[n("Type: "),e("code",null,"(config: WebpackChainConfig, isServer: boolean, isBuild: boolean) => void")])],-1),O=e("p",null,"Details:",-1),D={href:"https://github.com/mozilla-neutrino/webpack-chain",target:"_blank",rel:"noopener noreferrer"},T=e("p",null,[n("This option accepts a function that will receive a "),e("code",null,"Config"),n(" instance that provided by "),e("code",null,"webpack-chain"),n(" as the 1st argument an "),e("code",null,"isServer"),n(" flag as the 2nd argument and an "),e("code",null,"isBuild"),n(" flag as the 3rd argument.")],-1),B=e("h3",{id:"devserversetupmiddlewares",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#devserversetupmiddlewares","aria-hidden":"true"},"#"),n(" devServerSetupMiddlewares")],-1),C=e("li",null,[e("p",null,[n("Type: "),e("code",null,"(middlewares: Middleware[], devServer: Server) => Middleware[]")])],-1),L=e("li",null,[e("p",null,"Details:"),e("p",null,[n("A hook to be called in "),e("code",null,"devServer.setupMiddlewares"),n(" of webpack.")]),e("p",null,[n("The arguments of the function are those of "),e("code",null,"devServer.setupMiddlewares"),n(".")])],-1),W=e("p",null,"Also see:",-1),A={href:"https://webpack.js.org/configuration/dev-server/#devserversetupmiddlewares",target:"_blank",rel:"noopener noreferrer"},j=e("h3",{id:"vue",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#vue","aria-hidden":"true"},"#"),n(" vue")],-1),q=e("li",null,[e("p",null,[n("Type: "),e("code",null,"VueLoaderOptions")])],-1),M=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Options for "),e("code",null,"vue-loader"),n(".")])],-1),N=e("p",null,"Also see:",-1),V={href:"https://vue-loader.vuejs.org/options.html",target:"_blank",rel:"noopener noreferrer"},E=e("h3",{id:"postcss",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#postcss","aria-hidden":"true"},"#"),n(" postcss")],-1),R=e("li",null,[e("p",null,[n("Type: "),e("code",null,"PostcssLoaderOptions")])],-1),U=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Options for "),e("code",null,"postcss-loader"),n(".")])],-1),I=e("p",null,"Also see:",-1),F={href:"https://github.com/webpack-contrib/postcss-loader#options",target:"_blank",rel:"noopener noreferrer"},P=e("h3",{id:"stylus",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#stylus","aria-hidden":"true"},"#"),n(" stylus")],-1),Y=e("li",null,[e("p",null,[n("Type: "),e("code",null,"StylusLoaderOptions")])],-1),z=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Options for "),e("code",null,"stylus-loader"),n(".")])],-1),H=e("p",null,"Also see:",-1),Q={href:"https://github.com/webpack-contrib/stylus-loader#options",target:"_blank",rel:"noopener noreferrer"},X=e("h3",{id:"scss",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#scss","aria-hidden":"true"},"#"),n(" scss")],-1),Z=e("li",null,[e("p",null,[n("Type: "),e("code",null,"SassLoaderOptions")])],-1),$=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Options for "),e("code",null,"sass-loader"),n(" for "),e("code",null,".scss"),n(" files.")])],-1),G=e("p",null,"Also see:",-1),J={href:"https://github.com/webpack-contrib/sass-loader#options",target:"_blank",rel:"noopener noreferrer"},K=e("h3",{id:"sass",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sass","aria-hidden":"true"},"#"),n(" sass")],-1),ee=e("li",null,[e("p",null,[n("Type: "),e("code",null,"SassLoaderOptions")])],-1),ne=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Options for "),e("code",null,"sass-loader"),n(" for "),e("code",null,".sass"),n(" files.")])],-1),se=e("p",null,"Also see:",-1),ae={href:"https://github.com/webpack-contrib/sass-loader#options",target:"_blank",rel:"noopener noreferrer"},le=e("h3",{id:"less",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#less","aria-hidden":"true"},"#"),n(" less")],-1),te=e("li",null,[e("p",null,[n("Type: "),e("code",null,"LessLoaderOptions")])],-1),oe=e("li",null,[e("p",null,"Details:"),e("p",null,[n("Options for "),e("code",null,"less-loader"),n(".")])],-1),ie=e("p",null,"Also see:",-1),re={href:"https://github.com/webpack-contrib/less-loader#options",target:"_blank",rel:"noopener noreferrer"},ce=t('
Set to true if you are only targeting evergreen browsers. This will disable some transpilation and polyfills, and result in faster builds and smaller files.
',4),pe=e("code",null,"base",-1),ue=e("code",null,"base",-1),de=e("h3",{id:"using-with-default-theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#using-with-default-theme","aria-hidden":"true"},"#"),n(" Using with Default Theme")],-1),he={href:"https://sass-lang.com/",target:"_blank",rel:"noopener noreferrer"},_e={href:"https://www.npmjs.com/package/sass-loader",target:"_blank",rel:"noopener noreferrer"},be={href:"https://pnpm.io/",target:"_blank",rel:"noopener noreferrer"};function fe(ke,ge){const o=l("NpmBadge"),a=l("ExternalLinkIcon"),i=l("RouterLink");return c(),p("div",null,[h,s(o,{package:"@vuepress/bundler-webpack"}),e("p",null,[n("Webpack bundler is provided by "),e("a",_,[n("@vuepress/bundler-webpack"),s(a)]),n(" package. It is a dependency of the "),e("a",b,[n("vuepress-webpack"),s(a)]),n(" package, and you can also install it separately.")]),f,e("ul",null,[k,e("li",null,[g,v,e("p",null,[n("This option accepts a function that will receive a webpack config object as the 1st argument, an "),m,n(" flag as the 2nd argument and an "),w,n(" flag as the 3rd argument. You can either mutate the config directly, or return an object to be merged by "),e("a",y,[n("webpack-merge"),s(a)]),n(".")])])]),x,e("ul",null,[S,e("li",null,[O,e("p",null,[n("Edit the internal webpack config with "),e("a",D,[n("webpack-chain"),s(a)]),n(".")]),T])]),B,e("ul",null,[C,L,e("li",null,[W,e("ul",null,[e("li",null,[e("a",A,[n("Webpack > Configuration > DevServer > devServer.setupMiddlewares"),s(a)])])])])]),j,e("ul",null,[q,M,e("li",null,[N,e("ul",null,[e("li",null,[e("a",V,[n("vue-loader > Options Reference"),s(a)])])])])]),E,e("ul",null,[R,U,e("li",null,[I,e("ul",null,[e("li",null,[e("a",F,[n("postcss-loader > Options"),s(a)])])])])]),P,e("ul",null,[Y,z,e("li",null,[H,e("ul",null,[e("li",null,[e("a",Q,[n("stylus-loader > Options"),s(a)])])])])]),X,e("ul",null,[Z,$,e("li",null,[G,e("ul",null,[e("li",null,[e("a",J,[n("sass-loader > Options"),s(a)])])])])]),K,e("ul",null,[ee,ne,e("li",null,[se,e("ul",null,[e("li",null,[e("a",ae,[n("sass-loader > Options"),s(a)])])])])]),le,e("ul",null,[te,oe,e("li",null,[ie,e("ul",null,[e("li",null,[e("a",re,[n("less-loader > Options"),s(a)])])])])]),ce,e("p",null,[n("Unlike Vite, Webpack won't handle "),pe,n(" for public files automatically. So if you change the "),ue,n(" of your site, you'd better to use "),s(i,{to:"/guide/assets.html#base-helper"},{default:u(()=>[n("Base Helper")]),_:1}),n(" when referencing an public image file.")]),de,e("p",null,[n("Default theme is using "),e("a",he,[n("SASS"),s(a)]),n(" as CSS pre-processor, so you might need to install "),e("a",_e,[n("sass-loader"),s(a)]),n(" as a peer dependency to make it work with Webpack, especially when you are using "),e("a",be,[n("pnpm"),s(a)]),n(".")])])}const me=r(d,[["render",fe],["__file","webpack.html.vue"]]);export{me as default};
diff --git a/contributing.html b/contributing.html
new file mode 100644
index 00000000..992e4f13
--- /dev/null
+++ b/contributing.html
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+
+ Contributing Guide | VuePress
+
+
+
+
+
+
+
bundler-vite: The VuePress bundler package with vite. Use vite to dev and build VuePress app that generated by @vuepress/core.
bundler-webpack: The VuePress bundler package with webpack. Use webpack to dev and build VuePress app that generated by @vuepress/core.
cli: The VuePress command line interface (CLI) package. It will resolve user config file, and create VuePress app with @vuepress/core, then execute corresponding command.
client: The VuePress client package. Provides the client entry, and exports types and composable utils that can be used in client side development.
core: The VuePress core. Provides pure Node API to generate VuePress app, including page handling, plugin system and data preparation.
markdown: The VuePress markdown package. Use markdown-it as the markdown parser and integrate some plugins to be used in VuePress.
shared: Utilities that shared between node side and client side.
utils: Utilities that should only be used in node side.
In the ecosystem directory:
plugin-${name}: Official plugins.
theme-default: The default theme.
vuepress: A wrapper of vuepress-vite.
vuepress-vite: A wrapper of @vuepress/cli + @vuepress/bundler-vite + @vuepress/theme-default. If users want to use default theme with vite, they can simply install this package.
vuepress-webpack: A wrapper of @vuepress/cli + @vuepress/bundler-webpack + @vuepress/theme-default. If users want to use default theme with webpack, they can simply install this package.
The build script uses tsc and tsup to compile TypeScript source files to JavaScript dist files.
Also, it will copy necessary resources from source directory to dist directory, because some source files (e.g. .vue, .css files) would not be processed by tsc nor tsup, but should keep the same relative path in the dist directory.
You may need to run this script first after your clone this repository, because the dist files are ignored by .gitignore.
The clean script runs clean script in all packages, cleaning all the dist files and caches. In other words, it will remove all the files that generated by build, copy scripts.
It's used before you want to re-build source files from a clean / initial state.
-
-```
-
-## 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 fbb96d0d..00000000
--- a/docs/guide/deployment.md
+++ /dev/null
@@ -1,232 +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.
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
deleted file mode 100644
index 1a18b706..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.6.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 d04f0854..00000000
--- a/docs/guide/introduction.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# Introduction
-
-VuePress is a markdown-centered static site generator. 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/).
-
-## Why Not ...?
-
-### Nuxt
-
-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
-
-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.
-
-### Docsify / Docute
-
-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
-
-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.
-
-### GitBook
-
-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.
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 fbb96d0d..00000000
--- a/docs/guide/deployment.md
+++ /dev/null
@@ -1,232 +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 