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
+consthomepage = 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)
+ }
+ },
+}
+
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.
WARNING
As Vue SFC can contain only one <script> element, you should avoid using more than one <script> in VuePress markdown.
As we know, VuePress plugin entries and theme entries are processed in Node side, but sometimes you might need to pass data to client side. For example, you want to generate different data when users use different options.
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
+constroute = useRoute()
+// get the vue-router instance
+constrouter = useRouter()
+// provide a value that can be injected by layouts, pages and other components
+constcount = 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-6Yl8cQE3.js b/assets/404.html-6Yl8cQE3.js
new file mode 100644
index 000000000..7a25b17a4
--- /dev/null
+++ b/assets/404.html-6Yl8cQE3.js
@@ -0,0 +1 @@
+const t=JSON.parse('{"key":"v-3706649a","path":"/404.html","title":"","lang":"en-US","frontmatter":{"layout":"NotFound"},"headers":[],"git":{},"filePathRelative":null}');export{t as data};
diff --git a/assets/404.html-VtKSq7T3.js b/assets/404.html-VtKSq7T3.js
new file mode 100644
index 000000000..8c876760d
--- /dev/null
+++ b/assets/404.html-VtKSq7T3.js
@@ -0,0 +1 @@
+import{_ as e,o as c,c as t}from"./app-eU2v8o1B.js";const _={};function o(r,n){return c(),t("div")}const a=e(_,[["render",o],["__file","404.html.vue"]]);export{a as default};
diff --git a/assets/NpmBadge--lRFx50g.js b/assets/NpmBadge--lRFx50g.js
new file mode 100644
index 000000000..f33a2c708
--- /dev/null
+++ b/assets/NpmBadge--lRFx50g.js
@@ -0,0 +1 @@
+import{i as r,j as t,o,c as p,a as g,_ as d}from"./app-eU2v8o1B.js";const l=["href","title"],i=["src","alt"],m=r({__name:"NpmBadge",props:{package:{type:String,required:!0},distTag:{type:String,required:!1,default:"next"}},setup(a){const e=a,n=t(()=>`https://www.npmjs.com/package/${e.package}`),c=t(()=>e.distTag?`${e.package}@${e.distTag}`:e.package),s=t(()=>`https://badgen.net/npm/v/${e.package}/${e.distTag}?label=${encodeURIComponent(c.value)}`);return(u,_)=>(o(),p("a",{class:"npm-badge",href:n.value,title:a.package,target:"_blank",rel:"noopener noreferrer"},[g("img",{src:s.value,alt:a.package},null,8,i)],8,l))}}),k=d(m,[["__scopeId","data-v-c758b2a0"],["__file","NpmBadge.vue"]]);export{k as default};
diff --git a/assets/active-header-links.html-Gm5kCTnU.js b/assets/active-header-links.html-Gm5kCTnU.js
new file mode 100644
index 000000000..2316b62ce
--- /dev/null
+++ b/assets/active-header-links.html-Gm5kCTnU.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":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/active-header-links.md"}');export{e as data};
diff --git a/assets/active-header-links.html-NWwmfOvm.js b/assets/active-header-links.html-NWwmfOvm.js
new file mode 100644
index 000000000..2451806d4
--- /dev/null
+++ b/assets/active-header-links.html-NWwmfOvm.js
@@ -0,0 +1,11 @@
+import{_ as d,r as n,o as p,c as t,d as s,a as e,b as a,w as o,e as i}from"./app-eU2v8o1B.js";const h={},u=e("h1",{id:"active-header-links",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#active-header-links","aria-hidden":"true"},"#"),a(" active-header-links")],-1),m=i(`
',4);function g(x,E){const r=n("NpmBadge"),l=n("RouterLink"),c=n("ExternalLinkIcon");return p(),t("div",null,[u,s(r,{package:"@vuepress/plugin-active-header-links"}),m,e("ul",null,[D,v,e("li",null,[_,y,e("p",null,[a("你通常不需要设置该选项，除非你通过 "),s(l,{to:"/zh/reference/config.html#markdown-anchor"},{default:o(()=>[a("markdown.anchor")]),_:1}),a(" 修改了 "),e("a",k,[a("markdown-it-anchor"),s(c)]),a(" 的 "),b,a(" 选项。")])]),e("li",null,[f,e("ul",null,[e("li",null,[s(l,{to:"/zh/guide/markdown.html#%E6%A0%87%E9%A2%98%E9%94%9A%E7%82%B9"},{default:o(()=>[a("指南 > Markdown > 语法扩展 > 标题锚点")]),_:1})])])])]),C])}const w=d(h,[["render",g],["__file","active-header-links.html.vue"]]);export{w as default};
diff --git a/assets/active-header-links.html-fvsIO2KT.js b/assets/active-header-links.html-fvsIO2KT.js
new file mode 100644
index 000000000..20fa62d90
--- /dev/null
+++ b/assets/active-header-links.html-fvsIO2KT.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":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/active-header-links.md"}');export{e as data};
diff --git a/assets/active-header-links.html-sIc4BSCl.js b/assets/active-header-links.html-sIc4BSCl.js
new file mode 100644
index 000000000..cf9c5b062
--- /dev/null
+++ b/assets/active-header-links.html-sIc4BSCl.js
@@ -0,0 +1,11 @@
+import{_ as c,r as s,o as d,c as p,d as n,a as e,b as a,w as o,e as i}from"./app-eU2v8o1B.js";const h={},u=e("h1",{id:"active-header-links",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#active-header-links","aria-hidden":"true"},"#"),a(" 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 x(C,E){const t=s("NpmBadge"),r=s("ExternalLinkIcon"),l=s("RouterLink");return d(),p("div",null,[u,n(t,{package:"@vuepress/plugin-active-header-links"}),m,e("ul",null,[D,v,e("li",null,[y,f,e("p",null,[a("You don't need to specify this option unless you have changed the "),_,a(" option of "),e("a",g,[a("markdown-it-anchor"),n(r)]),a(" via "),n(l,{to:"/reference/config.html#markdown-anchor"},{default:o(()=>[a("markdown.anchor")]),_:1}),a(".")])]),e("li",null,[k,e("ul",null,[e("li",null,[n(l,{to:"/guide/markdown.html#header-anchors"},{default:o(()=>[a("Guide > Markdown > Syntax Extensions > Header Anchors")]),_:1})])])])]),b])}const T=c(h,[["render",x],["__file","active-header-links.html.vue"]]);export{T as default};
diff --git a/assets/adding-extra-pages.html-1UmMYfeg.js b/assets/adding-extra-pages.html-1UmMYfeg.js
new file mode 100644
index 000000000..6e4cf6020
--- /dev/null
+++ b/assets/adding-extra-pages.html-1UmMYfeg.js
@@ -0,0 +1,27 @@
+import{_ as p,r as o,o as t,c,a,b as s,d as e,w as l,e as r}from"./app-eU2v8o1B.js";const D={},i=a("h1",{id:"adding-extra-pages",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#adding-extra-pages","aria-hidden":"true"},"#"),s(" Adding Extra Pages")],-1),d=a("p",null,"Sometimes you might want to add some extra pages without creating a markdown file in the source directory.",-1),y=r(`
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
+consthomepage = 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 C(u,v){const n=o("RouterLink");return t(),c("div",null,[i,d,a("p",null,[s("With the help of "),e(n,{to:"/reference/plugin-api.html"},{default:l(()=>[s("Plugin API")]),_:1}),s(" and "),e(n,{to:"/reference/node-api.html"},{default:l(()=>[s("Node API")]),_:1}),s(", we can do that with ease.")]),y])}const h=p(D,[["render",C],["__file","adding-extra-pages.html.vue"]]);export{h as default};
diff --git a/assets/adding-extra-pages.html-8nHB5UGr.js b/assets/adding-extra-pages.html-8nHB5UGr.js
new file mode 100644
index 000000000..4946a8308
--- /dev/null
+++ b/assets/adding-extra-pages.html-8nHB5UGr.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":{},"headers":[{"level":2,"title":"Add a Default Homepage","slug":"add-a-default-homepage","link":"#add-a-default-homepage","children":[]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"advanced/cookbook/adding-extra-pages.md"}');export{e as data};
diff --git a/assets/adding-extra-pages.html-gbWcNXLf.js b/assets/adding-extra-pages.html-gbWcNXLf.js
new file mode 100644
index 000000000..90f951546
--- /dev/null
+++ b/assets/adding-extra-pages.html-gbWcNXLf.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5b617736","path":"/zh/advanced/cookbook/adding-extra-pages.html","title":"添加额外页面","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"添加默认的主页","slug":"添加默认的主页","link":"#添加默认的主页","children":[]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/advanced/cookbook/adding-extra-pages.md"}');export{e as data};
diff --git a/assets/adding-extra-pages.html-wSdXw6mw.js b/assets/adding-extra-pages.html-wSdXw6mw.js
new file mode 100644
index 000000000..68e64c36f
--- /dev/null
+++ b/assets/adding-extra-pages.html-wSdXw6mw.js
@@ -0,0 +1,27 @@
+import{_ as e,r as o,o as c,c as D,a as n,b as s,d as l,w as p,e as r}from"./app-eU2v8o1B.js";const t={},i=n("h1",{id:"添加额外页面",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#添加额外页面","aria-hidden":"true"},"#"),s(" 添加额外页面")],-1),y=n("p",null,"有时你可能希望在不创建 Markdown 文件的情况下添加一些额外的页面。",-1),d=r(`
',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=a("RouterLink");return d(),u("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=s(p,[["render",_],["__file","architecture.html.vue"]]);export{A as default};
diff --git a/assets/assets.html-1j54Fvx1.js b/assets/assets.html-1j54Fvx1.js
new file mode 100644
index 000000000..2526189c5
--- /dev/null
+++ b/assets/assets.html-1j54Fvx1.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-029ba47b","path":"/zh/guide/assets.html","title":"静态资源","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"相对路径","slug":"相对路径","link":"#相对路径","children":[]},{"level":2,"title":"Public 文件","slug":"public-文件","link":"#public-文件","children":[{"level":3,"title":"Base Helper","slug":"base-helper","link":"#base-helper","children":[]}]},{"level":2,"title":"依赖包和路径别名","slug":"依赖包和路径别名","link":"#依赖包和路径别名","children":[]}],"git":{"updatedTime":1703048697000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":2},{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"zh/guide/assets.md"}');export{e as data};
diff --git a/assets/assets.html-4ukTXhdM.js b/assets/assets.html-4ukTXhdM.js
new file mode 100644
index 000000000..6c68141fd
--- /dev/null
+++ b/assets/assets.html-4ukTXhdM.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3c32c2ca","path":"/guide/assets.html","title":"Assets","lang":"en-US","frontmatter":{},"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":{"updatedTime":1703048697000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":2},{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"guide/assets.md"}');export{e as data};
diff --git a/assets/assets.html-_UpsFxx-.js b/assets/assets.html-_UpsFxx-.js
new file mode 100644
index 000000000..3bc32e43a
--- /dev/null
+++ b/assets/assets.html-_UpsFxx-.js
@@ -0,0 +1,34 @@
+import{_ as p}from"./hero-RIx3NWRP.js";import{_ as r,r as c,o as t,c as i,a,b as s,d as e,w as l,e as o}from"./app-eU2v8o1B.js";const d={},D=o(`
<img src="@alias/image.png" alt="Image from path alias">
+
`,11),x={class:"custom-container tip"},w=e("p",{class:"custom-container-title"},"TIP",-1);function A(F,P){const a=r("RouterLink");return i(),c("div",null,[D,e("p",null,[s("The default public directory is "),u,s(", which can be changed by "),n(a,{to:"/reference/config.html#public"},{default:l(()=>[s("public")]),_:1}),s(" option.")]),y,e("p",null,[s("If your site is deployed to a non-root URL, for example, "),m,s(", then the "),n(a,{to:"/reference/config.html#base"},{default:l(()=>[s("base")]),_:1}),s(" should be set to "),h,s(". Obviously, your public files would be served like "),v,s(" after deployment.")]),b,e("div",g,[C,e("p",null,[s("When using "),n(a,{to:"/reference/bundler/webpack.html"},{default:l(()=>[s("webpack bundler")]),_:1}),s(", you need to set "),n(a,{to:"/reference/config.html#markdown-assets"},{default:l(()=>[s("markdown.assets.absolutePathPrependBase")]),_:1}),s(" to "),f,s(" to automatically prepend base to markdown images.")])]),e("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 "),E,s(" could not be handled automatically. To help with that, VuePress provides a "),n(a,{to:"/reference/client-api.html#withbase"},{default:l(()=>[s("withBase")]),_:1}),s(" helper to prepend "),k,s(" for you:")]),_,e("div",x,[w,e("p",null,[s("Config reference: "),n(a,{to:"/reference/plugin-api.html#alias"},{default:l(()=>[s("alias")]),_:1})])])])}const V=t(d,[["render",A],["__file","assets.html.vue"]]);export{V as default};
diff --git a/assets/back-to-top.html-3mn9vy9t.js b/assets/back-to-top.html-3mn9vy9t.js
new file mode 100644
index 000000000..f6415273c
--- /dev/null
+++ b/assets/back-to-top.html-3mn9vy9t.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":{},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"样式","slug":"样式","link":"#样式","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/back-to-top.md"}');export{e as data};
diff --git a/assets/back-to-top.html-ETMm9zTr.js b/assets/back-to-top.html-ETMm9zTr.js
new file mode 100644
index 000000000..0b12d48e9
--- /dev/null
+++ b/assets/back-to-top.html-ETMm9zTr.js
@@ -0,0 +1,13 @@
+import{_ as n,r as e,o as l,c as o,d as p,a as s,b as t,e as c}from"./app-eU2v8o1B.js";const i={},r=s("h1",{id:"back-to-top",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#back-to-top","aria-hidden":"true"},"#"),t(" back-to-top")],-1),d=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.
`,8);function D(u,y){const a=e("NpmBadge");return l(),o("div",null,[r,p(a,{package:"@vuepress/plugin-back-to-top"}),d])}const h=n(i,[["render",D],["__file","back-to-top.html.vue"]]);export{h as default};
diff --git a/assets/back-to-top.html-SBrZWHGE.js b/assets/back-to-top.html-SBrZWHGE.js
new file mode 100644
index 000000000..26f46af9d
--- /dev/null
+++ b/assets/back-to-top.html-SBrZWHGE.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":{},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/back-to-top.md"}');export{e as data};
diff --git a/assets/back-to-top.html-U82tNcMw.js b/assets/back-to-top.html-U82tNcMw.js
new file mode 100644
index 000000000..0f4d54b88
--- /dev/null
+++ b/assets/back-to-top.html-U82tNcMw.js
@@ -0,0 +1,13 @@
+import{_ as n,r as e,o as l,c as o,d as p,a as s,b as c,e as r}from"./app-eU2v8o1B.js";const t={},i=s("h1",{id:"back-to-top",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#back-to-top","aria-hidden":"true"},"#"),c(" back-to-top")],-1),d=r(`
`,8);function D(u,y){const a=e("NpmBadge");return l(),o("div",null,[i,p(a,{package:"@vuepress/plugin-back-to-top"}),d])}const b=n(t,[["render",D],["__file","back-to-top.html.vue"]]);export{b as default};
diff --git a/assets/bundler.html-1Lcboibq.js b/assets/bundler.html-1Lcboibq.js
new file mode 100644
index 000000000..fab5d033c
--- /dev/null
+++ b/assets/bundler.html-1Lcboibq.js
@@ -0,0 +1,21 @@
+import{_ as c,r as o,o as i,c as d,a as s,b as e,d as n,w as a,e as u}from"./app-eU2v8o1B.js";const D={},y=s("h1",{id:"bundler",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#bundler","aria-hidden":"true"},"#"),e(" Bundler")],-1),b={href:"https://webpack.js.org/",target:"_blank",rel:"noopener noreferrer"},h={href:"https://vitejs.dev/",target:"_blank",rel:"noopener noreferrer"},v=s("h2",{id:"choose-a-bundler",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#choose-a-bundler","aria-hidden":"true"},"#"),e(" Choose a Bundler")],-1),m={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},C={href:"https://www.npmjs.com/package/vuepress-webpack",target:"_blank",rel:"noopener noreferrer"},_=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"pnpm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"remove"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress")]),e(`
+`),s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"pnpm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"add"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#569CD6"}},"-D"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress-webpack@next")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"}),s("div",{class:"line-number"})])],-1),f=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"yarn"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"remove"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress")]),e(`
+`),s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"yarn"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"add"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#569CD6"}},"-D"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress-webpack@next")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[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:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"npm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"uninstall"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress")]),e(`
+`),s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"npm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"install"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#569CD6"}},"-D"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress-webpack@next")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"}),s("div",{class:"line-number"})])],-1),g={class:"custom-container tip"},E=s("p",{class:"custom-container-title"},"TIP",-1),w={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},x={href:"https://www.npmjs.com/package/vuepress-vite",target:"_blank",rel:"noopener noreferrer"},A=s("h2",{id:"configure-bundler",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#configure-bundler","aria-hidden":"true"},"#"),e(" Configure Bundler")],-1),B=s("p",null,"Generally, you could use a bundler without extra configuration, because we have already configured them properly to work with VuePress.",-1),V=u(`
`,1);function F(P,j){const l=o("ExternalLinkIcon"),r=o("CodeGroupItem"),p=o("CodeGroup"),t=o("RouterLink");return i(),d("div",null,[y,s("p",null,[e("VuePress has been using "),s("a",b,[e("Webpack"),n(l)]),e(" as the bundler to dev and build sites. Since VuePress v2, other bundlers are also supported, and now we are using "),s("a",h,[e("Vite"),n(l)]),e(" as the default bundler. Of course, you can still choose to use Webpack.")]),v,s("p",null,[e("When using the "),s("a",m,[e("vuepress"),n(l)]),e(" package, Vite bundler is installed and used automatically.")]),s("p",null,[e("If you want to use Webpack bundler instead, you can remove it and install the "),s("a",C,[e("vuepress-webpack"),n(l)]),e(" package instead:")]),n(p,null,{default:a(()=>[n(r,{title:"PNPM",active:""},{default:a(()=>[_]),_:1}),n(r,{title:"YARN"},{default:a(()=>[f]),_:1}),n(r,{title:"NPM"},{default:a(()=>[k]),_:1})]),_:1}),s("div",g,[E,s("p",null,[e("In fact, the "),s("a",w,[e("vuepress"),n(l)]),e(" package is just a wrapper of the "),s("a",x,[e("vuepress-vite"),n(l)]),e(" package.")])]),A,B,s("p",null,[e("You can configure bundler for advanced usage via the "),n(t,{to:"/reference/config.html#bundler"},{default:a(()=>[e("bundler")]),_:1}),e(" option:")]),V,s("p",null,[e("You can refer to "),n(t,{to:"/reference/bundler/vite.html"},{default:a(()=>[e("Bundlers > Vite")]),_:1}),e(" and "),n(t,{to:"/reference/bundler/webpack.html"},{default:a(()=>[e("Bundlers > Webpack")]),_:1}),e(" to check out all options of the corresponding bundler.")])])}const N=c(D,[["render",F],["__file","bundler.html.vue"]]);export{N as default};
diff --git a/assets/bundler.html-3HPSreHe.js b/assets/bundler.html-3HPSreHe.js
new file mode 100644
index 000000000..ffc3d13a6
--- /dev/null
+++ b/assets/bundler.html-3HPSreHe.js
@@ -0,0 +1,21 @@
+import{_ as c,r as o,o as i,c as D,a as s,b as e,d as n,w as l,e as d}from"./app-eU2v8o1B.js";const u={},y=s("h1",{id:"打包工具",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#打包工具","aria-hidden":"true"},"#"),e(" 打包工具")],-1),v={href:"https://webpack.js.org/",target:"_blank",rel:"noopener noreferrer"},m={href:"https://vitejs.dev/",target:"_blank",rel:"noopener noreferrer"},b=s("h2",{id:"选择一个打包工具",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#选择一个打包工具","aria-hidden":"true"},"#"),e(" 选择一个打包工具")],-1),h={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},C={href:"https://www.npmjs.com/package/vuepress-webpack",target:"_blank",rel:"noopener noreferrer"},_=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"pnpm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"uninstall"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress")]),e(`
+`),s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"pnpm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"add"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#569CD6"}},"-D"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress-webpack@next")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[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:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"yarn"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"remove"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress")]),e(`
+`),s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"yarn"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"add"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#569CD6"}},"-D"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress-webpack@next")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"}),s("div",{class:"line-number"})])],-1),E=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"npm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"uninstall"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress")]),e(`
+`),s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"npm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"install"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#569CD6"}},"-D"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"vuepress-webpack@next")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"}),s("div",{class:"line-number"})])],-1),f={class:"custom-container tip"},g=s("p",{class:"custom-container-title"},"提示",-1),w={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},x={href:"https://www.npmjs.com/package/vuepress-vite",target:"_blank",rel:"noopener noreferrer"},A=s("h2",{id:"配置打包工具",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#配置打包工具","aria-hidden":"true"},"#"),e(" 配置打包工具")],-1),V=s("p",null,"一般情况下，你不要任何额外配置就可以使用打包工具，因为我们已经帮你配置好了它们。",-1),F=d(`
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 g(_,k){const e=p("NpmBadge"),l=p("ExternalLinkIcon"),D=p("RouterLink");return t(),r("div",null,[C,a(e,{package:"@vuepress/cli"}),n("p",null,[s("VuePress CLI is provided by "),n("a",d,[s("@vuepress/cli"),a(l)]),s(" package. It is included by the "),n("a",E,[s("vuepress"),a(l)]),s(" package, and you can also install it separately.")]),u,n("div",v,[m,n("p",null,[s("VuePress is using "),n("a",h,[s("debug"),a(l)]),s(" module.")]),b]),A,n("p",null,[s("Build your VuePress site to static files, which are ready for "),a(D,{to:"/guide/deployment.html"},{default:y(()=>[s("deployment")]),_:1}),s(".")]),f])}const x=c(i,[["render",g],["__file","cli.html.vue"]]);export{x as default};
diff --git a/assets/cli.html-oJwwPLzh.js b/assets/cli.html-oJwwPLzh.js
new file mode 100644
index 000000000..debe5258c
--- /dev/null
+++ b/assets/cli.html-oJwwPLzh.js
@@ -0,0 +1,46 @@
+import{_ as c,r as p,o as r,c as t,d as a,a as n,b as s,w as y,e as o}from"./app-eU2v8o1B.js";const i={},C=n("h1",{id:"命令行接口",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#命令行接口","aria-hidden":"true"},"#"),s(" 命令行接口")],-1),d={href:"https://www.npmjs.com/package/@vuepress/cli",target:"_blank",rel:"noopener noreferrer"},E={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},v=o(`
执行 vuepress --help 来获取下列帮助信息：
Usage:
+$vuepress <command> [options]
+
+Commands:
+dev [sourceDir] Start development server
+build [sourceDir] Build to static site
+infoDisplayenvironmentinformation
+
+Formoreinfo,runanycommandwiththe\`--help\`flag:
+$vuepressdev--help
+$vuepressbuild--help
+$vuepressinfo--help
+
+Options:
+-v,--versionDisplayversionnumber
+-h,--helpDisplaythismessage
+
`,5);function g(_,k){const e=p("NpmBadge"),l=p("ExternalLinkIcon"),D=p("RouterLink");return r(),t("div",null,[C,a(e,{package:"@vuepress/cli"}),n("p",null,[s("VuePress 命令行接口是由 "),n("a",d,[s("@vuepress/cli"),a(l)]),s(" 包提供的。它包含在 "),n("a",E,[s("vuepress"),a(l)]),s(" 包之中，当然你也可以单独安装它。")]),v,n("div",u,[m,n("p",null,[s("VuePress 使用了 "),n("a",h,[s("debug"),a(l)]),s(" 模块。")]),b]),A,n("p",null,[s("将你的 VuePress 站点构建成静态文件，以便你进行后续"),a(D,{to:"/zh/guide/deployment.html"},{default:y(()=>[s("部署")]),_:1}),s("。")]),f])}const w=c(i,[["render",g],["__file","cli.html.vue"]]);export{w as default};
diff --git a/assets/cli.html-t2GuSTvN.js b/assets/cli.html-t2GuSTvN.js
new file mode 100644
index 000000000..3ae0edf80
--- /dev/null
+++ b/assets/cli.html-t2GuSTvN.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-a951be94","path":"/reference/cli.html","title":"Command Line Interface","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/cli.md"}');export{e as data};
diff --git a/assets/client-api.html-5X1GY6z7.js b/assets/client-api.html-5X1GY6z7.js
new file mode 100644
index 000000000..70fa09aa5
--- /dev/null
+++ b/assets/client-api.html-5X1GY6z7.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-332177d5","path":"/zh/reference/client-api.html","title":"客户端 API","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/client-api.md"}');export{e as data};
diff --git a/assets/client-api.html-Hz3O_EAk.js b/assets/client-api.html-Hz3O_EAk.js
new file mode 100644
index 000000000..acde0bea9
--- /dev/null
+++ b/assets/client-api.html-Hz3O_EAk.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-a84e51b8","path":"/reference/client-api.html","title":"Client API","lang":"en-US","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/client-api.md"}');export{e as data};
diff --git a/assets/client-api.html-jr_tX_nU.js b/assets/client-api.html-jr_tX_nU.js
new file mode 100644
index 000000000..61ebd8451
--- /dev/null
+++ b/assets/client-api.html-jr_tX_nU.js
@@ -0,0 +1,14 @@
+import{_ as c,r as o,o as d,c as u,d as a,a as e,b as s,w as l,e as t}from"./app-eU2v8o1B.js";const h={},D=e("h1",{id:"client-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#client-api","aria-hidden":"true"},"#"),s(" Client API")],-1),f={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"},"#"),s(" Composition API")],-1),g=e("h3",{id:"usepagedata",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagedata","aria-hidden":"true"},"#"),s(" usePageData")],-1),v=e("li",null,[e("p",null,"Details:"),e("p",null,"Returns the page data ref object of current page.")],-1),y=e("p",null,"Also see:",-1),b=e("h3",{id:"usepagefrontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagefrontmatter","aria-hidden":"true"},"#"),s(" usePageFrontmatter")],-1),m=e("ul",null,[e("li",null,[e("p",null,"Details:"),e("p",null,"Returns the frontmatter ref object of current page."),e("p",null,[s("The value is the "),e("code",null,"frontmatter"),s(" property of the page data.")])])],-1),C=e("h3",{id:"usepagehead",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagehead","aria-hidden":"true"},"#"),s(" usePageHead")],-1),E=e("p",null,"Details:",-1),x=e("p",null,"Returns the head config ref object of current page.",-1),k=t('
resolvers will affect the basic functionality of VuePress. Please make sure you have fully understood its purpose before modifying it.
`,4);function U(G,O){const i=o("NpmBadge"),r=o("ExternalLinkIcon"),n=o("RouterLink"),p=o("Badge");return d(),u("div",null,[D,a(i,{package:"@vuepress/client"}),e("p",null,[s("Client API is provided by "),e("a",f,[s("@vuepress/client"),a(r)]),s(" package, which is used for developing client files.")]),_,g,e("ul",null,[v,e("li",null,[y,e("ul",null,[e("li",null,[a(n,{to:"/reference/node-api.html#data"},{default:l(()=>[s("Node API > Page Properties > data")]),_:1})]),e("li",null,[a(n,{to:"/reference/plugin-api.html#extendspage"},{default:l(()=>[s("Plugin API > extendsPage")]),_:1})])])])]),b,m,C,e("ul",null,[e("li",null,[E,x,e("p",null,[s("The value is obtained by merging and deduplicating "),a(n,{to:"/reference/frontmatter.html#head"},{default:l(()=>[s("head")]),_:1}),s(" frontmatter and "),a(n,{to:"/reference/config.html#head"},{default:l(()=>[s("head")]),_:1}),s(" config.")])])]),k,e("ul",null,[e("li",null,[A,P,e("p",null,[s("The value is one of the keys of the "),a(n,{to:"/reference/config.html#locales"},{default:l(()=>[s("locales")]),_:1}),s(" config.")])])]),R,e("ul",null,[e("li",null,[F,e("p",null,[s("Helper for creating "),a(n,{to:"/reference/plugin-api.html#clientconfigfile"},{default:l(()=>[s("clientConfigFile")]),_:1}),s(".")])]),e("li",null,[S,e("ul",null,[e("li",null,[a(n,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:l(()=>[s("Advanced > Cookbook > Usage of Client Config")]),_:1})])])])]),T,e("ul",null,[e("li",null,[w,e("p",null,[s("Prefix URL with site "),a(n,{to:"/reference/config.html#base"},{default:l(()=>[s("base")]),_:1}),s(".")])]),e("li",null,[j,e("ul",null,[e("li",null,[a(n,{to:"/guide/assets.html#base-helper"},{default:l(()=>[s("Guide > Assets > Base Helper")]),_:1})])])])]),V,e("ul",null,[B,e("li",null,[L,e("p",null,[s("The "),a(n,{to:"/reference/config.html#base"},{default:l(()=>[s("base")]),_:1}),s(" option from config.")])])]),N,e("h3",I,[q,s(" resolvers "),a(p,{text:"experimental"})]),H])}const z=c(h,[["render",U],["__file","client-api.html.vue"]]);export{z as default};
diff --git a/assets/client-api.html-uhd2B6Du.js b/assets/client-api.html-uhd2B6Du.js
new file mode 100644
index 000000000..270d2f74b
--- /dev/null
+++ b/assets/client-api.html-uhd2B6Du.js
@@ -0,0 +1,14 @@
+import{_ as c,r as t,o as d,c as u,d as a,a as e,b as s,w as n,e as o}from"./app-eU2v8o1B.js";const h={},D=e("h1",{id:"客户端-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#客户端-api","aria-hidden":"true"},"#"),s(" 客户端 API")],-1),_={href:"https://www.npmjs.com/package/@vuepress/client",target:"_blank",rel:"noopener noreferrer"},f=e("h2",{id:"composition-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#composition-api","aria-hidden":"true"},"#"),s(" Composition API")],-1),y=e("h3",{id:"usepagedata",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagedata","aria-hidden":"true"},"#"),s(" usePageData")],-1),v=e("li",null,[e("p",null,"详情："),e("p",null,"返回当前页面数据的 Ref 对象。")],-1),g=e("p",null,"参考：",-1),C=e("h3",{id:"usepagefrontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagefrontmatter","aria-hidden":"true"},"#"),s(" usePageFrontmatter")],-1),m=e("ul",null,[e("li",null,[e("p",null,"详情："),e("p",null,"返回当前页面 Frontmatter 的 Ref 对象。"),e("p",null,[s("它的值是页面数据的 "),e("code",null,"frontmatter"),s(" 属性。")])])],-1),b=e("h3",{id:"usepagehead",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#usepagehead","aria-hidden":"true"},"#"),s(" usePageHead")],-1),E=e("p",null,"详情：",-1),x=e("p",null,"返回当前页面 Head 配置的 Ref 对象。",-1),k=o('
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),_=e("p",null,"Details:",-1),g=e("p",null,"This component will render the Markdown content of a page.",-1),y={href:"https://router.vuejs.org/api/#name-2",target:"_blank",rel:"noopener noreferrer"},v=e("code",null,"pageKey",-1),b=e("p",null,"This component is mainly for developing themes. You won't need it in most cases.",-1),f=e("p",null,"Also see:",-1);function k(x,D){const t=l("NpmBadge"),s=l("ExternalLinkIcon"),i=l("RouterLink");return r(),c("div",null,[h,o(t,{package:"@vuepress/client"}),m,e("ul",null,[e("li",null,[_,g,e("p",null,[n("The page key is the "),e("a",y,[n("name"),o(s)]),n(" of the page route. If the "),v,n(" prop is not provided, it will render the page of current route.")]),b]),e("li",null,[f,e("ul",null,[e("li",null,[o(i,{to:"/reference/node-api.html#key"},{default:d(()=>[n("Node API > Page Properties > key")]),_:1})])])])])])}const C=a(u,[["render",k],["__file","components.html.vue"]]);export{C as default};
diff --git a/assets/components.html-9ZVeijmS.js b/assets/components.html-9ZVeijmS.js
new file mode 100644
index 000000000..53392885c
--- /dev/null
+++ b/assets/components.html-9ZVeijmS.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-551922c5","path":"/zh/reference/default-theme/components.html","title":"内置组件","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/default-theme/components.md"}');export{e as data};
diff --git a/assets/components.html-WqkyAXws.js b/assets/components.html-WqkyAXws.js
new file mode 100644
index 000000000..03368f1e0
--- /dev/null
+++ b/assets/components.html-WqkyAXws.js
@@ -0,0 +1,32 @@
+import{_ as r,r as a,o as u,c as v,d as n,a as s,b as e,w as l,e as p}from"./app-eU2v8o1B.js";const m={},D=s("h1",{id:"内置组件",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#内置组件","aria-hidden":"true"},"#"),e(" 内置组件")],-1),b={id:"badge",tabindex:"-1"},h=s("a",{class:"header-anchor",href:"#badge","aria-hidden":"true"},"#",-1),g=p(`
`,7),m=e("p",null,"详情：",-1),v=e("p",null,"该组件会渲染页面的 Markdown 内容。",-1),g={href:"https://router.vuejs.org/zh/api/#name-2",target:"_blank",rel:"noopener noreferrer"},k=e("code",null,"pageKey",-1),x=e("p",null,"该组件主要是为了开发主题时使用。在绝大多数情况下你不会用到它。",-1),y=e("p",null,"参考：",-1);function b(f,D){const s=l("NpmBadge"),o=l("ExternalLinkIcon"),t=l("RouterLink");return d(),c("div",null,[h,a(s,{package:"@vuepress/client"}),_,e("ul",null,[e("li",null,[m,v,e("p",null,[n("页面 Key 是页面路由的 "),e("a",g,[n("name"),a(o)]),n(" 。如果没有传入 "),k,n(" Prop ，它会渲染当前路由下的页面。")]),x]),e("li",null,[y,e("ul",null,[e("li",null,[a(t,{to:"/zh/reference/node-api.html#key"},{default:r(()=>[n("Node API > Page 属性 > key")]),_:1})])])])])])}const E=i(u,[["render",b],["__file","components.html.vue"]]);export{E as default};
diff --git a/assets/components.html-zMFdbMQ-.js b/assets/components.html-zMFdbMQ-.js
new file mode 100644
index 000000000..62f446884
--- /dev/null
+++ b/assets/components.html-zMFdbMQ-.js
@@ -0,0 +1,32 @@
+import{_ as r,r as a,o as u,c as m,d as n,a as e,b as s,w as l,e as p}from"./app-eU2v8o1B.js";const v={},D=e("h1",{id:"built-in-components",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#built-in-components","aria-hidden":"true"},"#"),s(" Built-in Components")],-1),b={id:"badge",tabindex:"-1"},h=e("a",{class:"header-anchor",href:"#badge","aria-hidden":"true"},"#",-1),g=p(`
`,7),_=e("div",{class:"language-bash","data-ext":"sh"},[e("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[e("code",null,[e("span",{class:"line"},[e("span",{style:{color:"#DCDCAA"}},"pnpm"),e("span",{style:{color:"#D4D4D4"}}," "),e("span",{style:{color:"#CE9178"}},"install")]),s(`
+`),e("span",{class:"line"})])])],-1),C=e("div",{class:"language-bash","data-ext":"sh"},[e("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[e("code",null,[e("span",{class:"line"},[e("span",{style:{color:"#DCDCAA"}},"yarn"),e("span",{style:{color:"#D4D4D4"}}," "),e("span",{style:{color:"#CE9178"}},"install")]),s(`
+`),e("span",{class:"line"})])])],-1),f=e("div",{class:"language-bash","data-ext":"sh"},[e("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[e("code",null,[e("span",{class:"line"},[e("span",{style:{color:"#DCDCAA"}},"npm"),e("span",{style:{color:"#D4D4D4"}}," "),e("span",{style:{color:"#CE9178"}},"install")]),s(`
+`),e("span",{class:"line"})])])],-1),k={class:"custom-container warning"},x=e("p",{class:"custom-container-title"},"WARNING",-1),E=e("p",null,[s("You must add an empty line between the starting tag of "),e("code",null,""),s(" and the code fence, otherwise the code fence will not be parsed correctly by Markdown.")],-1),q=e("p",null,"All content must be valid Markdown first, and then a Vue SFC.",-1);function G(w,A){const c=a("NpmBadge"),t=a("Badge"),o=a("CodeGroupItem"),d=a("CodeGroup"),i=a("RouterLink");return u(),m("div",null,[D,n(c,{package:"@vuepress/theme-default"}),e("h2",b,[h,s(" Badge "),n(t,{text:"badge"})]),g,e("ul",null,[e("li",null,[s("VuePress - "),n(t,{type:"tip",text:"v2",vertical:"top"})]),e("li",null,[s("VuePress - "),n(t,{type:"warning",text:"v2",vertical:"middle"})]),e("li",null,[s("VuePress - "),n(t,{type:"danger",text:"v2",vertical:"bottom"})])]),y,n(d,null,{default:l(()=>[n(o,{title:"PNPM"},{default:l(()=>[_]),_:1}),n(o,{title:"YARN"},{default:l(()=>[C]),_:1}),n(o,{title:"NPM",active:""},{default:l(()=>[f]),_:1})]),_:1}),e("div",k,[x,E,q,e("p",null,[s("Learn more: "),n(i,{to:"/advanced/cookbook/markdown-and-vue-sfc.html"},{default:l(()=>[s("Cookbook > Markdown and Vue SFC")]),_:1})]),e("p",null,[s("Alternatively, you can use the "),n(i,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:l(()=>[s("custom containers")]),_:1}),s(".")])])])}const N=r(v,[["render",G],["__file","components.html.vue"]]);export{N as default};
diff --git a/assets/config.html-3uFubqIm.js b/assets/config.html-3uFubqIm.js
new file mode 100644
index 000000000..3b1ac6272
--- /dev/null
+++ b/assets/config.html-3uFubqIm.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-0f0d17a8","path":"/reference/default-theme/config.html","title":"Config","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/default-theme/config.md"}');export{e as data};
diff --git a/assets/config.html-QsTvJZys.js b/assets/config.html-QsTvJZys.js
new file mode 100644
index 000000000..afe2f0c45
--- /dev/null
+++ b/assets/config.html-QsTvJZys.js
@@ -0,0 +1,173 @@
+import{_ as t,r as p,o as r,c as d,d as n,a as s,b as l,w as a,e as o}from"./app-eU2v8o1B.js";const D={},u=s("h1",{id:"配置",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#配置","aria-hidden":"true"},"#"),l(" 配置")],-1),h=o(`
You will need to set this if you plan to deploy your site under a sub path. It should always start and end with a slash. For example, if you plan to deploy your site to GitHub pages at https://foo.github.io/bar/, then you should set base to "/bar/".
The base is automatically prepended to the URLs that start with / in other options, so you only need to specify it once. (Except for attrs of head)
Notice that base should be an absolute URL pathname starting and ending with / .
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),S=e("p",null,"Also see:",-1),F=e("h2",{id:"theme-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme-config","aria-hidden":"true"},"#"),l(" Theme Config")],-1),B=e("h3",{id:"theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme","aria-hidden":"true"},"#"),l(" theme")],-1),L=e("li",null,[e("p",null,[l("Type: "),e("code",null,"Theme")])],-1),G=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),O=e("p",null,"Also see:",-1),N=e("h2",{id:"bundler-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bundler-config","aria-hidden":"true"},"#"),l(" Bundler Config")],-1),I=e("h3",{id:"bundler",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#bundler","aria-hidden":"true"},"#"),l(" bundler")],-1),M=a("
Type: Bundler
Details:
Set the bundler of your site.
If this option is not set, the default bundler will be used:
With vuepress or vuepress-vite, the default bundler is vite.
With vuepress-webpack, the default bundler is webpack.
',9),H=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),V=e("li",null,[e("p",null,[l("Default: "),e("code",null,"`${sourceDir}/.vuepress/public`")])],-1),j=e("li",null,[e("p",null,"Details:"),e("p",null,"Specify the directory for public files.")],-1),W=e("p",null,"Also see:",-1),Y=e("h3",{id:"debug",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#debug","aria-hidden":"true"},"#"),l(" debug")],-1),U=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),$=e("li",null,[e("p",null,[l("Default: "),e("code",null,"false")])],-1),z=e("p",null,"Details:",-1),J=e("p",null,"Enable debug mode or not.",-1),K={href:"https://github.com/visionmedia/debug",target:"_blank",rel:"noopener noreferrer"},Q=e("code",null,"DEBUG=vuepress*",-1),X=a('
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),ce={href:"https://github.com/valeriangalliat/markdown-it-anchor",target:"_blank",rel:"noopener noreferrer"},ue=e("p",null,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")],-1),he=e("p",null,"Also see:",-1),fe=a('
',4),me=e("li",null,[e("p",null,[l("Type: "),e("code",null,"CodePluginOptions | false")])],-1),_e=e("li",null,[e("p",null,"Details:"),e("p",null,"Options for VuePress built-in markdown-it code plugin."),e("p",null,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")])],-1),ge=e("p",null,"Also see:",-1),be=e("h4",{id:"markdown-code-highlightlines",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-code-highlightlines","aria-hidden":"true"},"#"),l(" markdown.code.highlightLines")],-1),De=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),ye=e("li",null,[e("p",null,[l("Default: "),e("code",null,"true")])],-1),ke=e("li",null,[e("p",null,"Details:"),e("p",null,"Enable code line highlighting or not.")],-1),we=e("p",null,"Also see:",-1),ve=e("h4",{id:"markdown-code-linenumbers",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-code-linenumbers","aria-hidden":"true"},"#"),l(" markdown.code.lineNumbers")],-1),xe=a("
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),Ne=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"},"#"),l(" markdown.component")],-1),Me=e("li",null,[e("p",null,[l("Type: "),e("code",null,"undefined | false")])],-1),Re=e("p",null,"Details:",-1),qe={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-component",target:"_blank",rel:"noopener noreferrer"},He=e("p",null,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")],-1),Ve=e("div",{class:"custom-container danger"},[e("p",{class:"custom-container-title"},"DANGER"),e("p",null,"You should not configure it unless you understand what it is for.")],-1),je=e("h3",{id:"markdown-emoji",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-emoji","aria-hidden":"true"},"#"),l(" markdown.emoji")],-1),We=e("li",null,[e("p",null,[l("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,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")],-1),ze=e("p",null,"Also see:",-1),Je=e("h3",{id:"markdown-frontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-frontmatter","aria-hidden":"true"},"#"),l(" markdown.frontmatter")],-1),Ke=e("li",null,[e("p",null,[l("Type: "),e("code",null,"FrontmatterPluginOptions | false")])],-1),Qe=e("p",null,"Details:",-1),Xe={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-frontmatter",target:"_blank",rel:"noopener noreferrer"},Ze=e("p",null,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")],-1),el=e("p",null,"Also see:",-1),ll=a(`
DANGER
You should not configure it unless you understand what it is for.
`,4),nl=e("p",null,"Details:",-1),ol={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-headers",target:"_blank",rel:"noopener noreferrer"},tl=e("p",null,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")],-1),al=e("p",null,"Also see:",-1),sl=e("h3",{id:"markdown-importcode",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#markdown-importcode","aria-hidden":"true"},"#"),l(" markdown.importCode")],-1),il=e("li",null,[e("p",null,[l("Type: "),e("code",null,"ImportCodePluginOptions | false")])],-1),dl=e("li",null,[e("p",null,"Details:"),e("p",null,"Options for VuePress built-in markdown-it import-code plugin."),e("p",null,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")])],-1),rl=e("p",null,"Also see:",-1),pl=a('
`,4),El=e("p",null,"Details:",-1),Al={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc",target:"_blank",rel:"noopener noreferrer"},Pl=e("p",null,[l("Set to "),e("code",null,"false"),l(" to disable this plugin.")],-1),Sl=e("p",null,"Also see:",-1),Fl=e("h2",{id:"plugin-config",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugin-config","aria-hidden":"true"},"#"),l(" Plugin Config")],-1),Bl=e("h3",{id:"plugins",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugins","aria-hidden":"true"},"#"),l(" plugins")],-1),Ll=e("li",null,[e("p",null,[l("Type: "),e("code",null,"(Plugin | Plugin[])[]")])],-1),Gl=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),Ol=e("p",null,"Also see:",-1),Nl=e("h2",{id:"plugin-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#plugin-api","aria-hidden":"true"},"#"),l(" Plugin API")],-1),Il=e("p",null,[l("User config file also works as a VuePress plugin, so all of the Plugin APIs are available except the "),e("code",null,"name"),l(" and "),e("code",null,"multiple"),l(" options.")],-1);function Ml(Rl,ql){const d=i("NpmBadge"),o=i("RouterLink"),s=i("ExternalLinkIcon");return p(),c("div",null,[h,n(d,{package:"@vuepress/cli"}),n(d,{package:"@vuepress/core"}),f,m,e("ul",null,[_,e("li",null,[g,e("ul",null,[e("li",null,[n(o,{to:"/guide/assets.html#base-helper"},{default:t(()=>[l("Guide > Assets > Base Helper")]),_:1})]),e("li",null,[n(o,{to:"/guide/deployment.html"},{default:t(()=>[l("Guide > Deployment")]),_:1})])])])]),b,e("ul",null,[D,e("li",null,[y,e("ul",null,[k,e("li",null,[n(o,{to:"/reference/frontmatter.html#lang"},{default:t(()=>[l("Frontmatter > lang")]),_:1})])])])]),w,e("ul",null,[v,e("li",null,[x,e("ul",null,[C,e("li",null,[n(o,{to:"/reference/frontmatter.html#description"},{default:t(()=>[l("Frontmatter > description")]),_:1})])])])]),T,e("ul",null,[e("li",null,[l("Also see: "),e("ul",null,[E,e("li",null,[n(o,{to:"/reference/frontmatter.html#head"},{default:t(()=>[l("Frontmatter > head")]),_:1})])])])]),A,e("ul",null,[P,e("li",null,[S,e("ul",null,[e("li",null,[n(o,{to:"/guide/i18n.html"},{default:t(()=>[l("Guide > I18n")]),_:1})])])])]),F,B,e("ul",null,[L,G,e("li",null,[O,e("ul",null,[e("li",null,[n(o,{to:"/guide/theme.html"},{default:t(()=>[l("Guide > Theme")]),_:1})]),e("li",null,[n(o,{to:"/reference/default-theme/config.html"},{default:t(()=>[l("Default Theme > Config")]),_:1})])])])]),N,I,e("ul",null,[M,e("li",null,[R,e("ul",null,[e("li",null,[n(o,{to:"/guide/bundler.html"},{default:t(()=>[l("Guide > Bundler")]),_:1})]),e("li",null,[n(o,{to:"/reference/bundler/vite.html"},{default:t(()=>[l("Bundlers > Vite")]),_:1})]),e("li",null,[n(o,{to:"/reference/bundler/webpack.html"},{default:t(()=>[l("Bundlers > Webpack")]),_:1})])])])]),q,e("ul",null,[H,V,j,e("li",null,[W,e("ul",null,[e("li",null,[n(o,{to:"/guide/assets.html#public-files"},{default:t(()=>[l("Guide > Assets > Public Files")]),_:1})])])])]),Y,e("ul",null,[U,$,e("li",null,[z,J,e("p",null,[l("This would be helpful for developers. Also, we are using "),e("a",K,[l("debug"),n(s)]),l(" package for debug logging, which can be enabled via "),Q,l(" environment variable.")])])]),X,e("ul",null,[Z,e("li",null,[ee,e("ul",null,[e("li",null,[n(o,{to:"/reference/frontmatter.html#permalinkpattern"},{default:t(()=>[l("Frontmatter > permalinkPattern")]),_:1})])])])]),le,e("ul",null,[ne,oe,e("li",null,[te,ae,e("p",null,[l("It accepts all options of "),e("a",se,[l("markdown-it"),n(s)]),l(", and the following additional options.")])]),e("li",null,[ie,e("ul",null,[e("li",null,[e("a",de,[l("markdown-it > Init with presets and options"),n(s)])]),e("li",null,[n(o,{to:"/guide/markdown.html#syntax-extensions"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions")]),_:1})])])])]),re,e("ul",null,[e("li",null,[pe,e("p",null,[l("Options for "),e("a",ce,[l("markdown-it-anchor"),n(s)]),l(".")]),ue]),e("li",null,[he,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#header-anchors"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Header Anchors")]),_:1})])])])]),fe,e("ul",null,[me,_e,e("li",null,[ge,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#code-blocks"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Code Blocks")]),_:1})])])])]),be,e("ul",null,[De,ye,ke,e("li",null,[we,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#line-highlighting"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Code Blocks > Line Highlighting")]),_:1})])])])]),ve,e("ul",null,[xe,e("li",null,[Ce,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#line-numbers"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Code Blocks > Line Numbers")]),_:1})])])])]),Te,e("div",Ee,[Ae,e("p",null,[l("You can disable it if you want to implement them in client side. For example, "),e("a",Pe,[l("Prismjs Line Highlight"),n(s)]),l(" or "),e("a",Se,[l("Prismjs Line Numbers"),n(s)]),l(".")])]),Fe,e("ul",null,[Be,e("li",null,[Le,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#wrap-with-v-pre"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Code Blocks > Wrap with v-pre")]),_:1})])])])]),Ge,e("ul",null,[Oe,e("li",null,[Ne,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#wrap-with-v-pre"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Code Blocks > Wrap with v-pre")]),_:1})])])])]),Ie,e("ul",null,[Me,e("li",null,[Re,e("p",null,[l("Options for "),e("a",qe,[l("@mdit-vue/plugin-component"),n(s)]),l(".")]),He])]),Ve,je,e("ul",null,[We,e("li",null,[Ye,e("p",null,[l("Options for "),e("a",Ue,[l("markdown-it-emoji"),n(s)]),l(".")]),$e]),e("li",null,[ze,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#emoji"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Emoji")]),_:1})])])])]),Je,e("ul",null,[Ke,e("li",null,[Qe,e("p",null,[l("Options for "),e("a",Xe,[l("@mdit-vue/plugin-frontmatter"),n(s)]),l(".")]),Ze]),e("li",null,[el,e("ul",null,[e("li",null,[n(o,{to:"/guide/page.html#frontmatter"},{default:t(()=>[l("Guide > Page > Frontmatter")]),_:1})]),e("li",null,[n(o,{to:"/reference/node-api.html#frontmatter"},{default:t(()=>[l("Node API > Page Properties > frontmatter")]),_:1})])])])]),ll,e("ul",null,[e("li",null,[nl,e("p",null,[l("Options for "),e("a",ol,[l("@mdit-vue/plugin-headers"),n(s)]),l(".")]),tl]),e("li",null,[al,e("ul",null,[e("li",null,[n(o,{to:"/reference/node-api.html#headers"},{default:t(()=>[l("Node API > Page Properties > headers")]),_:1})])])])]),sl,e("ul",null,[il,dl,e("li",null,[rl,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#import-code-blocks"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Import Code Blocks")]),_:1})])])])]),pl,e("ul",null,[cl,e("li",null,[ul,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#links"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Links")]),_:1})])])])]),hl,e("ul",null,[fl,e("li",null,[ml,e("p",null,[l("Options for "),e("a",_l,[l("@mdit-vue/plugin-sfc"),n(s)]),l(".")]),gl]),e("li",null,[bl,e("ul",null,[e("li",null,[n(o,{to:"/advanced/cookbook/markdown-and-vue-sfc.html"},{default:t(()=>[l("Cookbook > Markdown and Vue SFC")]),_:1})]),e("li",null,[n(o,{to:"/reference/node-api.html#sfcblocks"},{default:t(()=>[l("Node API > Page Properties > sfcBlocks")]),_:1})])])])]),Dl,yl,kl,e("ul",null,[wl,e("li",null,[vl,e("p",null,[l("Options for "),e("a",xl,[l("@mdit-vue/plugin-title"),n(s)]),l(".")]),Cl])]),Tl,e("ul",null,[e("li",null,[El,e("p",null,[l("Options for "),e("a",Al,[l("@mdit-vue/plugin-toc"),n(s)]),l(".")]),Pl]),e("li",null,[Sl,e("ul",null,[e("li",null,[n(o,{to:"/guide/markdown.html#table-of-contents"},{default:t(()=>[l("Guide > Markdown > Syntax Extensions > Table of Contents")]),_:1})])])])]),Fl,Bl,e("ul",null,[Ll,Gl,e("li",null,[Ol,e("ul",null,[e("li",null,[n(o,{to:"/guide/plugin.html"},{default:t(()=>[l("Guide > Plugin")]),_:1})])])])]),Nl,Il,e("p",null,[l("Please check out "),n(o,{to:"/reference/plugin-api.html"},{default:t(()=>[l("Plugin API Reference")]),_:1}),l(" for a full list of Plugin APIs.")])])}const Vl=r(u,[["render",Ml],["__file","config.html.vue"]]);export{Vl as default};
diff --git a/assets/config.html-mzxviKbd.js b/assets/config.html-mzxviKbd.js
new file mode 100644
index 000000000..94df2a459
--- /dev/null
+++ b/assets/config.html-mzxviKbd.js
@@ -0,0 +1,22 @@
+import{_ as r,r as t,o as p,c,d as n,a as e,w as o,b as l,e as s}from"./app-eU2v8o1B.js";const u={},h=e("h1",{id:"配置",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#配置","aria-hidden":"true"},"#"),l(" 配置")],-1),m=e("h2",{id:"站点配置",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#站点配置","aria-hidden":"true"},"#"),l(" 站点配置")],-1),_=e("h3",{id:"base",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#base","aria-hidden":"true"},"#"),l(" base")],-1),f=s('
类型： string
默认值： /
详情：
部署站点的基础路径。
如果你想让你的网站部署到一个子路径下，你将需要设置它。它的值应当总是以斜杠开始，并以斜杠结束。举例来说，如果你想将你的网站部署到 https://foo.github.io/bar/，那么 base 应该被设置成 "/bar/"。
base 将会作为前缀自动地插入到以 / 开始的其他选项的链接中，所以你只需要指定一次。（head 中的属性除外）
`,3),y=s("li",null,[s("p",null,[e("Type: "),s("code",null,"{ [path: string]: Partial }")])],-1),m=s("li",null,[s("p",null,[e("Default: "),s("code",null,"{}")])],-1),b=s("p",null,"Details:",-1),v=s("p",null,"Specify locales for i18n support.",-1),f=s("p",null,[e("All the options inside the "),s("a",{href:"#locale-config"},"Locale Config"),e(" section can be used in locales.")],-1),g=s("code",null,"locales",-1),C=s("p",null,"Also see:",-1),_=o('
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),L=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string")])],-1),N=s("p",null,"Details:",-1),G=s("p",null,[e("Specify the text of the "),s("em",null,"select language menu"),e(".")],-1),P=s("em",null,"select language menu",-1),R=o(`
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),Z=s("p",null,[e("The default value of "),s("code",null,"markdown.headers.level"),e(" is "),s("code",null,"[2, 3]"),e(", so the default max value of "),s("code",null,"sidebarDepth"),e(" is "),s("code",null,"2"),e(".")],-1),q=s("h3",{id:"editlink",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#editlink","aria-hidden":"true"},"#"),e(" editLink")],-1),J=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),K=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),Q=s("p",null,"Details:",-1),X=s("p",null,[e("Enable the "),s("em",null,"edit this page"),e(" link or not.")],-1),$=o(`
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),ss=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),es=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),ls=s("p",null,"Details:",-1),ns=s("p",null,[e("Enable the "),s("em",null,"last updated timestamp"),e(" or not.")],-1),as=s("code",null,"false",-1),os=o('
',3),is=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),ps=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),ts=s("p",null,"Details:",-1),cs=s("p",null,[e("Enable the "),s("em",null,"contributors list"),e(" or not.")],-1),rs=s("code",null,"false",-1),ds=o('
',5),xs=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string")])],-1),ks=s("li",null,[s("p",null,[e("Default: "),s("code",null,"'open in new window'")])],-1),Ts=s("p",null,"Details:",-1),ws=s("code",null,"sr-only",-1),Fs=s("p",null,"This is mainly for a11y purpose.",-1),As=s("li",null,[s("p",null,"Also see:"),s("ul",null,[s("li",null,[s("a",{href:"#themeplugins-externallinkicon"},"Default Theme > Config Reference > themePlugins.externalLinkIcon")])])],-1),Ss=o('
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),Ys=s("p",null,"Also see:",-1),Vs=s("h3",{id:"themeplugins-externallinkicon",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#themeplugins-externallinkicon","aria-hidden":"true"},"#"),e(" themePlugins.externalLinkIcon")],-1),Hs=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),Ws=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),Os=s("p",null,"Details:",-1),Zs=s("h3",{id:"themeplugins-git",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#themeplugins-git","aria-hidden":"true"},"#"),e(" themePlugins.git")],-1),qs=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),Js=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),Ks=s("p",null,"Details:",-1),Qs=s("h3",{id:"themeplugins-mediumzoom",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#themeplugins-mediumzoom","aria-hidden":"true"},"#"),e(" themePlugins.mediumZoom")],-1),Xs=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),$s=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),se=s("p",null,"Details:",-1),ee=s("h3",{id:"themeplugins-nprogress",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#themeplugins-nprogress","aria-hidden":"true"},"#"),e(" themePlugins.nprogress")],-1),le=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),ne=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),ae=s("p",null,"Details:",-1);function oe(ie,pe){const p=i("NpmBadge"),n=i("RouterLink"),t=i("ExternalLinkIcon");return r(),d("div",null,[u,l(p,{package:"@vuepress/theme-default"}),h,s("ul",null,[y,m,s("li",null,[b,v,f,s("p",null,[e("This option will only take effect in default theme, so don't confuse with "),g,e(" in "),l(n,{to:"/reference/config.html#locales"},{default:a(()=>[e("Site Config")]),_:1}),e(".")])]),s("li",null,[C,s("ul",null,[s("li",null,[l(n,{to:"/guide/i18n.html"},{default:a(()=>[e("Guide > I18n")]),_:1})])])])]),_,s("ul",null,[E,x,s("li",null,[k,T,s("p",null,[e("If set to "),w,e(", the initial color mode will be automatically set according to "),s("a",F,[e("prefers-color-scheme"),l(t)]),e(".")])]),A]),S,s("ul",null,[s("li",null,[e("Also see: "),s("ul",null,[s("li",null,[l(n,{to:"/guide/assets.html#public-files"},{default:a(()=>[e("Guide > Assets > Public Files")]),_:1})])])])]),I,s("ul",null,[L,s("li",null,[N,G,s("p",null,[e("The "),P,e(" will appear next to the repository button in the navbar when you set multiple "),l(n,{to:"/reference/config.html#locales"},{default:a(()=>[e("locales")]),_:1}),e(" in your site config.")])])]),R,s("ul",null,[j,M,s("li",null,[B,z,s("p",null,[e("You can override this global option via "),l(n,{to:"/reference/default-theme/frontmatter.html#sidebar"},{default:a(()=>[e("sidebar")]),_:1}),e(" frontmatter in your pages.")]),U]),Y]),V,s("ul",null,[H,W,s("li",null,[O,s("p",null,[e("The max value depends on which levels of headers you have extracted via "),l(n,{to:"/reference/config.html#markdown-headers"},{default:a(()=>[e("markdown.headers.level")]),_:1}),e(".")]),Z,s("p",null,[e("You can override this global option via "),l(n,{to:"/reference/default-theme/frontmatter.html#sidebardepth"},{default:a(()=>[e("sidebarDepth")]),_:1}),e(" frontmatter in your pages.")])])]),q,s("ul",null,[J,K,s("li",null,[Q,X,s("p",null,[e("You can override this global option via "),l(n,{to:"/reference/default-theme/frontmatter.html#editlink"},{default:a(()=>[e("editLink")]),_:1}),e(" frontmatter in your pages.")])])]),$,s("ul",null,[ss,es,s("li",null,[ls,ns,s("p",null,[e("You can override this global option via "),l(n,{to:"/reference/default-theme/frontmatter.html#lastupdated"},{default:a(()=>[e("lastUpdated")]),_:1}),e(" frontmatter in your pages. Notice that if you have already set this option to "),as,e(", this feature will be disabled totally and could not be enabled in locales nor page frontmatter.")])])]),os,s("ul",null,[is,ps,s("li",null,[ts,cs,s("p",null,[e("You can override this global option via "),l(n,{to:"/reference/default-theme/frontmatter.html#contributors"},{default:a(()=>[e("contributors")]),_:1}),e(" frontmatter in your pages. Notice that if you have already set this option to "),rs,e(", this feature will be disabled totally and could not be enabled in locales nor page frontmatter.")])])]),ds,s("ul",null,[Ds,us,s("li",null,[hs,s("p",null,[e("Specify the default title of the tip "),l(n,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:a(()=>[e("custom containers")]),_:1}),e(".")])])]),ys,s("ul",null,[ms,bs,s("li",null,[vs,s("p",null,[e("Specify the default title of the warning "),l(n,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:a(()=>[e("custom containers")]),_:1}),e(".")])])]),fs,s("ul",null,[gs,Cs,s("li",null,[_s,s("p",null,[e("Specify the default title of the danger "),l(n,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:a(()=>[e("custom containers")]),_:1}),e(".")])])]),Es,s("ul",null,[xs,ks,s("li",null,[Ts,s("p",null,[e("Specify the "),ws,e(" text of the "),l(n,{to:"/reference/plugin/external-link-icon.html#externallinkicon"},{default:a(()=>[e("ExternalLinkIcon")]),_:1}),e(".")]),Fs]),As]),Ss,s("ul",null,[Is,Ls,s("li",null,[Ns,s("p",null,[e("Enable "),l(n,{to:"/reference/plugin/active-header-links.html"},{default:a(()=>[e("@vuepress/plugin-active-header-links")]),_:1}),e(" or not.")])])]),Gs,s("ul",null,[Ps,Rs,s("li",null,[js,s("p",null,[e("Enable "),l(n,{to:"/reference/plugin/back-to-top.html"},{default:a(()=>[e("@vuepress/plugin-back-to-top")]),_:1}),e(" or not.")])])]),Ms,s("ul",null,[Bs,s("li",null,[zs,s("p",null,[e("Enable custom containers that powered by "),l(n,{to:"/reference/plugin/container.html"},{default:a(()=>[e("@vuepress/plugin-container")]),_:1}),e(" or not.")]),Us]),s("li",null,[Ys,s("ul",null,[s("li",null,[l(n,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:a(()=>[e("Default Theme > Markdown > Custom Containers")]),_:1})])])])]),Vs,s("ul",null,[Hs,Ws,s("li",null,[Os,s("p",null,[e("Enable "),l(n,{to:"/reference/plugin/external-link-icon.html"},{default:a(()=>[e("@vuepress/plugin-external-link-icon")]),_:1}),e(" or not.")])])]),Zs,s("ul",null,[qs,Js,s("li",null,[Ks,s("p",null,[e("Enable "),l(n,{to:"/reference/plugin/git.html"},{default:a(()=>[e("@vuepress/plugin-git")]),_:1}),e(" or not.")])])]),Qs,s("ul",null,[Xs,$s,s("li",null,[se,s("p",null,[e("Enable "),l(n,{to:"/reference/plugin/medium-zoom.html"},{default:a(()=>[e("@vuepress/plugin-medium-zoom")]),_:1}),e(" or not.")])])]),ee,s("ul",null,[le,ne,s("li",null,[ae,s("p",null,[e("Enable "),l(n,{to:"/reference/plugin/nprogress.html"},{default:a(()=>[e("@vuepress/plugin-nprogress")]),_:1}),e(" or not.")])])])])}const ce=c(D,[["render",oe],["__file","config.html.vue"]]);export{ce as default};
diff --git a/assets/configuration.html-pW3ShFLZ.js b/assets/configuration.html-pW3ShFLZ.js
new file mode 100644
index 000000000..5319d6b06
--- /dev/null
+++ b/assets/configuration.html-pW3ShFLZ.js
@@ -0,0 +1,29 @@
+import{_ as p,r as c,o as i,c as r,a as n,b as s,d as l,w as a,e as o}from"./app-eU2v8o1B.js";const t={},d=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:"custom-container tip"},g=e("p",{class:"custom-container-title"},"TIP",-1),C=e("p",null,"Unlike config file, client config file could not be specified via CLI options.",-1);function h(b,E){const n=c("RouterLink");return p(),r("div",null,[d,e("p",null,[s("You can also specify the config file via "),D,s(" option of "),l(n,{to:"/reference/cli.html"},{default:a(()=>[s("CLI")]),_:1}),s(":")]),u,e("div",f,[v,e("p",null,[s("Check out the "),l(n,{to:"/reference/config.html"},{default:a(()=>[s("Config Reference")]),_:1}),s(" for a full list of VuePress config.")])]),y,e("div",m,[g,C,e("p",null,[s("To learn more about client config file, see "),l(n,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:a(()=>[s("Advanced > Cookbook > Usage of Client Config")]),_:1})])])])}const k=i(t,[["render",h],["__file","configuration.html.vue"]]);export{k as default};
diff --git a/assets/configuration.html-xbAxcozF.js b/assets/configuration.html-xbAxcozF.js
new file mode 100644
index 000000000..ecb2e1caa
--- /dev/null
+++ b/assets/configuration.html-xbAxcozF.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-81f65e84","path":"/zh/guide/configuration.html","title":"配置","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"配置文件","slug":"配置文件","link":"#配置文件","children":[]},{"level":2,"title":"客户端配置文件","slug":"客户端配置文件","link":"#客户端配置文件","children":[]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/guide/configuration.md"}');export{e as data};
diff --git a/assets/container.html-PtxgkxjI.js b/assets/container.html-PtxgkxjI.js
new file mode 100644
index 000000000..b29f13b99
--- /dev/null
+++ b/assets/container.html-PtxgkxjI.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-3df91977","path":"/reference/plugin/container.html","title":"container","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/container.md"}');export{e as data};
diff --git a/assets/container.html-TjPytR4y.js b/assets/container.html-TjPytR4y.js
new file mode 100644
index 000000000..0da0ac045
--- /dev/null
+++ b/assets/container.html-TjPytR4y.js
@@ -0,0 +1,39 @@
+import{_ as i,r as e,o as c,c as d,d as a,a as s,b as n,w as r,e as o}from"./app-eU2v8o1B.js";const D={},u=s("h1",{id:"container",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#container","aria-hidden":"true"},"#"),n(" container")],-1),y=s("p",null,"为你的 VuePress 站点注册自定义容器。",-1),h={href:"https://github.com/markdown-it/markdown-it-container",target:"_blank",rel:"noopener noreferrer"},v=o(`
`,9),m=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),v=s("p",null,"Details:",-1),b=s("p",null,"The type of the container.",-1),C=s("code",null,"name",-1),g={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},_=o(`
`,11),k=s("p",null,"Details:",-1),x=s("code",null,"render",-1),w={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},T=s("p",null,[n("This plugin uses a default "),s("code",null,"render"),n(" function. If you specify this option, the default "),s("code",null,"render"),n(" function will be replaced, and the "),s("a",{href:"#locales"},"locales"),n(", "),s("a",{href:"#before"},"before"),n(" and "),s("a",{href:"#after"},"after"),n(" options will be ignored.")],-1),F=s("h3",{id:"validate",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#validate","aria-hidden":"true"},"#"),n(" validate")],-1),B=s("li",null,[s("p",null,[n("Type: "),s("code",null,"(params: string) => boolean")])],-1),I=s("p",null,"Details:",-1),A=s("code",null,"validate",-1),N={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},P=s("h3",{id:"marker",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#marker","aria-hidden":"true"},"#"),n(" marker")],-1),R=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),q=s("p",null,"Details:",-1),V=s("code",null,"marker",-1),L={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"};function $(M,S){const i=l("NpmBadge"),e=l("ExternalLinkIcon"),t=l("RouterLink");return c(),d("div",null,[u,a(i,{package:"@vuepress/plugin-container"}),y,s("p",null,[n("This plugin simplifies the use of "),s("a",h,[n("markdown-it-container"),a(e)]),n(", but also retains its original capabilities.")]),s("p",null,[n("The "),a(t,{to:"/reference/default-theme/markdown.html#custom-containers"},{default:p(()=>[n("Custom Containers")]),_:1}),n(" of default theme is powered by this plugin.")]),f,s("ul",null,[m,s("li",null,[v,b,s("p",null,[n("It will be used as the "),C,n(" param of "),s("a",g,[n("markdown-it-container"),a(e)]),n(".")])])]),_,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(t,{to:"/guide/i18n.html"},{default:p(()=>[n("Guide > I18n")]),_:1})])])])]),E,s("ul",null,[s("li",null,[k,s("p",null,[n("The "),x,n(" option of "),s("a",w,[n("markdown-it-container"),a(e)]),n(".")]),T])]),F,s("ul",null,[B,s("li",null,[I,s("p",null,[n("The "),A,n(" option of "),s("a",N,[n("markdown-it-container"),a(e)]),n(".")])])]),P,s("ul",null,[R,s("li",null,[q,s("p",null,[n("The "),V,n(" option of "),s("a",L,[n("markdown-it-container"),a(e)]),n(".")])])])])}const G=r(D,[["render",$],["__file","container.html.vue"]]);export{G as default};
diff --git a/assets/deployment.html-LSGkd9Y2.js b/assets/deployment.html-LSGkd9Y2.js
new file mode 100644
index 000000000..a64d24f9d
--- /dev/null
+++ b/assets/deployment.html-LSGkd9Y2.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-e8a66a70","path":"/guide/deployment.html","title":"Deployment","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"guide/deployment.md"}');export{e as data};
diff --git a/assets/deployment.html-U91hxMp2.js b/assets/deployment.html-U91hxMp2.js
new file mode 100644
index 000000000..0be7b87e8
--- /dev/null
+++ b/assets/deployment.html-U91hxMp2.js
@@ -0,0 +1,101 @@
+import{_ as i,r as p,o as c,c as r,a as s,b as n,d as e,w as t,e as a}from"./app-eU2v8o1B.js";const d={},D=s("h1",{id:"deployment",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#deployment","aria-hidden":"true"},"#"),n(" Deployment")],-1),u=s("p",null,"The following guides are based on some shared assumptions:",-1),y=s("li",null,[n("You are placing your Markdown source files inside the "),s("code",null,"docs"),n(" directory of your project;")],-1),v=s("li",null,[n("You are using the default build output location ("),s("code",null,".vuepress/dist"),n(");")],-1),h={href:"https://pnpm.io",target:"_blank",rel:"noopener noreferrer"},m=s("li",null,[n("VuePress is installed as a local dependency in your project, and you have setup the following script in "),s("code",null,"package.json"),n(":")],-1),b=a(`
If you are deploying to https://<USERNAME>.github.io/, you can omit this step as base defaults to "/".
If you are deploying to https://<USERNAME>.github.io/<REPO>/, for example your repository is at https://github.com/<USERNAME>/<REPO>, then set base to "/<REPO>/".
",2),_={href:"https://github.com/features/actions",target:"_blank",rel:"noopener noreferrer"},f=s("p",null,[n("Create "),s("code",null,".github/workflows/docs.yml"),n(" to set up the workflow.")],-1),C=a(`Click to expand sample config
name: docs
+
+on:
+# trigger deployment on every push to main branch
+push:
+branches: [main]
+# trigger deployment manually
+workflow_dispatch:
+
+jobs:
+docs:
+runs-on: ubuntu-latest
+
+steps:
+ - uses: actions/checkout@v4
+with:
+# fetch all commits to get last updated time or other git log info
+fetch-depth: 0
+
+ - name: Setup pnpm
+uses: pnpm/action-setup@v2
+with:
+# choose pnpm version to use
+version: 8
+# install deps with pnpm
+run_install: true
+
+ - name: Setup Node.js
+uses: actions/setup-node@v4
+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@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 }}
+
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),q=s("code",null,".gitlab-ci.yml",-1),j={href:"https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/",target:"_blank",rel:"noopener noreferrer"},P=a(`Click to expand sample config
# choose a docker image to use
+image: node:18-buster
+
+pages:
+# trigger deployment on every push to main branch
+only:
+ - main
+
+# cache node_modules
+cache:
+key:
+files:
+ - pnpm-lock.yaml
+paths:
+ - .pnpm-store
+
+# Install pnpm
+before_script:
+ - curl -fsSL https://get.pnpm.io/install.sh | sh -
+ - pnpm config set store-dir .pnpm-store
+
+# install dependencies and run build script
+script:
+ - pnpm i --frozen-lockfile
+ - pnpm docs:build --dest public
+
+artifacts:
+paths:
+ - public
+
`,1),R={class:"custom-container tip"},I=s("p",{class:"custom-container-title"},"TIP",-1),S={href:"https://docs.gitlab.com/ce/user/project/pages/#getting-started",target:"_blank",rel:"noopener noreferrer"},N=s("h2",{id:"google-firebase",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#google-firebase","aria-hidden":"true"},"#"),n(" Google Firebase")],-1),O={href:"https://www.npmjs.com/package/firebase-tools",target:"_blank",rel:"noopener noreferrer"},H=s("li",null,[s("p",null,[n("Create "),s("code",null,"firebase.json"),n(" and "),s("code",null,".firebaserc"),n(" at the root of your project with the following content:")])],-1),G=a(`
After running pnpm docs:build, deploy using the command firebase deploy.
`,5),T={class:"custom-container tip"},F=s("p",{class:"custom-container-title"},"TIP",-1),U={href:"https://firebase.google.com/docs/cli",target:"_blank",rel:"noopener noreferrer"},B=s("h2",{id:"heroku",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#heroku","aria-hidden":"true"},"#"),n(" Heroku")],-1),V={href:"https://devcenter.heroku.com/articles/heroku-cli",target:"_blank",rel:"noopener noreferrer"},L={href:"https://signup.heroku.com",target:"_blank",rel:"noopener noreferrer"},M=s("li",null,[s("p",null,[n("Run "),s("code",null,"heroku login"),n(" and fill in your Heroku credentials:")])],-1),K=a(`
herokulogin
+
Create a file called static.json in the root of your project with the below content:
static.json:
{
+"root": "./docs/.vuepress/dist"
+}
+
`,4),Y={href:"https://github.com/heroku/heroku-buildpack-static",target:"_blank",rel:"noopener noreferrer"},z=s("h2",{id:"kinsta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#kinsta","aria-hidden":"true"},"#"),n(" Kinsta")],-1),W={href:"https://kinsta.com/docs/vuepress-application/",target:"_blank",rel:"noopener noreferrer"},$=s("h2",{id:"edgio",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#edgio","aria-hidden":"true"},"#"),n(" Edgio")],-1),J={href:"https://docs.edg.io/guides/vuepress",target:"_blank",rel:"noopener noreferrer"},Q=s("h2",{id:"netlify",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#netlify","aria-hidden":"true"},"#"),n(" Netlify")],-1),X={href:"https://netlify.com",target:"_blank",rel:"noopener noreferrer"},Z=s("ul",null,[s("li",null,[s("strong",null,"Build Command:"),n(),s("code",null,"pnpm docs:build")]),s("li",null,[s("strong",null,"Publish directory:"),n(),s("code",null,"docs/.vuepress/dist")])],-1),ss={href:"https://docs.netlify.com/configure-builds/environment-variables",target:"_blank",rel:"noopener noreferrer"},ns=s("ul",null,[s("li",null,[s("code",null,"NODE_VERSION"),n(": 18")])],-1),es=s("li",null,[s("p",null,"Hit the deploy button.")],-1),ls=s("h2",{id:"vercel",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#vercel","aria-hidden":"true"},"#"),n(" Vercel")],-1),as={href:"https://vercel.com",target:"_blank",rel:"noopener noreferrer"},os=s("ul",null,[s("li",null,[s("strong",null,"FRAMEWORK PRESET:"),n(),s("code",null,"Other")]),s("li",null,[s("strong",null,"BUILD COMMAND:"),n(),s("code",null,"pnpm docs:build")]),s("li",null,[s("strong",null,"OUTPUT DIRECTORY:"),n(),s("code",null,"docs/.vuepress/dist")])],-1),ps=s("li",null,[s("p",null,"Hit the deploy button.")],-1);function ts(is,cs){const l=p("ExternalLinkIcon"),o=p("RouterLink");return c(),r("div",null,[D,u,s("ul",null,[y,v,s("li",null,[n("You are using "),s("a",h,[n("pnpm"),e(l)]),n(" as package manager, while npm and yarn are also supported;")]),m]),b,s("ol",null,[s("li",null,[s("p",null,[n("Set the correct "),e(o,{to:"/reference/config.html#base"},{default:t(()=>[n("base")]),_:1}),n(" config.")]),g]),s("li",null,[s("p",null,[n("Choose your preferred CI tools. Here we take "),s("a",_,[n("GitHub Actions"),e(l)]),n(" as an example.")]),f])]),C,s("div",E,[k,s("p",null,[n("Please refer to "),s("a",w,[n("GitHub Pages official guide"),e(l)]),n(" for more details.")])]),x,s("ol",null,[s("li",null,[s("p",null,[n("Set the correct "),e(o,{to:"/reference/config.html#base"},{default:t(()=>[n("base")]),_:1}),n(" config.")]),A]),s("li",null,[s("p",null,[n("Create "),q,n(" to set up "),s("a",j,[n("GitLab CI"),e(l)]),n(" workflow.")])])]),P,s("div",R,[I,s("p",null,[n("Please refer to "),s("a",S,[n("GitLab Pages official guide"),e(l)]),n(" for more details.")])]),N,s("ol",null,[s("li",null,[s("p",null,[n("Make sure you have "),s("a",O,[n("firebase-tools"),e(l)]),n(" installed.")])]),H]),G,s("div",T,[F,s("p",null,[n("Please refer to "),s("a",U,[n("Firebase CLI official guide"),e(l)]),n(" for more details.")])]),B,s("ol",null,[s("li",null,[s("p",null,[n("Install "),s("a",V,[n("Heroku CLI"),e(l)]),n(".")])]),s("li",null,[s("p",null,[n("Create a Heroku account by "),s("a",L,[n("signing up"),e(l)]),n(".")])]),M]),K,s("p",null,[n("This is the configuration of your site; read more at "),s("a",Y,[n("heroku-buildpack-static"),e(l)]),n(".")]),z,s("p",null,[n("See "),s("a",W,[n("Set Up VuePress on Kinsta"),e(l)]),n(".")]),$,s("p",null,[n("See "),s("a",J,[n("Edgio Documentation > Framework Guides > VuePress"),e(l)]),n(".")]),Q,s("ol",null,[s("li",null,[s("p",null,[n("On "),s("a",X,[n("Netlify"),e(l)]),n(", set up a new project from GitHub with the following settings:")]),Z]),s("li",null,[s("p",null,[n("Set "),s("a",ss,[n("Environment variables"),e(l)]),n(" to choose node version:")]),ns]),es]),ls,s("ol",null,[s("li",null,[s("p",null,[n("Go to "),s("a",as,[n("Vercel"),e(l)]),n(", set up a new project from GitHub with the following settings:")]),os]),ps])])}const ds=i(d,[["render",ts],["__file","deployment.html.vue"]]);export{ds as default};
diff --git a/assets/deployment.html-XbzhTyhT.js b/assets/deployment.html-XbzhTyhT.js
new file mode 100644
index 000000000..5a7a89151
--- /dev/null
+++ b/assets/deployment.html-XbzhTyhT.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4a7b6bf9","path":"/zh/guide/deployment.html","title":"部署","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/guide/deployment.md"}');export{e as data};
diff --git a/assets/deployment.html-rDu3xTc7.js b/assets/deployment.html-rDu3xTc7.js
new file mode 100644
index 000000000..004398719
--- /dev/null
+++ b/assets/deployment.html-rDu3xTc7.js
@@ -0,0 +1,104 @@
+import{_ as c,r as p,o as t,c as r,a as s,b as n,d as l,w as i,e as a}from"./app-eU2v8o1B.js";const d={},D=s("h1",{id:"部署",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#部署","aria-hidden":"true"},"#"),n(" 部署")],-1),u=s("p",null,"下述的指南基于以下条件：",-1),y=s("li",null,[n("Markdown 源文件放置在你项目的 "),s("code",null,"docs"),n(" 目录；")],-1),v=s("li",null,[n("使用的是默认的构建输出目录 ("),s("code",null,".vuepress/dist"),n(") ；")],-1),b={href:"https://pnpm.io/zh/",target:"_blank",rel:"noopener noreferrer"},h=s("li",null,[n("VuePress 作为项目依赖安装，并在 "),s("code",null,"package.json"),n(" 中配置了如下脚本：")],-1),m=a(`
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
+returnhelpers.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),f={class:"custom-container tip"},x=s("p",{class:"custom-container-title"},"TIP",-1),B={href:"https://crawler.algolia.com/admin/crawlers/",target:"_blank",rel:"noopener noreferrer"},F=s("h2",{id:"options",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#options","aria-hidden":"true"},"#"),n(" Options")],-1),k=s("h3",{id:"apikey",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#apikey","aria-hidden":"true"},"#"),n(" apiKey")],-1),w=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),T=s("li",null,[s("p",null,[n("Required: "),s("code",null,"true")])],-1),S=s("li",null,[s("p",null,"Details:"),s("p",null,[n("The "),s("code",null,"apiKey"),n(" that you received from the DocSearch team, or generated by yourself.")])],-1),I=s("p",null,"Also see:",-1),P={href:"https://docsearch.algolia.com/docs/api#apikey",target:"_blank",rel:"noopener noreferrer"},N=s("h3",{id:"indexname",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#indexname","aria-hidden":"true"},"#"),n(" indexName")],-1),R=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),O=s("li",null,[s("p",null,[n("Required: "),s("code",null,"true")])],-1),U=s("li",null,[s("p",null,"Details:"),s("p",null,[n("The "),s("code",null,"indexName"),n(" that you received from the DocSearch team, or generated by yourself.")])],-1),Y=s("p",null,"Also see:",-1),z={href:"https://docsearch.algolia.com/docs/api#indexname",target:"_blank",rel:"noopener noreferrer"},q=s("h3",{id:"appid",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#appid","aria-hidden":"true"},"#"),n(" appId")],-1),L=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),W=s("li",null,[s("p",null,[n("Required: "),s("code",null,"true")])],-1),K=s("li",null,[s("p",null,"Details:"),s("p",null,"It defines your own application ID.")],-1),j=s("p",null,"Also see:",-1),V={href:"https://docsearch.algolia.com/docs/api#appid",target:"_blank",rel:"noopener noreferrer"},M=s("h3",{id:"searchparameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#searchparameters","aria-hidden":"true"},"#"),n(" searchParameters")],-1),X=s("li",null,[s("p",null,[n("Type: "),s("code",null,"SearchParameters")])],-1),H=s("li",null,[s("p",null,"Details:"),s("p",null,"Parameters of Algolia Search API.")],-1),G=s("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"},J=s("h3",{id:"placeholder",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#placeholder","aria-hidden":"true"},"#"),n(" placeholder")],-1),Z=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),ss=s("li",null,[s("p",null,[n("Default: "),s("code",null,"'Search docs'")])],-1),ns=s("li",null,[s("p",null,"Details:"),s("p",null,"The placeholder attribute of the search input.")],-1),as=s("p",null,"Also see:",-1),ls={href:"https://docsearch.algolia.com/docs/api/#placeholder",target:"_blank",rel:"noopener noreferrer"},es=s("h3",{id:"disableuserpersonalization",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#disableuserpersonalization","aria-hidden":"true"},"#"),n(" disableUserPersonalization")],-1),os=s("li",null,[s("p",null,[n("Type: "),s("code",null,"boolean")])],-1),ps=s("li",null,[s("p",null,[n("Default: "),s("code",null,"false")])],-1),rs=s("li",null,[s("p",null,"Details:"),s("p",null,"Whether to disable all personalized features: recent searches, favorite searches, etc.")],-1),cs=s("p",null,"Also see:",-1),ts={href:"https://docsearch.algolia.com/docs/api/#disableuserpersonalization",target:"_blank",rel:"noopener noreferrer"},Ds=s("h3",{id:"initialquery",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#initialquery","aria-hidden":"true"},"#"),n(" initialQuery")],-1),is=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),ds=s("li",null,[s("p",null,"Details:"),s("p",null,"The initial query when the modal opens.")],-1),ys=s("p",null,"Also see:",-1),us={href:"https://docsearch.algolia.com/docs/api/#initialquery",target:"_blank",rel:"noopener noreferrer"},hs=s("h3",{id:"translations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#translations","aria-hidden":"true"},"#"),n(" translations")],-1),vs=s("li",null,[s("p",null,[n("Type: "),s("code",null,"Partial")])],-1),Cs=s("li",null,[s("p",null,"Details:"),s("p",null,"Allow replacing the default text in the DocSearch button or modal.")],-1),bs=s("p",null,"Also see:",-1),ms={href:"https://docsearch.algolia.com/docs/api/#translations",target:"_blank",rel:"noopener noreferrer"},Es=e(`
`,3),_s=s("h3",{id:"indexbase",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#indexbase","aria-hidden":"true"},"#"),n(" indexBase")],-1),gs=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),As=s("p",null,"Details:",-1),fs=s("p",null,"The base path of the search index.",-1),xs=s("p",null,[n("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 "),s("em",null,"index domain"),n(", and only submit the "),s("em",null,"index domain"),n(" to Docsearch for crawling search index. Then, you could reuse the search index across all deployments.")],-1),Bs=s("em",null,"index domain",-1),Fs=e('
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.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
`,5);function Ts(Ss,Is){const c=r("NpmBadge"),l=r("ExternalLinkIcon"),o=r("RouterLink");return D(),i("div",null,[y,a(c,{package:"@vuepress/plugin-docsearch"}),s("p",null,[n("Integrate "),s("a",u,[n("Algolia DocSearch"),a(l)]),n(" into VuePress, which can provide search to your documentation site.")]),h,s("p",null,[n("You need to "),s("a",v,[n("submit the URL of your site"),a(l)]),n(" to join the DocSearch program. The DocSearch team will send "),C,n(" and "),b,n(" to your email once the index is generated. Then you can configure this plugin to enable DocSearch in VuePress.")]),s("p",null,[n("Alternatively, you can "),s("a",m,[n("run your own crawler"),a(l)]),n(" to generate the index, and then use your own "),E,n(", "),_,n(" and "),g,n(" to configure this plugin.")]),A,s("div",f,[x,s("p",null,[n("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 "),s("a",B,[n("Algolia Crawler"),a(l)]),n(", and edit your config with 'Editor' panel in project sidebar.")])]),F,k,s("ul",null,[w,T,S,s("li",null,[I,s("ul",null,[s("li",null,[s("a",P,[n("DocSearch > Options > apiKey"),a(l)])])])])]),N,s("ul",null,[R,O,U,s("li",null,[Y,s("ul",null,[s("li",null,[s("a",z,[n("DocSearch > Options > indexName"),a(l)])])])])]),q,s("ul",null,[L,W,K,s("li",null,[j,s("ul",null,[s("li",null,[s("a",V,[n("DocSearch > Options > appId"),a(l)])])])])]),M,s("ul",null,[X,H,s("li",null,[G,s("ul",null,[s("li",null,[s("a",Q,[n("DocSearch > Options > searchParameters"),a(l)])]),s("li",null,[s("a",$,[n("Algolia > Search API Parameters"),a(l)])])])])]),J,s("ul",null,[Z,ss,ns,s("li",null,[as,s("ul",null,[s("li",null,[s("a",ls,[n("DocSearch > Options > placeholder"),a(l)])])])])]),es,s("ul",null,[os,ps,rs,s("li",null,[cs,s("ul",null,[s("li",null,[s("a",ts,[n("DocSearch > Options > disableUserPersonalization"),a(l)])])])])]),Ds,s("ul",null,[is,ds,s("li",null,[ys,s("ul",null,[s("li",null,[s("a",us,[n("DocSearch > Options > initialQuery"),a(l)])])])])]),hs,s("ul",null,[vs,Cs,s("li",null,[bs,s("ul",null,[s("li",null,[s("a",ms,[n("DocSearch > Options > translations"),a(l)])])])])]),Es,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(o,{to:"/guide/i18n.html"},{default:p(()=>[n("Guide > I18n")]),_:1})])])])]),_s,s("ul",null,[gs,s("li",null,[s("p",null,[n("Default: "),a(o,{to:"/reference/config.html#base"},{default:p(()=>[n("base")]),_:1})])]),s("li",null,[As,fs,xs,s("p",null,[n("However, if the "),a(o,{to:"/reference/config.html#base"},{default:p(()=>[n("base")]),_:1}),n(" of your deployments are different for different domains, you need to set the option to the "),a(o,{to:"/reference/config.html#base"},{default:p(()=>[n("base")]),_:1}),n(" of your "),Bs,n(", so that other deployments could reuse the search index correctly.")])])]),Fs,s("p",null,[n("You can customize styles via CSS variables that provided by "),s("a",ks,[n("@docsearch/css"),a(l)]),n(":")]),ws])}const Ns=t(d,[["render",Ts],["__file","docsearch.html.vue"]]);export{Ns as default};
diff --git a/assets/docsearch.html-geU7FZc2.js b/assets/docsearch.html-geU7FZc2.js
new file mode 100644
index 000000000..c3e02f8e2
--- /dev/null
+++ b/assets/docsearch.html-geU7FZc2.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-ec0baf10","path":"/reference/plugin/docsearch.html","title":"docsearch","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/docsearch.md"}');export{e as data};
diff --git a/assets/docsearch.html-qC621Z1-.js b/assets/docsearch.html-qC621Z1-.js
new file mode 100644
index 000000000..ebdedb2ee
--- /dev/null
+++ b/assets/docsearch.html-qC621Z1-.js
@@ -0,0 +1,203 @@
+import{_ as D,r,o as t,c as i,d as l,a as s,b as n,w as o,e}from"./app-eU2v8o1B.js";const y={},d=s("h1",{id:"docsearch",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#docsearch","aria-hidden":"true"},"#"),n(" docsearch")],-1),u={href:"https://docsearch.algolia.com/",target:"_blank",rel:"noopener noreferrer"},h=e(`
`,5);function h(E,F){const p=a("ExternalLinkIcon"),o=a("RouterLink");return r(),D("div",null,[d,n("p",null,[s("默认主题将所有 "),n("a",C,[s("非全局的组件"),l(p)]),s(" 都注册了一个带 "),v,s(" 前缀的 "),l(o,{to:"/zh/reference/plugin-api.html#alias"},{default:i(()=>[s("alias")]),_:1}),s(" 。例如，"),u,s(" 的别名是 "),m,s(" 。")]),b])}const _=t(y,[["render",h],["__file","extending.html.vue"]]);export{_ as default};
diff --git a/assets/extending.html-wJrHlIH8.js b/assets/extending.html-wJrHlIH8.js
new file mode 100644
index 000000000..cae30bd9b
--- /dev/null
+++ b/assets/extending.html-wJrHlIH8.js
@@ -0,0 +1,65 @@
+import{_ as t}from"./extending-a-theme-01-xmIu-MPG.js";import{_ as c,r as a,o as r,c as i,a as n,b as s,d as e,w as D,e as l}from"./app-eU2v8o1B.js";const d={},y=l(`
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:
importtype { Theme } from'@vuepress/core'
+import { defaultTheme, typeDefaultThemeOptions } from'@vuepress/theme-default'
+import { getDirname, path } from'@vuepress/utils'
+
+const__dirname = getDirname(import.meta.url)
+
+exportconstchildTheme = (options: DefaultThemeOptions): Theme=> {
+return {
+name:'vuepress-theme-child',
+extends:defaultTheme(options),
+
+// override layouts in child theme's client config file
+// notice that you would build ts to js before publishing to npm,
+// so this should be the path to the js file
+clientConfigFile:path.resolve(__dirname, './client.js'),
+
+// override component alias
+alias: {
+'@theme/HomeFooter.vue':path.resolve(
+__dirname,
+'./components/MyHomeFooter.vue',
+ ),
+ },
+ }
+}
+
`,5);function b(f,g){const o=a("RouterLink"),p=a("ExternalLinkIcon");return r(),i("div",null,[y,n("p",null,[s("Default theme has registered "),e(o,{to:"/reference/plugin-api.html#alias"},{default:D(()=>[s("alias")]),_:1}),s(" for every "),n("a",u,[s("non-global components"),e(p)]),s(" with a "),m,s(" prefix. For example, the alias of "),v,s(" is "),C,s(".")]),h])}const x=c(d,[["render",b],["__file","extending.html.vue"]]);export{x as default};
diff --git a/assets/external-link-icon.html-DFH8UsDb.js b/assets/external-link-icon.html-DFH8UsDb.js
new file mode 100644
index 000000000..f727d2729
--- /dev/null
+++ b/assets/external-link-icon.html-DFH8UsDb.js
@@ -0,0 +1,28 @@
+import{_ as c,r as a,o as r,c as t,d as l,a as s,b as n,w as d,e}from"./app-eU2v8o1B.js";const D={},u=s("h1",{id:"external-link-icon",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#external-link-icon","aria-hidden":"true"},"#"),n(" external-link-icon")],-1),y=e(`
`,10);function h(m,b){const p=a("NpmBadge"),i=a("ExternalLinkIcon"),o=a("RouterLink");return r(),t("div",null,[u,l(p,{package:"@vuepress/plugin-external-link-icon"}),s("p",null,[n("该插件会为你 Markdown 内容中的外部链接添加一个图标，即 "),l(i)]),y,s("ul",null,[s("li",null,[n("参考： "),s("ul",null,[s("li",null,[l(o,{to:"/zh/guide/i18n.html"},{default:d(()=>[n("指南 > 多语言支持")]),_:1})])])])]),v])}const x=c(D,[["render",h],["__file","external-link-icon.html.vue"]]);export{x as default};
diff --git a/assets/external-link-icon.html-Jypp8WEn.js b/assets/external-link-icon.html-Jypp8WEn.js
new file mode 100644
index 000000000..f33103710
--- /dev/null
+++ b/assets/external-link-icon.html-Jypp8WEn.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5c864690","path":"/reference/plugin/external-link-icon.html","title":"external-link-icon","lang":"en-US","frontmatter":{},"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":"Frontmatter","slug":"frontmatter","link":"#frontmatter","children":[{"level":3,"title":"externalLinkIcon","slug":"externallinkicon","link":"#externallinkicon","children":[]}]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]},{"level":2,"title":"Components","slug":"components","link":"#components","children":[{"level":3,"title":"ExternalLinkIcon","slug":"externallinkicon-1","link":"#externallinkicon-1","children":[]}]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/external-link-icon.md"}');export{e as data};
diff --git a/assets/external-link-icon.html-hXXWH4Bv.js b/assets/external-link-icon.html-hXXWH4Bv.js
new file mode 100644
index 000000000..a3b3f05a0
--- /dev/null
+++ b/assets/external-link-icon.html-hXXWH4Bv.js
@@ -0,0 +1,28 @@
+import{_ as t,r as a,o as c,c as r,d as e,a as n,b as s,w as d,e as l}from"./app-eU2v8o1B.js";const D={},u=n("h1",{id:"external-link-icon",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#external-link-icon","aria-hidden":"true"},"#"),s(" external-link-icon")],-1),y=l(`
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.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
`,10);function v(m,b){const i=a("NpmBadge"),o=a("ExternalLinkIcon"),p=a("RouterLink");return c(),r("div",null,[u,e(i,{package:"@vuepress/plugin-external-link-icon"}),n("p",null,[s("This plugin will add an icon to the external link in your markdown content, i.e. "),e(o)]),y,n("ul",null,[n("li",null,[s("Also see: "),n("ul",null,[n("li",null,[e(p,{to:"/guide/i18n.html"},{default:d(()=>[s("Guide > I18n")]),_:1})])])])]),h])}const C=t(D,[["render",v],["__file","external-link-icon.html.vue"]]);export{C as default};
diff --git a/assets/external-link-icon.html-xe1iQbC8.js b/assets/external-link-icon.html-xe1iQbC8.js
new file mode 100644
index 000000000..bf42e7ccc
--- /dev/null
+++ b/assets/external-link-icon.html-xe1iQbC8.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-7cc40dbf","path":"/zh/reference/plugin/external-link-icon.html","title":"external-link-icon","lang":"zh-CN","frontmatter":{},"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":"Frontmatter","slug":"frontmatter","link":"#frontmatter","children":[{"level":3,"title":"externalLinkIcon","slug":"externallinkicon","link":"#externallinkicon","children":[]}]},{"level":2,"title":"样式","slug":"样式","link":"#样式","children":[]},{"level":2,"title":"组件","slug":"组件","link":"#组件","children":[{"level":3,"title":"ExternalLinkIcon","slug":"externallinkicon-1","link":"#externallinkicon-1","children":[]}]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/external-link-icon.md"}');export{e as data};
diff --git a/assets/frontmatter.html-0HrMHRj6.js b/assets/frontmatter.html-0HrMHRj6.js
new file mode 100644
index 000000000..16a56df64
--- /dev/null
+++ b/assets/frontmatter.html-0HrMHRj6.js
@@ -0,0 +1,30 @@
+import{_ as r,r as t,o as d,c,d as n,a as e,b as l,w as a,e as o}from"./app-eU2v8o1B.js";const u={},h=e("h1",{id:"frontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),l(" Frontmatter")],-1),y=e("h2",{id:"date",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#date","aria-hidden":"true"},"#"),l(" date")],-1),D=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),m=e("p",null,"Details:",-1),f=e("p",null,"Created date for the page.",-1),g=e("code",null,"yyyy-MM-dd",-1),v={href:"https://yaml.org/type/timestamp.html",target:"_blank",rel:"noopener noreferrer"},_=e("p",null,"Also see:",-1),b=e("h2",{id:"description",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#description","aria-hidden":"true"},"#"),l(" description")],-1),C=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),k=e("li",null,[e("p",null,"Details:"),e("p",null,"Description for the page."),e("p",null,[l("This will override the "),e("code",null,"description"),l(" option in your site config.")])],-1),E=e("p",null,"Also see:",-1),x=o(`
`,5),P=e("h2",{id:"lang",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#lang","aria-hidden":"true"},"#"),l(" lang")],-1),T=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),w=e("li",null,[e("p",null,"Details:"),e("p",null,"Language for the page."),e("p",null,[l("This will override the "),e("code",null,"lang"),l(" option in your site config.")])],-1),A=e("p",null,"Also see:",-1),M=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),F=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),L=e("li",null,[e("p",null,"Details:"),e("p",null,"Permalink for the page."),e("p",null,"This will override the default route path that determined by the file path of the page.")],-1),N=e("p",null,"Also see:",-1),I=e("li",null,[e("a",{href:"#permalinkpattern"},"Frontmatter > permalinkPattern")],-1),q=o(`
Then the permalink of the page would be 2021/01/03/bar-baz.html.
`,7),R=e("li",null,[e("a",{href:"#date"},"Frontmatter > date")],-1),B=e("li",null,[e("a",{href:"#permalink"},"Frontmatter > permalink")],-1),V=e("h2",{id:"routemeta",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#routemeta","aria-hidden":"true"},"#"),l(" routeMeta")],-1),Y=e("li",null,[e("p",null,[l("Type: "),e("code",null,"Record")])],-1),S=e("li",null,[e("p",null,"Details:"),e("p",null,"Custom data to be attached to the page route.")],-1),z=e("p",null,"Also see:",-1),G=e("h2",{id:"title",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#title","aria-hidden":"true"},"#"),l(" title")],-1),H=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),U=e("li",null,[e("p",null,"Details:"),e("p",null,"Title for the page."),e("p",null,[l("If you don't specify "),e("code",null,"title"),l(" in frontmatter, content of the first level-one header (i.e. "),e("code",null,"# title"),l(") will be used as the title.")])],-1),j=e("p",null,"Also see:",-1);function J(K,O){const i=t("NpmBadge"),p=t("ExternalLinkIcon"),s=t("RouterLink");return d(),c("div",null,[h,n(i,{package:"@vuepress/client"}),n(i,{package:"@vuepress/markdown"}),y,e("ul",null,[D,e("li",null,[m,f,e("p",null,[l("You should specify the date in the form of "),g,l(", or follow the "),e("a",v,[l("YAML Timestamp Type"),n(p)]),l(".")])]),e("li",null,[_,e("ul",null,[e("li",null,[n(s,{to:"/reference/node-api.html#date"},{default:a(()=>[l("Node API > Page Properties > date")]),_:1})])])])]),b,e("ul",null,[C,k,e("li",null,[E,e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#description"},{default:a(()=>[l("Config > description")]),_:1})])])])]),x,e("ul",null,[e("li",null,[l("Also see: "),e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#head"},{default:a(()=>[l("Config > head")]),_:1})])])])]),P,e("ul",null,[T,w,e("li",null,[A,e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#lang"},{default:a(()=>[l("Config > lang")]),_:1})]),e("li",null,[n(s,{to:"/reference/node-api.html#lang"},{default:a(()=>[l("Node API > Page Properties > lang")]),_:1})])])])]),M,e("ul",null,[F,L,e("li",null,[N,e("ul",null,[I,e("li",null,[n(s,{to:"/guide/page.html#routing"},{default:a(()=>[l("Guide > Page > Routing")]),_:1})]),e("li",null,[n(s,{to:"/reference/node-api.html#permalink"},{default:a(()=>[l("Node API > Page Properties > permalink")]),_:1})])])])]),q,e("ul",null,[e("li",null,[l("Also see: "),e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#permalinkpattern"},{default:a(()=>[l("Config > permalinkPattern")]),_:1})]),R,B,e("li",null,[n(s,{to:"/reference/node-api.html#permalink"},{default:a(()=>[l("Node API > Page Properties > permalink")]),_:1})])])])]),V,e("ul",null,[Y,S,e("li",null,[z,e("ul",null,[e("li",null,[n(s,{to:"/reference/node-api.html#routeMeta"},{default:a(()=>[l("Node API > Page Properties > routeMeta")]),_:1})])])])]),G,e("ul",null,[H,U,e("li",null,[j,e("ul",null,[e("li",null,[n(s,{to:"/reference/node-api.html#title"},{default:a(()=>[l("Node API > Page Properties > title")]),_:1})])])])])])}const W=r(u,[["render",J],["__file","frontmatter.html.vue"]]);export{W as default};
diff --git a/assets/frontmatter.html-3hYnultF.js b/assets/frontmatter.html-3hYnultF.js
new file mode 100644
index 000000000..aa9230484
--- /dev/null
+++ b/assets/frontmatter.html-3hYnultF.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-a566dc26","path":"/zh/reference/default-theme/frontmatter.html","title":"Frontmatter","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/default-theme/frontmatter.md"}');export{e as data};
diff --git a/assets/frontmatter.html-9z0BtxYw.js b/assets/frontmatter.html-9z0BtxYw.js
new file mode 100644
index 000000000..e3a0eb03b
--- /dev/null
+++ b/assets/frontmatter.html-9z0BtxYw.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-e5e26a84","path":"/reference/default-theme/frontmatter.html","title":"Frontmatter","lang":"en-US","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/default-theme/frontmatter.md"}');export{e as data};
diff --git a/assets/frontmatter.html-IJ5-jzXZ.js b/assets/frontmatter.html-IJ5-jzXZ.js
new file mode 100644
index 000000000..84ad15b7a
--- /dev/null
+++ b/assets/frontmatter.html-IJ5-jzXZ.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-d147334a","path":"/zh/reference/frontmatter.html","title":"Frontmatter","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/frontmatter.md"}');export{e as data};
diff --git a/assets/frontmatter.html-T5c6-cfU.js b/assets/frontmatter.html-T5c6-cfU.js
new file mode 100644
index 000000000..86af4c31a
--- /dev/null
+++ b/assets/frontmatter.html-T5c6-cfU.js
@@ -0,0 +1,60 @@
+import{_ as r,r as t,o as d,c,d as s,a as e,b as l,w as a,e as i}from"./app-eU2v8o1B.js";const u={},h=e("h1",{id:"frontmatter",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),l(" Frontmatter")],-1),D=e("h2",{id:"all-pages",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#all-pages","aria-hidden":"true"},"#"),l(" All Pages")],-1),m=e("p",null,"Frontmatter in this section will take effect in all types of pages.",-1),y=e("h3",{id:"externallinkicon",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#externallinkicon","aria-hidden":"true"},"#"),l(" externalLinkIcon")],-1),f=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),v=e("p",null,"Details:",-1),b=e("p",null,"Also see:",-1),g=e("h3",{id:"navbar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#navbar","aria-hidden":"true"},"#"),l(" navbar")],-1),_=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),k=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),C=e("p",null,"Also see:",-1),x=i(`
`,8),T=e("h3",{id:"heroimagedark",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#heroimagedark","aria-hidden":"true"},"#"),l(" heroImageDark")],-1),A=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),w=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),S=e("p",null,"Also see:",-1),L=e("li",null,[e("a",{href:"#heroimage"},"Default Theme > Frontmatter > heroImage")],-1),I=i('
',3),N=e("li",null,[e("p",null,[l("Type: "),e("code",null,"number")])],-1),F=e("li",null,[e("p",null,[l("Default: "),e("code",null,"280")])],-1),P=e("p",null,"Details:",-1),B=e("p",null,[l("Specify the "),e("code",null,"height"),l(" attribute of the hero "),e("code",null,""),l(" tag.")],-1),V=e("p",null,"You may need to reduce this value if the height of your hero image is less than the default value.",-1),j={href:"https://web.dev/cls/",target:"_blank",rel:"noopener noreferrer"},H=e("h3",{id:"herotext",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#herotext","aria-hidden":"true"},"#"),l(" heroText")],-1),M=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string | null")])],-1),G=e("p",null,"Details:",-1),R=e("p",null,"Specify the the hero text.",-1),U=e("p",null,[l("Set to "),e("code",null,"null"),l(" to disable hero text.")],-1),Y=e("h3",{id:"tagline",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#tagline","aria-hidden":"true"},"#"),l(" tagline")],-1),z=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string | null")])],-1),O=e("p",null,"Details:",-1),q=e("p",null,"Specify the the tagline.",-1),J=e("p",null,[l("Set to "),e("code",null,"null"),l(" to disable tagline.")],-1),K=i(`
---
+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),Q=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),W=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Enable the "),e("em",null,"edit this page"),l(" link in this page or not.")])],-1),X=e("p",null,"Also see:",-1),Z=e("h3",{id:"editlinkpattern",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#editlinkpattern","aria-hidden":"true"},"#"),l(" editLinkPattern")],-1),$=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),ee=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Specify the pattern of the "),e("em",null,"edit this page"),l(" link of this page.")])],-1),le=e("p",null,"Also see:",-1),se=e("h3",{id:"lastupdated",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#lastupdated","aria-hidden":"true"},"#"),l(" lastUpdated")],-1),ne=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),ae=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Enable the "),e("em",null,"last updated timestamp"),l(" in this page or not.")])],-1),ie=e("p",null,"Also see:",-1),te=e("h3",{id:"contributors",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#contributors","aria-hidden":"true"},"#"),l(" contributors")],-1),oe=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),pe=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Enable the "),e("em",null,"contributors list"),l(" in this page or not.")])],-1),re=e("p",null,"Also see:",-1),de=e("h3",{id:"sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sidebar","aria-hidden":"true"},"#"),l(" sidebar")],-1),ce=e("li",null,[e("p",null,[l("Type: "),e("code",null,"false | 'auto' | SidebarConfigArray | SidebarConfigObject")])],-1),ue=e("li",null,[e("p",null,"Details:"),e("p",null,"Configure the sidebar of this page.")],-1),he=e("p",null,"Also see:",-1),De=e("h3",{id:"sidebardepth",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sidebardepth","aria-hidden":"true"},"#"),l(" sidebarDepth")],-1),me=e("li",null,[e("p",null,[l("Type: "),e("code",null,"number")])],-1),ye=e("li",null,[e("p",null,"Details:"),e("p",null,"Configure the sidebar depth of this page.")],-1),fe=e("p",null,"Also see:",-1),ve=i(`
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(ge,_e){const o=t("NpmBadge"),n=t("RouterLink"),p=t("ExternalLinkIcon");return d(),c("div",null,[h,s(o,{package:"@vuepress/theme-default"}),D,m,y,e("ul",null,[f,e("li",null,[v,e("p",null,[l("Provided by "),s(n,{to:"/reference/plugin/external-link-icon.html#externallinkicon"},{default:a(()=>[l("@vuepress/plugin-external-link-icon")]),_:1}),l(".")])]),e("li",null,[b,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#themeplugins-externallinkicon"},{default:a(()=>[l("Default Theme > Config Reference > themePlugins.externalLinkIcon")]),_:1})])])])]),g,e("ul",null,[_,k,e("li",null,[C,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#navbar"},{default:a(()=>[l("Default Theme > Config > navbar")]),_:1})])])])]),x,e("ul",null,[e("li",null,[l("Also see: "),e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/styles.html#style-file"},{default:a(()=>[l("Default Theme > Styles > Style File")]),_:1})])])])]),E,e("ul",null,[e("li",null,[l("Also see: "),e("ul",null,[e("li",null,[s(n,{to:"/guide/assets.html#public-files"},{default:a(()=>[l("Guide > Assets > Public Files")]),_:1})])])])]),T,e("ul",null,[A,w,e("li",null,[S,e("ul",null,[L,e("li",null,[s(n,{to:"/reference/default-theme/config.html#colormode"},{default:a(()=>[l("Default Theme > Config > colorMode")]),_:1})])])])]),I,e("ul",null,[N,F,e("li",null,[P,B,V,e("p",null,[l("Notice that the height is also constrained by CSS. This attribute is to reduce "),e("a",j,[l("Cumulative Layout Shift (CLS)"),s(p)]),l(" that caused by the loading of the hero image.")])])]),H,e("ul",null,[M,e("li",null,[G,R,e("p",null,[l("This will fallback to the site "),s(n,{to:"/reference/config.html#title"},{default:a(()=>[l("title")]),_:1}),l(".")]),U])]),Y,e("ul",null,[z,e("li",null,[O,q,e("p",null,[l("This will fallback to the site "),s(n,{to:"/reference/config.html#description"},{default:a(()=>[l("description")]),_:1}),l(".")]),J])]),K,e("ul",null,[Q,W,e("li",null,[X,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#editlink"},{default:a(()=>[l("Default Theme > Config > editLink")]),_:1})])])])]),Z,e("ul",null,[$,ee,e("li",null,[le,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#editlinkpattern"},{default:a(()=>[l("Default Theme > Config > editLinkPattern")]),_:1})])])])]),se,e("ul",null,[ne,ae,e("li",null,[ie,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#lastupdated"},{default:a(()=>[l("Default Theme > Config > lastUpdated")]),_:1})])])])]),te,e("ul",null,[oe,pe,e("li",null,[re,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#contributors"},{default:a(()=>[l("Default Theme > Config > contributors")]),_:1})])])])]),de,e("ul",null,[ce,ue,e("li",null,[he,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#sidebar"},{default:a(()=>[l("Default Theme > Config > sidebar")]),_:1})])])])]),De,e("ul",null,[me,ye,e("li",null,[fe,e("ul",null,[e("li",null,[s(n,{to:"/reference/default-theme/config.html#sidebardepth"},{default:a(()=>[l("Default Theme > Config > sidebarDepth")]),_:1})])])])]),ve])}const Ce=r(u,[["render",be],["__file","frontmatter.html.vue"]]);export{Ce as default};
diff --git a/assets/frontmatter.html-UUIM54bd.js b/assets/frontmatter.html-UUIM54bd.js
new file mode 100644
index 000000000..de5e73b98
--- /dev/null
+++ b/assets/frontmatter.html-UUIM54bd.js
@@ -0,0 +1,30 @@
+import{_ as i,r as o,o as d,c,d as s,a as l,b as n,w as a,e as t}from"./app-eU2v8o1B.js";const u={},D=l("h1",{id:"frontmatter",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),n(" Frontmatter")],-1),h=l("h2",{id:"date",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#date","aria-hidden":"true"},"#"),n(" date")],-1),m=l("li",null,[l("p",null,[n("类型： "),l("code",null,"string")])],-1),y=l("p",null,"详情：",-1),_=l("p",null,"页面的创建日期。",-1),v=l("code",null,"yyyy-MM-dd",-1),b={href:"https://yaml.org/type/timestamp.html",target:"_blank",rel:"noopener noreferrer"},C=l("p",null,"参考：",-1),f=l("h2",{id:"description",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#description","aria-hidden":"true"},"#"),n(" description")],-1),g=l("li",null,[l("p",null,[n("类型： "),l("code",null,"string")])],-1),k=l("li",null,[l("p",null,"详情："),l("p",null,"页面的描述。"),l("p",null,[n("它将会覆盖站点配置中的 "),l("code",null,"description"),n(" 配置项。")])],-1),E=l("p",null,"参考：",-1),x=t(`
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),H=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"pnpm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"docs:dev")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1),z=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"yarn"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"docs:dev")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1),O=s("div",{class:"language-bash line-numbers-mode","data-ext":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"npm"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"run"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#CE9178"}},"docs:dev")]),e(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1),J={href:"http://localhost:8080",target:"_blank",rel:"noopener noreferrer"};function K(Q,U){const a=t("ExternalLinkIcon"),o=t("CodeGroupItem"),r=t("CodeGroup"),c=t("RouterLink");return p(),u("div",null,[h,s("div",y,[m,s("p",null,[e("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 "),s("a",b,[e("changelog"),n(a)]),e(" carefully each time you upgrade a RC version.")])]),g,s("ul",null,[s("li",null,[s("a",_,[e("Node.js v18.16.0+"),n(a)])]),s("li",null,[e("Package manager like "),s("a",v,[e("pnpm"),n(a)]),e(", "),s("a",C,[e("yarn"),n(a)]),e(", "),s("a",E,[e("npm"),n(a)]),e(", etc.")])]),s("div",k,[f,s("ul",null,[s("li",null,[e("When using "),s("a",A,[e("pnpm"),n(a)]),e(", you need to install "),x,e(" and "),P,e(" as peer-dependencies.")]),s("li",null,[e("When using "),s("a",N,[e("yarn 2+"),n(a)]),e(", you need to set "),w,e(" in your "),s("a",q,[S,n(a)]),e(" file.")])])]),I,n(r,null,{default:l(()=>[n(o,{title:"PNPM",active:""},{default:l(()=>[V]),_:1}),n(o,{title:"YARN"},{default:l(()=>[j]),_:1}),n(o,{title:"NPM"},{default:l(()=>[R]),_:1})]),_:1}),G,n(r,null,{default:l(()=>[n(o,{title:"PNPM",active:""},{default:l(()=>[M]),_:1}),n(o,{title:"YARN"},{default:l(()=>[L]),_:1}),n(o,{title:"NPM"},{default:l(()=>[B]),_:1})]),_:1}),s("ul",null,[s("li",null,[W,e(": Add some "),s("a",F,[e("scripts"),n(a)]),e(" to "),T])]),Y,n(r,null,{default:l(()=>[n(o,{title:"PNPM",active:""},{default:l(()=>[H]),_:1}),n(o,{title:"YARN"},{default:l(()=>[z]),_:1}),n(o,{title:"NPM"},{default:l(()=>[O]),_:1})]),_:1}),s("p",null,[e("VuePress will start a hot-reloading development server at "),s("a",J,[e("http://localhost:8080"),n(a)]),e(". When you modify your markdown files, the content in the browser will be auto updated.")]),s("p",null,[e("By now, you should have a basic but functional VuePress documentation site. Next, learn about the basics of "),n(c,{to:"/guide/configuration.html"},{default:l(()=>[e("configuration")]),_:1}),e(" in VuePress.")])])}const Z=d(D,[["render",K],["__file","getting-started.html.vue"]]);export{Z as default};
diff --git a/assets/git.html-MIFkPpVx.js b/assets/git.html-MIFkPpVx.js
new file mode 100644
index 000000000..770373311
--- /dev/null
+++ b/assets/git.html-MIFkPpVx.js
@@ -0,0 +1,30 @@
+import{_ as r,r as e,o as c,c as d,d as n,a,b as s,w as i,e as o}from"./app-eU2v8o1B.js";const D={},u=a("h1",{id:"git",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#git","aria-hidden":"true"},"#"),s(" git")],-1),h=a("p",null,"该插件会收集你的页面的 Git 信息，包括创建和更新时间、贡献者等。",-1),y=o(`
`,24);function g(C,f){const t=e("NpmBadge"),l=e("RouterLink"),p=e("ExternalLinkIcon");return c(),d("div",null,[u,n(t,{package:"@vuepress/plugin-git"}),h,a("p",null,[s("默认主题的 "),n(l,{to:"/zh/reference/default-theme/config.html#lastupdated"},{default:i(()=>[s("lastUpdated")]),_:1}),s(" 和 "),n(l,{to:"/zh/reference/default-theme/config.html#contributors"},{default:i(()=>[s("contributors")]),_:1}),s(" 就是由该插件支持的。")]),y,a("p",null,[s("该插件要求你的项目在 "),a("a",m,[s("Git 仓库"),n(p)]),s(" 下，这样它才能从提交历史记录中收集信息。")]),a("p",null,[s("在构建站点时，你应该确保所有的提交记录是可以获取到的。举例来说， CI 工作流通常会在克隆你的仓库时添加 "),a("a",v,[s("--depth 1"),n(p)]),s(" 参数来避免拉取全部的提交记录，因此你需要禁用这个功能，以便该插件在 CI 可以中正常使用。")]),b])}const x=r(D,[["render",g],["__file","git.html.vue"]]);export{x as default};
diff --git a/assets/git.html-Ztg3geGz.js b/assets/git.html-Ztg3geGz.js
new file mode 100644
index 000000000..98bebb721
--- /dev/null
+++ b/assets/git.html-Ztg3geGz.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-0f9e4c06","path":"/reference/plugin/git.html","title":"git","lang":"en-US","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/git.md"}');export{e as data};
diff --git a/assets/git.html-gg0deoQP.js b/assets/git.html-gg0deoQP.js
new file mode 100644
index 000000000..95d19ff07
--- /dev/null
+++ b/assets/git.html-gg0deoQP.js
@@ -0,0 +1,30 @@
+import{_ as r,r as n,o as c,c as d,d as a,a as e,b as s,w as i,e as o}from"./app-eU2v8o1B.js";const u={},D=e("h1",{id:"git",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#git","aria-hidden":"true"},"#"),s(" git")],-1),h=e("p",null,"This plugin will collect git information of your pages, including the created and updated time, the contributors, etc.",-1),m=o(`
This plugin is mainly used to develop themes. You won't need to use it directly in most cases.
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.
interfaceGitContributor {
+name: string
+email: string
+commits: number
+}
+
Details:
The contributors information of the page.
This attribute would also include contributors to the files listed in gitInclude.
`,24);function v(f,C){const p=n("NpmBadge"),l=n("RouterLink"),t=n("ExternalLinkIcon");return c(),d("div",null,[D,a(p,{package:"@vuepress/plugin-git"}),h,e("p",null,[s("The "),a(l,{to:"/reference/default-theme/config.html#lastupdated"},{default:i(()=>[s("lastUpdated")]),_:1}),s(" and "),a(l,{to:"/reference/default-theme/config.html#contributors"},{default:i(()=>[s("contributors")]),_:1}),s(" of default theme is powered by this plugin.")]),m,e("p",null,[s("This plugin requires your project to be inside a "),e("a",y,[s("Git Repository"),a(t)]),s(", so that it can collect information from the commit history.")]),e("p",null,[s("You should ensure all commits are available when building your site. For example, CI workflows usually clone your repository with "),e("a",g,[s("--depth 1"),a(t)]),s(" to avoid fetching all commits, so you should disable the behavior to make this plugin work properly in CI.")]),b])}const x=r(u,[["render",v],["__file","git.html.vue"]]);export{x as default};
diff --git a/assets/git.html-jPKcGQNF.js b/assets/git.html-jPKcGQNF.js
new file mode 100644
index 000000000..2bbaf920e
--- /dev/null
+++ b/assets/git.html-jPKcGQNF.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-d2322692","path":"/zh/reference/plugin/git.html","title":"git","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"Git 仓库","slug":"git-仓库","link":"#git-仓库","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","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":"页面数据","slug":"页面数据","link":"#页面数据","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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/git.md"}');export{e as data};
diff --git a/assets/google-analytics.html-M2qIk_Fo.js b/assets/google-analytics.html-M2qIk_Fo.js
new file mode 100644
index 000000000..0a6569250
--- /dev/null
+++ b/assets/google-analytics.html-M2qIk_Fo.js
@@ -0,0 +1,26 @@
+import{_ as i,r as o,o as p,c as r,d as e,a as s,b as n,e as a}from"./app-eU2v8o1B.js";const c={},d=s("h1",{id:"google-analytics",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#google-analytics","aria-hidden":"true"},"#"),n(" google-analytics")],-1),D={href:"https://analytics.google.com/",target:"_blank",rel:"noopener noreferrer"},u={href:"https://developers.google.com/analytics/devguides/collection/gtagjs",target:"_blank",rel:"noopener noreferrer"},y={href:"https://support.google.com/analytics/answer/10089681",target:"_blank",rel:"noopener noreferrer"},g=a(`
`,4),h={href:"https://support.google.com/analytics/answer/9234069",target:"_blank",rel:"noopener noreferrer"},v=s("code",null,"page_view",-1),_=s("code",null,"first_visit",-1),m=s("p",null,[n("So if you only want to collect some basic data of your site, you don't need to do anything else except setting the "),s("a",{href:"#id"},"Measurement ID"),n(" correctly.")],-1),b=s("code",null,"gtag()",-1),C=s("code",null,"window",-1),f={href:"https://developers.google.com/analytics/devguides/collection/ga4/events",target:"_blank",rel:"noopener noreferrer"},E=s("h2",{id:"options",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#options","aria-hidden":"true"},"#"),n(" Options")],-1),x=s("h3",{id:"id",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#id","aria-hidden":"true"},"#"),n(" id")],-1),k=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),A=s("p",null,"Details:",-1),X=s("p",null,[n("The Measurement ID of Google Analytics 4, which should start with "),s("code",null,"'G-'"),n(".")],-1),w={href:"https://support.google.com/analytics/answer/9539598",target:"_blank",rel:"noopener noreferrer"},I=s("li",null,[s("p",null,"Example:")],-1),G=a(`
`,1);function M(S,j){const t=o("NpmBadge"),l=o("ExternalLinkIcon");return p(),r("div",null,[d,e(t,{package:"@vuepress/plugin-google-analytics"}),s("p",null,[n("Integrate "),s("a",D,[n("Google Analytics"),e(l)]),n(" into VuePress.")]),s("p",null,[n("This plugin will import "),s("a",u,[n("gtag.js"),e(l)]),n(" for "),s("a",y,[n("Google Analytics 4"),e(l)]),n(".")]),g,s("p",null,[n("Google Analytics will "),s("a",h,[n("automatically collect some events"),e(l)]),n(", such as "),v,n(", "),_,n(", etc.")]),m,s("p",null,[n("After using this plugin, the global "),b,n(" function is available on the "),C,n(" object, and you can use it for "),s("a",f,[n("custom events reporting"),e(l)]),n(".")]),E,x,s("ul",null,[k,s("li",null,[A,X,s("p",null,[n("You can follow the instructions "),s("a",w,[n("here"),e(l)]),n(' 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).')])]),I]),G,s("ul",null,[F,s("li",null,[N,s("p",null,[n("Set to "),V,n(" to enable sending events to DebugView. "),s("a",T,[n("See more information on DebugView"),e(l)]),n(".")])]),B]),P])}const L=i(c,[["render",M],["__file","google-analytics.html.vue"]]);export{L as default};
diff --git a/assets/google-analytics.html-WyEii0XV.js b/assets/google-analytics.html-WyEii0XV.js
new file mode 100644
index 000000000..9141fcff8
--- /dev/null
+++ b/assets/google-analytics.html-WyEii0XV.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-07ca2692","path":"/zh/reference/plugin/google-analytics.html","title":"google-analytics","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"上报事件","slug":"上报事件","link":"#上报事件","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"id","slug":"id","link":"#id","children":[]},{"level":3,"title":"debug","slug":"debug","link":"#debug","children":[]}]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/google-analytics.md"}');export{e as data};
diff --git a/assets/google-analytics.html-ncL2DNzR.js b/assets/google-analytics.html-ncL2DNzR.js
new file mode 100644
index 000000000..6a7cc5c8d
--- /dev/null
+++ b/assets/google-analytics.html-ncL2DNzR.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-b3f1b470","path":"/reference/plugin/google-analytics.html","title":"google-analytics","lang":"en-US","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/google-analytics.md"}');export{e as data};
diff --git a/assets/google-analytics.html-p-WIn3G5.js b/assets/google-analytics.html-p-WIn3G5.js
new file mode 100644
index 000000000..0bf14ea14
--- /dev/null
+++ b/assets/google-analytics.html-p-WIn3G5.js
@@ -0,0 +1,26 @@
+import{_ as i,r as o,o as t,c as r,d as e,a as s,b as n,e as a}from"./app-eU2v8o1B.js";const c={},d=s("h1",{id:"google-analytics",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#google-analytics","aria-hidden":"true"},"#"),n(" google-analytics")],-1),D={href:"https://analytics.google.com/",target:"_blank",rel:"noopener noreferrer"},u={href:"https://developers.google.com/analytics/devguides/collection/gtagjs",target:"_blank",rel:"noopener noreferrer"},y={href:"https://support.google.com/analytics/answer/10089681",target:"_blank",rel:"noopener noreferrer"},g=a(`
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:
Nuxt is an outstanding Vue SSR framework, and it is capable of doing what VuePress does. But Nuxt is designed for building applications, while VuePress is more lightweight and focused on content-centric static sites.
VitePress is the little brother of VuePress. It's also created and maintained by our Vue.js team. It's even more lightweight and faster than VuePress. However, as a tradeoff, it's more opinionated and less configurable. For example, it does not support plugins. But VitePress is powerful enough to make your content online if you don't need advanced customizations.
It might not be an appropriate comparison, but you can take VuePress and VitePress as Laravel and Lumen.
Both are great projects and also Vue-powered. Except they are both fully runtime-driven and therefore not SEO-friendly. If you don’t care for SEO and don’t want to mess with installing dependencies, these are still great choices.
Hexo has been serving the Vue 2.x docs well. The biggest problem is that its theming system is static and string-based - we want to take advantage of Vue for both the layout and the interactivity. Also, Hexo’s Markdown rendering isn’t the most flexible to configure.
We’ve been using GitBook for most of our sub project docs. The primary problem with GitBook is that its development reload performance is intolerable with a large amount of files. The default theme also has a pretty limiting navigation structure, and the theming system is, again, not Vue based. The team behind GitBook is also more focused on turning it into a commercial product rather than an open-source tool.
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(u,v){const a=p("RouterLink");return t(),r("div",null,[D,y,n("p",null,[s("With the help of "),e(a,{to:"/reference/theme-api.html"},{default:l(()=>[s("Theme API")]),_:1}),s(", you can make your theme extendable, allowing users to make their own modifications easily.")]),n("p",null,[s("You must have known that how to "),e(a,{to:"/reference/default-theme/extending.html"},{default:l(()=>[s("extend default theme")]),_:1}),s(". Here we'll introduce how to make your own theme extendable like default theme.")]),d])}const h=o(i,[["render",m],["__file","making-a-theme-extendable.html.vue"]]);export{h as default};
diff --git a/assets/making-a-theme-extendable.html-meYav6NP.js b/assets/making-a-theme-extendable.html-meYav6NP.js
new file mode 100644
index 000000000..dfb6c7980
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-meYav6NP.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":{},"headers":[{"level":2,"title":"布局插槽","slug":"布局插槽","link":"#布局插槽","children":[]},{"level":2,"title":"组件别名","slug":"组件别名","link":"#组件别名","children":[]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/advanced/cookbook/making-a-theme-extendable.md"}');export{e as data};
diff --git a/assets/making-a-theme-extendable.html-rrr09wUd.js b/assets/making-a-theme-extendable.html-rrr09wUd.js
new file mode 100644
index 000000000..158f7da26
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-rrr09wUd.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":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"advanced/cookbook/making-a-theme-extendable.md"}');export{e as data};
diff --git a/assets/making-a-theme-extendable.html-wDYHhuw8.js b/assets/making-a-theme-extendable.html-wDYHhuw8.js
new file mode 100644
index 000000000..d9b43a05f
--- /dev/null
+++ b/assets/making-a-theme-extendable.html-wDYHhuw8.js
@@ -0,0 +1,35 @@
+import{_ as p,r as o,o as t,c as r,a as n,b as s,d as l,w as e,e as c}from"./app-eU2v8o1B.js";const D={},i=n("h1",{id:"开发一个可继承的主题",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#开发一个可继承的主题","aria-hidden":"true"},"#"),s(" 开发一个可继承的主题")],-1),y=n("p",null,"有时用户可能希望对一个主题进行一些小改动，但是又不想 Fork 并修改整个项目。",-1),d=c(`
`,11);function C(v,u){const a=o("RouterLink");return t(),r("div",null,[i,y,n("p",null,[s("借助于 "),l(a,{to:"/zh/reference/theme-api.html"},{default:e(()=>[s("主题 API")]),_:1}),s(" ，你可以让用户继承你的主题，允许用户对你的主题进行改动。")]),n("p",null,[s("你肯定已经知道了如何 "),l(a,{to:"/zh/reference/default-theme/extending.html"},{default:e(()=>[s("继承默认主题")]),_:1}),s(" 。接下来我们将介绍如何让你的主题像默认主题一样被用户继承。")]),d])}const b=p(D,[["render",C],["__file","making-a-theme-extendable.html.vue"]]);export{b as default};
diff --git a/assets/markdown-and-vue-sfc.html-4gGUwagr.js b/assets/markdown-and-vue-sfc.html-4gGUwagr.js
new file mode 100644
index 000000000..0b673decf
--- /dev/null
+++ b/assets/markdown-and-vue-sfc.html-4gGUwagr.js
@@ -0,0 +1,31 @@
+import{_ as p,g as t,o as c,c as r,a as s,t as a,d as i,w as D,e as d,h as y}from"./app-eU2v8o1B.js";const u=d(`
Each Markdown file is first compiled into HTML, and then converted to a Vue SFC. In other words, you can write a Markdown file like a Vue SFC:
Blocks <script> and <style> are treated as Vue SFC blocks as they are. In other words, they are hoisted from the <template> block to the top-level of SFC.
Everything outside <script> and <style> will be compiled into HTML, and be treated as Vue SFC <template> block.
WARNING
As Vue SFC can contain only one <script> element, you should avoid using more than one <script> in VuePress markdown.
`,8),v="Vue in Markdown",C={__name:"markdown-and-vue-sfc.html",setup(m){const e=(o,n)=>y("div",{class:"red-div"},n.slots.default()),l=t(0);return(o,n)=>(c(),r("div",null,[u,s("p",null,[s("em",null,"Hello, "+a(v))]),i(e,null,{default:D(()=>[s("p",null,[s("em",null,"Current count is: "+a(l.value),1)])]),_:1}),s("p",null,[s("button",{onClick:n[0]||(n[0]=b=>l.value++)},"Click Me!")])]))}},h=p(C,[["__file","markdown-and-vue-sfc.html.vue"]]);export{h as default};
diff --git a/assets/markdown-and-vue-sfc.html-7cfmbOwj.js b/assets/markdown-and-vue-sfc.html-7cfmbOwj.js
new file mode 100644
index 000000000..78be388c7
--- /dev/null
+++ b/assets/markdown-and-vue-sfc.html-7cfmbOwj.js
@@ -0,0 +1,31 @@
+import{_ as o,g as c,o as t,c as r,a as s,t as a,d as i,w as D,e as d,h as y}from"./app-eU2v8o1B.js";const v=d(`
\`\`\`ts
+// 行号默认是启用的
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+\`\`\`
+
+\`\`\`ts:no-line-numbers
+// 行号被禁用
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+\`\`\`
+
输出
// 行号默认是启用的
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+
// 行号被禁用
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+
::: tip
+This is a tip
+:::
+
+::: warning
+This is a warning
+:::
+
+::: danger
+This is a dangerous warning
+:::
+
+::: details
+This is a details block
+:::
+
Output
TIP
This is a tip
WARNING
This is a warning
DANGER
This is a dangerous warning
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!')
+\`\`\`
+
+:::
+
`,17),f=s("div",{class:"language-typescript line-numbers-mode","data-ext":"ts"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#4FC1FF"}},"foo"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},"'foo'")]),n(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1),x=s("div",{class:"language-typescript line-numbers-mode","data-ext":"ts"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#D4D4D4"}}," "),s("span",{style:{color:"#4FC1FF"}},"bar"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},"'bar'")]),n(`
+`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1);function w(F,T){const c=e("NpmBadge"),i=e("RouterLink"),o=e("CodeGroupItem"),t=e("CodeGroup");return r(),u("div",null,[v,a(c,{package:"@vuepress/theme-default"}),m,s("ul",null,[s("li",null,[b,s("ul",null,[y,g,h,_,s("li",null,[n("Alias of "),a(i,{to:"/reference/default-theme/components.html#codegroup"},{default:l(()=>[n("CodeGroup")]),_:1}),n(" and "),a(i,{to:"/reference/default-theme/components.html#codegroupitem"},{default:l(()=>[n("CodeGroupItem")]),_:1}),n(": "),k])])]),C]),E,a(t,null,{default:l(()=>[a(o,{title:"FOO"},{default:l(()=>[f]),_:1}),a(o,{title:"BAR"},{default:l(()=>[x]),_:1})]),_:1})])}const N=d(D,[["render",w],["__file","markdown.html.vue"]]);export{N as default};
diff --git a/assets/markdown.html-RaKgDcuz.js b/assets/markdown.html-RaKgDcuz.js
new file mode 100644
index 000000000..5b62b989a
--- /dev/null
+++ b/assets/markdown.html-RaKgDcuz.js
@@ -0,0 +1,129 @@
+import{_ as D,r as p,o as r,c,a as s,b as n,d as e,w as a,F as h,f as m,t as y,e as i}from"./app-eU2v8o1B.js";const v={},b=s("h1",{id:"markdown",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#markdown","aria-hidden":"true"},"#"),n(" Markdown")],-1),g={href:"https://commonmark.org/help/",target:"_blank",rel:"noopener noreferrer"},f=s("h2",{id:"syntax-extensions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#syntax-extensions","aria-hidden":"true"},"#"),n(" Syntax Extensions")],-1),k={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"},_={href:"https://github.com/markdown-it/markdown-it#syntax-extensions",target:"_blank",rel:"noopener noreferrer"},C=s("p",null,"This section will introduce built-in Markdown syntax extensions of VuePress.",-1),E=s("h3",{id:"embedded",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#embedded","aria-hidden":"true"},"#"),n(" Embedded")],-1),w=s("p",null,"Embedded by markdown-it:",-1),x={href:"https://help.github.com/articles/organizing-information-with-tables/",target:"_blank",rel:"noopener noreferrer"},F={href:"https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text",target:"_blank",rel:"noopener noreferrer"},T=s("h3",{id:"header-anchors",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#header-anchors","aria-hidden":"true"},"#"),n(" Header Anchors")],-1),A=s("p",null,[n("You might have noticed that, a "),s("code",null,"#"),n(" anchor is displayed when you hover the mouse on the headers of each section. By clicking the "),s("code",null,"#"),n(" anchor, you can jump to the section directly.")],-1),M={class:"custom-container tip"},j=s("p",{class:"custom-container-title"},"TIP",-1),L={href:"https://github.com/valeriangalliat/markdown-it-anchor",target:"_blank",rel:"noopener noreferrer"},I=s("h3",{id:"links",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#links","aria-hidden":"true"},"#"),n(" Links")],-1),R={href:"https://spec.commonmark.org/0.29/#link-reference-definitions",target:"_blank",rel:"noopener noreferrer"},V=i(`
Take our documentation source files as an example:
└─docs
+├─guide
+│├─getting-started.md
+│├─markdown.md# <- Here we are
+│└─README.md
+├─reference
+│└─config.md
+└─README.md
+
`,7),P=s("br",null,null,-1),q=s("br",null,null,-1),B=s("br",null,null,-1),H=s("br",null,null,-1),O=s("br",null,null,-1),S={href:"https://github.com",target:"_blank",rel:"noopener noreferrer"},N=s("p",null,[s("strong",null,"Explanation")],-1),G=s("li",null,[n("Internal links will be converted to "),s("code",null,""),n(" for SPA navigation.")],-1),U=s("code",null,".md",-1),Y=s("li",null,[n("External links will get "),s("code",null,'target="_blank" rel="noopener noreferrer"'),n(" attrs.")],-1),W=s("p",null,[s("strong",null,"Suggestion")],-1),z=s("p",null,"Try to use relative paths instead of absolute paths for internal links to markdown files.",-1),J=s("ul",null,[s("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."),s("li",null,"Relative paths are consistent in different locales, so you don't need to change the locale path when translating your content.")],-1),X={class:"custom-container tip"},K=s("p",{class:"custom-container-title"},"TIP",-1),Q=s("p",null,"This links extension is supported by our built-in plugin.",-1),Z=s("h3",{id:"emoji",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#emoji","aria-hidden":"true"},"#"),n(" Emoji 🎉")],-1),$=s("p",null,[n("You can add emoji to your Markdown content by typing "),s("code",null,":EMOJICODE:"),n(".")],-1),ss={href:"https://github.com/ikatyang/emoji-cheat-sheet",target:"_blank",rel:"noopener noreferrer"},ns=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),ts={class:"table-of-contents"},is=s("p",null,[n("The headers in TOC will link to the corresponding "),s("a",{href:"#header-anchors"},"header anchors"),n(", so TOC won't work well if you disable header anchors.")],-1),ps={class:"custom-container tip"},rs=s("p",{class:"custom-container-title"},"TIP",-1),cs={href:"https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc",target:"_blank",rel:"noopener noreferrer"},ds=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
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+\`\`\`
+
+\`\`\`ts:no-line-numbers
+// line-numbers is disabled
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+\`\`\`
+
Output
// line-numbers is enabled by default
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+
// line-numbers is disabled
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+
`,8),ys={class:"custom-container tip"},vs=s("p",{class:"custom-container-title"},"TIP",-1),bs=s("p",null,"This line numbers extension is supported by our built-in plugin.",-1),gs=s("h4",{id:"wrap-with-v-pre",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#wrap-with-v-pre","aria-hidden":"true"},"#"),n(" Wrap with v-pre")],-1),fs=s("p",null,[n("As "),s("a",{href:"#template-syntax"},"template syntax is allowed in Markdown"),n(", it would also work in code blocks, too.")],-1),ks={href:"https://vuejs.org/api/built-in-directives.html#v-pre",target:"_blank",rel:"noopener noreferrer"},_s=i(`
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
+<!-- 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
+constonePlusTwoPlusThree = {{ 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
+
// This won't be compiled correctly because of js syntax highlighting
+constonePlusTwoPlusThree = {{ 1 + 2 + 3 }}
+
`,8),Cs={class:"custom-container tip"},Es=s("p",{class:"custom-container-title"},"TIP",-1),ws=s("p",null,"This v-pre extension is supported by our built-in plugin.",-1),xs=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),Fs={class:"custom-container tip"},Ts=s("p",{class:"custom-container-title"},"TIP",-1),As=s("p",null,"This import code extension is supported by our built-in plugin.",-1),Ms=s("h2",{id:"using-vue-in-markdown",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#using-vue-in-markdown","aria-hidden":"true"},"#"),n(" Using Vue in Markdown")],-1),js=s("p",null,"This section will introduce some basic usage of Vue in Markdown.",-1),Ls=s("h3",{id:"template-syntax",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#template-syntax","aria-hidden":"true"},"#"),n(" Template Syntax")],-1),Is=s("p",null,"As we know:",-1),Rs=s("ul",null,[s("li",null,"HTML is allowed in Markdown."),s("li",null,"Vue template syntax is compatible with HTML.")],-1),Vs={href:"https://vuejs.org/guide/essentials/template-syntax.html",target:"_blank",rel:"noopener noreferrer"},Ps=i(`
Input
One plus one equals: {{ 1 + 1 }}
+
+<span v-for="i in 3"> span: {{ i }} </span>
+
This is default theme built-in `<Badge />` component <Badge text="demo" />\n
Output
',5),Bs=s("code",null,"",-1),Hs={class:"custom-container tip"},Os=s("p",{class:"custom-container-title"},"TIP",-1),Ss=s("h2",{id:"cautions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#cautions","aria-hidden":"true"},"#"),n(" Cautions")],-1),Ns=s("h3",{id:"non-standard-html-tags",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#non-standard-html-tags","aria-hidden":"true"},"#"),n(" Non-Standard HTML Tags")],-1),Gs=s("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),Us={href:"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/center",target:"_blank",rel:"noopener noreferrer"},Ys={href:"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/font",target:"_blank",rel:"noopener noreferrer"},Ws={href:"https://developer.mozilla.org/en-US/docs/Web/MathML",target:"_blank",rel:"noopener noreferrer"},zs=s("p",null,"If you want to use those tags anyway, try either of the following workarounds:",-1),Js={href:"https://vuejs.org/api/built-in-directives.html#v-pre",target:"_blank",rel:"noopener noreferrer"},Xs={href:"https://vuejs.org/api/application.html#app-config-compileroptions",target:"_blank",rel:"noopener noreferrer"},Ks=s("code",null,"@bundler-webpack",-1),Qs=s("code",null,"@bundler-vite",-1);function Zs($s,sn){const o=p("ExternalLinkIcon"),l=p("RouterLink"),t=p("router-link"),d=p("Badge");return r(),c("div",null,[b,s("p",null,[n("Make sure you already know Markdown well before reading this section. If not, please learn some "),s("a",g,[n("Markdown tutorials"),e(o)]),n(" first.")]),f,s("p",null,[n("The Markdown content in VuePress will be parsed by "),s("a",k,[n("markdown-it"),e(o)]),n(", which supports "),s("a",_,[n("syntax extensions"),e(o)]),n(" via markdown-it plugins.")]),C,s("p",null,[n("You can also configure those built-in extensions, load more markdown-it plugins and implement your own extensions via "),e(l,{to:"/reference/config.html#markdown"},{default:a(()=>[n("markdown")]),_:1}),n(" option and "),e(l,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:a(()=>[n("extendsMarkdown")]),_:1}),n(" option.")]),E,w,s("ul",null,[s("li",null,[s("a",x,[n("Tables"),e(o)]),n(" (GFM)")]),s("li",null,[s("a",F,[n("Strikethrough"),e(o)]),n(" (GFM)")])]),T,A,s("div",M,[j,s("p",null,[n("This header anchors extension is supported by "),s("a",L,[n("markdown-it-anchor"),e(o)]),n(".")]),s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-anchor"},{default:a(()=>[n("markdown.anchor")]),_:1})])]),I,s("p",null,[n("When using Markdown "),s("a",R,[n("link syntax"),e(o)]),n(", VuePress will implement some conversions for you.")]),V,s("p",null,[e(l,{to:"/"},{default:a(()=>[n("Home")]),_:1}),P,e(l,{to:"/reference/config.html"},{default:a(()=>[n("Config Reference")]),_:1}),q,e(l,{to:"/guide/getting-started.html"},{default:a(()=>[n("Getting Started")]),_:1}),B,e(l,{to:"/guide/"},{default:a(()=>[n("Guide")]),_:1}),H,e(l,{to:"/reference/config.html#links"},{default:a(()=>[n("Config Reference > markdown.links")]),_:1}),O,s("a",S,[n("GitHub"),e(o)])]),N,s("ul",null,[G,s("li",null,[n("Internal links to "),U,n(" files will be converted to the "),e(l,{to:"/guide/page.html#routing"},{default:a(()=>[n("page route path")]),_:1}),n(", and both absolute path and relative path are supported.")]),Y]),W,z,J,s("div",X,[K,Q,s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-links"},{default:a(()=>[n("markdown.links")]),_:1})])]),Z,$,s("p",null,[n("For a full list of available emoji and codes, check out "),s("a",ss,[n("emoji-cheat-sheet"),e(o)]),n(".")]),ns,s("div",es,[as,s("p",null,[n("This emoji extension is supported by "),s("a",ls,[n("markdown-it-emoji"),e(o)]),n(".")]),s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-emoji"},{default:a(()=>[n("markdown.emoji")]),_:1})])]),os,s("nav",ts,[s("ul",null,[s("li",null,[e(t,{to:"#syntax-extensions"},{default:a(()=>[n("Syntax Extensions")]),_:1}),s("ul",null,[s("li",null,[e(t,{to:"#embedded"},{default:a(()=>[n("Embedded")]),_:1})]),s("li",null,[e(t,{to:"#header-anchors"},{default:a(()=>[n("Header Anchors")]),_:1})]),s("li",null,[e(t,{to:"#links"},{default:a(()=>[n("Links")]),_:1})]),s("li",null,[e(t,{to:"#emoji"},{default:a(()=>[n("Emoji 🎉")]),_:1})]),s("li",null,[e(t,{to:"#table-of-contents"},{default:a(()=>[n("Table of Contents")]),_:1})]),s("li",null,[e(t,{to:"#code-blocks"},{default:a(()=>[n("Code Blocks")]),_:1})]),s("li",null,[e(t,{to:"#import-code-blocks"},{default:a(()=>[n("Import Code Blocks")]),_:1})])])]),s("li",null,[e(t,{to:"#using-vue-in-markdown"},{default:a(()=>[n("Using Vue in Markdown")]),_:1}),s("ul",null,[s("li",null,[e(t,{to:"#template-syntax"},{default:a(()=>[n("Template Syntax")]),_:1})]),s("li",null,[e(t,{to:"#components"},{default:a(()=>[n("Components")]),_:1})])])]),s("li",null,[e(t,{to:"#cautions"},{default:a(()=>[n("Cautions")]),_:1}),s("ul",null,[s("li",null,[e(t,{to:"#non-standard-html-tags"},{default:a(()=>[n("Non-Standard HTML Tags")]),_:1})])])])])]),is,s("div",ps,[rs,s("p",null,[n("This toc extension is supported by "),s("a",cs,[n("@mdit-vue/plugin-toc"),e(o)]),n(".")]),s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-toc"},{default:a(()=>[n("markdown.toc")]),_:1})])]),ds,s("div",us,[Ds,s("p",null,[n("This line highlighting extension is supported by our built-in plugin, which is forked and modified from "),s("a",hs,[n("markdown-it-highlight-lines"),e(o)]),n(".")]),s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-code-highlightlines"},{default:a(()=>[n("markdown.code.highlightLines")]),_:1})])]),ms,s("div",ys,[vs,bs,s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-code-linenumbers"},{default:a(()=>[n("markdown.code.lineNumbers")]),_:1})])]),gs,fs,s("p",null,[n("To avoid your code blocks being compiled by Vue, VuePress will add "),s("a",ks,[n("v-pre"),e(o)]),n(" directive to your code blocks by default, which can be disabled in config.")]),_s,s("div",Cs,[Es,ws,s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-code-vpre-block"},{default:a(()=>[n("markdown.code.vPre.block")]),_:1})])]),xs,s("div",Fs,[Ts,As,s("p",null,[n("Config reference: "),e(l,{to:"/reference/config.html#markdown-importcode"},{default:a(()=>[n("markdown.importCode")]),_:1})])]),Ms,js,s("p",null,[n("Check out "),e(l,{to:"/advanced/cookbook/markdown-and-vue-sfc.html"},{default:a(()=>[n("Cookbook > Markdown and Vue SFC")]),_:1}),n(" for more details.")]),Ls,Is,Rs,s("p",null,[n("That means, "),s("a",Vs,[n("Vue template syntax"),e(o)]),n(" is allowed in Markdown.")]),Ps,s("p",null,[(r(),c(h,null,m(3,u=>s("span",null," span: "+y(u),1)),64))]),qs,s("p",null,[n("This is default theme built-in "),Bs,n(" component "),e(d,{text:"demo"})]),s("div",Hs,[Os,s("p",null,[n("Check out the "),e(l,{to:"/reference/components.html"},{default:a(()=>[n("Built-in Components")]),_:1}),n(" for a full list of built-in components.")]),s("p",null,[n("Check out the "),e(l,{to:"/reference/default-theme/components.html"},{default:a(()=>[n("Default Theme > Built-in Components")]),_:1}),n(" for a full list of default theme built-in components.")])]),Ss,Ns,Gs,s("ul",null,[s("li",null,[n("Deprecated HTML tags such as "),s("a",Us,[n("
"),e(o)]),n(" and "),s("a",Ys,[n(""),e(o)]),n(".")]),s("li",null,[s("a",Ws,[n("MathML tags"),e(o)]),n(", which might be used by some markdown-it LaTeX plugin.")])]),zs,s("ul",null,[s("li",null,[n("Adding a "),s("a",Js,[n("v-pre"),e(o)]),n(" directive to skip the compilation of the element and its children. Notice that the template syntax would also be invalid.")]),s("li",null,[n("Using "),s("a",Xs,[n("compilerOptions.isCustomElement"),e(o)]),n(" to tell Vue template compiler not try to resolve them as components. "),s("ul",null,[s("li",null,[n("For "),Ks,n(", set "),e(l,{to:"/reference/bundler/webpack.html#vue"},{default:a(()=>[n("vue.compilerOptions")]),_:1})]),s("li",null,[n("For "),Qs,n(", set "),e(l,{to:"/reference/bundler/vite.html#vuepluginoptions"},{default:a(()=>[n("vuePluginOptions.template.compilerOptions")]),_:1})])])])])])}const en=D(v,[["render",Zs],["__file","markdown.html.vue"]]);export{en as default};
diff --git a/assets/markdown.html-XKozsizF.js b/assets/markdown.html-XKozsizF.js
new file mode 100644
index 000000000..fea29888f
--- /dev/null
+++ b/assets/markdown.html-XKozsizF.js
@@ -0,0 +1 @@
+const l=JSON.parse('{"key":"v-6a0a3d62","path":"/zh/guide/markdown.html","title":"Markdown","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/guide/markdown.md"}');export{l as data};
diff --git a/assets/markdown.html-f0CKPNMw.js b/assets/markdown.html-f0CKPNMw.js
new file mode 100644
index 000000000..6986ac1e5
--- /dev/null
+++ b/assets/markdown.html-f0CKPNMw.js
@@ -0,0 +1,50 @@
+import{_ as r,r as e,o as t,c as u,d as l,a as s,w as a,b as n,e as p}from"./app-eU2v8o1B.js";const D={},v=s("h1",{id:"markdown",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#markdown","aria-hidden":"true"},"#"),n(" Markdown")],-1),m=s("h2",{id:"自定义容器",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#自定义容器","aria-hidden":"true"},"#"),n(" 自定义容器")],-1),b=p(`
`,5),g=s("p",null,"Details:",-1),C=s("code",null,"Zoom",-1),f={href:"https://github.com/francoischalifour/medium-zoom#methods",target:"_blank",rel:"noopener noreferrer"},_=s("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),z=s("p",null,[n("This plugin adds an extra "),s("code",null,"refresh"),n(" method on the "),s("code",null,"Zoom"),n(" instance, which will call "),s("code",null,"zoom.detach()"),n(" then "),s("code",null,"zoom.attach()"),n(" with the "),s("a",{href:"#selector"},"selector"),n(" as the default parameter. It will help you to refresh the zoomable images for current page.")],-1),x=s("li",null,[s("p",null,"Example:")],-1),E=l(`
import { nextTick } from'vue'
+import { useMediumZoom } from'@vuepress/plugin-medium-zoom/client'
+
+exportdefault {
+setup() {
+constzoom = 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 k(A,w){const i=o("NpmBadge"),a=o("ExternalLinkIcon");return t(),r("div",null,[d,e(i,{package:"@vuepress/plugin-medium-zoom"}),s("p",null,[n("Integrate "),s("a",m,[n("medium-zoom"),e(a)]),n(" into VuePress, which can provide the ability to zoom images.")]),D,s("ul",null,[u,h,s("li",null,[y,s("ul",null,[s("li",null,[s("a",v,[n("medium-zoom > Options"),e(a)])])])])]),b,s("ul",null,[s("li",null,[g,s("p",null,[n("Returns the "),C,n(" instance that used by this plugin, so that you can use the instance "),s("a",f,[n("methods"),e(a)]),n(" directly.")]),_,z]),x]),E])}const B=p(c,[["render",k],["__file","medium-zoom.html.vue"]]);export{B as default};
diff --git a/assets/migration.html-j6eU3LYG.js b/assets/migration.html-j6eU3LYG.js
new file mode 100644
index 000000000..b741dfd8c
--- /dev/null
+++ b/assets/migration.html-j6eU3LYG.js
@@ -0,0 +1,97 @@
+import{_ as o,r as d,o as c,c as r,a as s,b as e,d as a,w as l,e as i}from"./app-eU2v8o1B.js";const t={},p=i(`
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),v=n("p",null,[e("Default value is changed from "),n("code",null,"false"),e(" to "),n("code",null,"true"),e(".")],-1),f=n("h4",{id:"markdown-pagesuffix",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-pagesuffix","aria-hidden":"true"},"#"),e(" markdown.pageSuffix")],-1),g=n("p",null,"Removed.",-1),y=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),C=n("h4",{id:"markdown-plugins",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-plugins","aria-hidden":"true"},"#"),e(" markdown.plugins")],-1),k=n("p",null,"Removed.",-1),D=n("h4",{id:"markdown-extendmarkdown",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-extendmarkdown","aria-hidden":"true"},"#"),e(" markdown.extendMarkdown")],-1),x=n("p",null,"Removed.",-1),w=n("h4",{id:"markdown-extractheaders",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#markdown-extractheaders","aria-hidden":"true"},"#"),e(" markdown.extractHeaders")],-1),E=o(`
`,5),T=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),F=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),V=n("p",null,"Theme authors can use their own way to allow users to customize styles, and not be limited with stylus.",-1),I=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),M=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),X=n("p",null,[e("Renamed to "),n("code",null,".vuepress/client.{js,ts}"),e(", and the usage has been changed, too.")],-1),j=n("h4",{id:"vuepress-components",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#vuepress-components","aria-hidden":"true"},"#"),e(" .vuepress/components/")],-1),R=n("p",null,"Files in this directory will not be registered as Vue components automatically.",-1),W=n("code",null,".vuepress/client.{js,ts}",-1),Y=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),q=o(`
Markdown image syntax does not support webpack aliases anymore. Links without ./ prefix are also treated as relative links, which is aligned with the behavior of the native markdown image syntax. If you want to use aliases in image paths, or use images from external packages, you should use <img> tag instead.
-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.
`,13),U=n("h4",{id:"theme-config",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#theme-config","aria-hidden":"true"},"#"),e(" Theme Config")],-1),G=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),z=o(`
`,10),L=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),$=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=o('
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),K=n("p",null,"Some major breaking changes:",-1),Q=n("strong",null,"conventional theme directory structure",-1),Z=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),se=o("
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),ae=n("code",null,"themeConfig",-1),le=n("code",null,"themeConfig",-1),oe=n("code",null,"this.$site.themeConfig",-1),ie=n("code",null,"useThemeData",-1),te=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),ve=n("code",null,"@theme",-1),fe=n("code",null,"@parent-theme",-1);function ge(ye,be){const s=t("RouterLink");return d(),r("div",null,[p,n("p",null,[e("You can watch files manually in "),a(s,{to:"/reference/plugin-api.html#onwatched"},{default:l(()=>[e("onWatched")]),_:1}),e(" hook.")]),u,h,m,n("p",null,[e("Moved to "),a(s,{to:"/reference/config.html#markdown-code-linenumbers"},{default:l(()=>[e("markdown.code.lineNumbers")]),_:1}),e(".")]),v,f,g,y,n("p",null,[e("Moved to "),a(s,{to:"/reference/config.html#markdown-links"},{default:l(()=>[e("markdown.links.externalAttrs")]),_:1}),e(".")]),b,_,n("p",null,[e("See "),a(s,{to:"/reference/config.html#markdown-toc"},{default:l(()=>[e("Config > markdown.toc")]),_:1})]),C,k,n("p",null,[e("Use markdown-it plugins in "),a(s,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:l(()=>[e("extendsMarkdown")]),_:1}),e(" hook.")]),D,x,n("p",null,[e("Use "),a(s,{to:"/reference/plugin-api.html#extendsmarkdown"},{default:l(()=>[e("extendsMarkdown")]),_:1}),e(" hook.")]),w,n("p",null,[e("Moved to "),a(s,{to:"/reference/config.html#markdown-headers"},{default:l(()=>[e("markdown.headers")]),_:1}),e(".")]),E,n("p",null,[e("Please refer to "),a(s,{to:"/guide/bundler.html"},{default:l(()=>[e("Guide > Bundler")]),_:1}),e(".")]),A,B,S,n("p",null,[e("Use "),a(s,{to:"/reference/frontmatter.html#head"},{default:l(()=>[e("head")]),_:1}),e(" instead. For example:")]),P,n("p",null,[e("See "),a(s,{to:"/reference/frontmatter.html#permalinkpattern"},{default:l(()=>[e("Frontmatter > permalinkPattern")]),_:1}),e(".")]),T,F,n("p",null,[e("The palette system is extracted to "),a(s,{to:"/reference/plugin/palette.html"},{default:l(()=>[e("@vuepress/plugin-palette")]),_:1}),e(".")]),V,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 "),a(s,{to:"/reference/default-theme/styles.html"},{default:l(()=>[e("Default Theme > Styles")]),_:1}),e(".")]),I,M,X,n("p",null,[e("See "),a(s,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:l(()=>[e("Advanced > Cookbook > Usage of Client Config")]),_:1}),e(".")]),j,R,n("p",null,[e("You need to use "),a(s,{to:"/reference/plugin/register-components.html"},{default:l(()=>[e("@vuepress/plugin-register-components")]),_:1}),e(", or register your components manually in "),W,e(".")]),Y,N,n("p",null,[e("You need to import and set your local theme via "),a(s,{to:"/reference/config.html#theme"},{default:l(()=>[e("theme")]),_:1}),e(" option.")]),q,n("p",null,[e("See "),a(s,{to:"/reference/default-theme/styles.html"},{default:l(()=>[e("Default Theme > Styles")]),_:1}),e(".")]),U,G,n("p",null,[e("See "),a(s,{to:"/reference/default-theme/config.html"},{default:l(()=>[e("Default Theme > Config")]),_:1}),e(".")]),z,n("ul",null,[L,$,n("li",null,[e("Webpack related hooks are removed, because VuePress Core has decoupled with webpack. You can try to use "),a(s,{to:"/reference/plugin-api.html#extendsbundleroptions"},{default:l(()=>[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 "),a(s,{to:"/advanced/plugin.html"},{default:l(()=>[e("Advanced > Writing a Plugin")]),_:1}),e(".")]),H,n("p",null,[e("See "),a(s,{to:"/reference/plugin-api.html"},{default:l(()=>[e("Plugin API")]),_:1}),e(".")]),J,O,K,n("ul",null,[n("li",null,[e("There is no "),Q,e(" anymore. "),n("ul",null,[Z,n("li",null,[e("Files in "),ee,e(" directory will not be registered as Vue components automatically. You need to use "),a(s,{to:"/reference/plugin/register-components.html"},{default:l(()=>[e("@vuepress/plugin-register-components")]),_:1}),e(", or register components manually in "),ne,e(".")]),se])]),n("li",null,[ae,e(" is removed from user config and site data. To access the "),le,e(" as you would via "),oe,e(" in v1, we now recommend using the "),a(s,{to:"/reference/plugin/theme-data.html"},{default:l(()=>[e("@vuepress/plugin-theme-data")]),_:1}),e(" plugin and its "),ie,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, "),a(s,{to:"/reference/plugin/palette.html"},{default:l(()=>[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 "),a(s,{to:"/reference/plugin/prismjs.html"},{default:l(()=>[e("@vuepress/plugin-prismjs")]),_:1}),e(" or "),a(s,{to:"/reference/plugin/shiki.html"},{default:l(()=>[e("@vuepress/plugin-shiki")]),_:1}),e(", or implement syntax highlighting in your own way.")]),te]),n("p",null,[e("For more detailed guide about how to write a theme in v2, see "),a(s,{to:"/advanced/theme.html"},{default:l(()=>[e("Advanced > Writing a Theme")]),_:1}),e(".")]),de,re,ce,pe,n("p",null,[e("See "),a(s,{to:"/advanced/theme.html"},{default:l(()=>[e("Advanced > Writing a theme")]),_:1}),e(".")]),ue,he,me,n("p",null,[e("You can refer to "),a(s,{to:"/reference/default-theme/extending.html"},{default:l(()=>[e("Default Theme > Extending")]),_:1}),e(" for how to extend default theme.")]),n("p",null,[e("The "),ve,e(" and "),fe,e(" aliases are removed by default, but you can still make a extendable theme with similar approach, see "),a(s,{to:"/advanced/cookbook/making-a-theme-extendable.html"},{default:l(()=>[e("Advanced > Cookbook > Making a Theme Extendable")]),_:1}),e(".")])])}const Ce=i(c,[["render",ge],["__file","migration.html.vue"]]);export{Ce as default};
diff --git a/assets/migration.html-yL51i5Wa.js b/assets/migration.html-yL51i5Wa.js
new file mode 100644
index 000000000..333da8146
--- /dev/null
+++ b/assets/migration.html-yL51i5Wa.js
@@ -0,0 +1 @@
+const l=JSON.parse('{"key":"v-81b14334","path":"/zh/guide/migration.html","title":"从 v1 迁移","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"给用户","slug":"给用户","link":"#给用户","children":[{"level":3,"title":"用户配置变更","slug":"用户配置变更","link":"#用户配置变更","children":[]},{"level":3,"title":"Frontmatter 变更","slug":"frontmatter-变更","link":"#frontmatter-变更","children":[]},{"level":3,"title":"永久链接 Patterns 变更","slug":"永久链接-patterns-变更","link":"#永久链接-patterns-变更","children":[]},{"level":3,"title":"调色板系统变更","slug":"调色板系统变更","link":"#调色板系统变更","children":[]},{"level":3,"title":"约定文件变更","slug":"约定文件变更","link":"#约定文件变更","children":[]},{"level":3,"title":"Markdown 变更","slug":"markdown-变更","link":"#markdown-变更","children":[]},{"level":3,"title":"CLI 变更","slug":"cli-变更","link":"#cli-变更","children":[]},{"level":3,"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":"插件 API 变更","slug":"插件-api-变更","link":"#插件-api-变更","children":[]}]},{"level":2,"title":"给主题作者","slug":"给主题作者","link":"#给主题作者","children":[{"level":3,"title":"主题 API 变更","slug":"主题-api-变更","link":"#主题-api-变更","children":[]}]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/guide/migration.md"}');export{l as data};
diff --git a/assets/node-api.html-RzTrTTfo.js b/assets/node-api.html-RzTrTTfo.js
new file mode 100644
index 000000000..aa20b39d0
--- /dev/null
+++ b/assets/node-api.html-RzTrTTfo.js
@@ -0,0 +1,104 @@
+import{_ as r,r as t,o as c,c as d,d as n,a as s,b as l,w as e,e as p}from"./app-eU2v8o1B.js";const D={},u=s("h1",{id:"node-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#node-api","aria-hidden":"true"},"#"),l(" Node API")],-1),h={href:"https://www.npmjs.com/package/@vuepress/core",target:"_blank",rel:"noopener noreferrer"},y={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},v=p(`
`,3),R=s("li",null,[s("p",null,"Details:"),s("p",null,"Generate static site files."),s("p",null,[e("This method is only available in "),s("code",null,"BuildApp"),e(".")])],-1),N=s("p",null,"Also see:",-1),V=s("li",null,[s("a",{href:"#createbuildapp"},"Node API > App > createBuildApp")],-1),z=o(`
`,3),H=s("li",null,[s("p",null,"Details:"),s("p",null,"Start dev server."),s("p",null,[e("This method is only available in "),s("code",null,"DevApp"),e(".")])],-1),L=s("p",null,"Also see:",-1),j=s("li",null,[s("a",{href:"#createdevapp"},"Node API > App > createDevApp")],-1),G=o(`
`,8),O=s("li",null,[s("a",{href:"#pages"},"Node API > App Properties > pages")],-1),U=s("h2",{id:"page-properties",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#page-properties","aria-hidden":"true"},"#"),e(" Page Properties")],-1),W=s("h3",{id:"key",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#key","aria-hidden":"true"},"#"),e(" key")],-1),q=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string")])],-1),$=s("p",null,"Details:",-1),J=s("p",null,"Identifier of the page.",-1),K={href:"https://router.vuejs.org/api/#name-2",target:"_blank",rel:"noopener noreferrer"},Q=s("p",null,"Also see:",-1),X=s("h3",{id:"path",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#path","aria-hidden":"true"},"#"),e(" path")],-1),Y=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string")])],-1),Z=s("li",null,[s("p",null,"Details:"),s("p",null,"Route path of the page.")],-1),ss=s("p",null,"Also see:",-1),es=s("li",null,[s("a",{href:"#pathinferred"},"Node API > Page Properties > pathInferred")],-1),ls=s("h3",{id:"title",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#title","aria-hidden":"true"},"#"),e(" title")],-1),as=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string")])],-1),ns=s("li",null,[s("p",null,"Details:"),s("p",null,"Title of the page.")],-1),os=s("p",null,"Also see:",-1),ps=s("h3",{id:"lang",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#lang","aria-hidden":"true"},"#"),e(" lang")],-1),ts=o("
Type: string
Details:
Language of the page.
Example:
'en-US'
'zh-CN'
",3),is=s("p",null,"Also see:",-1),rs=s("h3",{id:"frontmatter",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),e(" frontmatter")],-1),cs=s("li",null,[s("p",null,[e("Type: "),s("code",null,"PageFrontmatter")])],-1),ds=s("li",null,[s("p",null,"Details:"),s("p",null,"Frontmatter of the page.")],-1),Ds=s("p",null,"Also see:",-1),us=o(`
`,3),ms=s("li",null,[s("p",null,"Details:"),s("p",null,"Data of the page."),s("p",null,"Page data would be available in client side.")],-1),Cs=s("p",null,"Also see:",-1),bs=o('
",3),gs=s("p",null,"Also see:",-1),_s=s("h3",{id:"deps",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#deps","aria-hidden":"true"},"#"),e(" deps")],-1),Es=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string[]")])],-1),As=s("li",null,[s("p",null,"Details:"),s("p",null,"Dependencies of the page."),s("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 "),s("code",null,"deps"),e(".")])],-1),ks=s("p",null,"Also see:",-1),xs=o(`
The env object when parsing markdown content with markdown-it.
Some markdown-it plugins may store extra information inside this object, and you can make use of them for advanced customization.
Notice that some other page properties are also extracted from the original env object. Those properties have already been removed from page.markdownEnv.
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),Is=s("p",null,"Also see:",-1),Ms=s("li",null,[s("a",{href:"#path"},"Node API > Page Properties > path")],-1),Ss=s("h3",{id:"pathlocale",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#pathlocale","aria-hidden":"true"},"#"),e(" pathLocale")],-1),Rs=o("
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),Ns=s("p",null,"Also see:",-1),Vs=s("h3",{id:"permalink",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#permalink","aria-hidden":"true"},"#"),e(" permalink")],-1),zs=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string | null")])],-1),Hs=s("li",null,[s("p",null,"Details:"),s("p",null,"Permalink of the page.")],-1),Ls=s("p",null,"Also see:",-1),js=s("h3",{id:"routemeta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#routemeta","aria-hidden":"true"},"#"),e(" routeMeta")],-1),Gs=s("li",null,[s("p",null,[e("Type: "),s("code",null,"Record")])],-1),Os=s("li",null,[s("p",null,"Details:"),s("p",null,"Custom data to be attached to the route record of vue-router.")],-1),Us=s("p",null,"Also see:",-1),Ws={href:"https://router.vuejs.org/api/#meta",target:"_blank",rel:"noopener noreferrer"},qs=o('
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),$s=s("li",null,[s("p",null,[e("Type: "),s("code",null,"MarkdownSfcBlocks")])],-1),Js=s("li",null,[s("p",null,"Details:"),s("p",null,"Extracted vue SFC blocks of the page.")],-1),Ks=s("p",null,"Also see:",-1),Qs=o('
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 Xs(Ys,Zs){const i=t("NpmBadge"),p=t("ExternalLinkIcon"),a=t("RouterLink");return c(),d("div",null,[u,l(i,{package:"@vuepress/core"}),s("p",null,[e("Node API is provided by "),s("a",h,[e("@vuepress/core"),l(p)]),e(" package. It is a dependency of the "),s("a",y,[e("vuepress"),l(p)]),e(" package, and you can also install it separately:")]),v,s("p",null,[e("The app instance is available in all hooks of "),l(a,{to:"/reference/plugin-api.html"},{default:n(()=>[e("Plugin API")]),_:1}),e(".")]),m,s("ul",null,[C,s("li",null,[b,s("p",null,[e("Site data that set by user, including all the "),l(a,{to:"/reference/config.html#site-config"},{default:n(()=>[e("site config")]),_:1}),e(", which will be used in client side.")])])]),f,s("ul",null,[g,s("li",null,[_,s("p",null,[e("The "),s("a",E,[e("markdown-it"),l(p)]),e(" instance used for parsing markdown content.")]),s("p",null,[e("It is only available in and after "),l(a,{to:"/reference/plugin-api.html#oninitialized"},{default:n(()=>[e("onInitialized")]),_:1}),e(" hook.")])])]),A,s("ul",null,[k,s("li",null,[x,w,s("p",null,[e("It is only available in and after "),l(a,{to:"/reference/plugin-api.html#oninitialized"},{default:n(()=>[e("onInitialized")]),_:1}),e(" hook.")])])]),F,s("ul",null,[P,s("li",null,[B,s("ul",null,[s("li",null,[l(a,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:n(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),T,s("ul",null,[I,s("li",null,[M,s("ul",null,[s("li",null,[l(a,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:n(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),S,s("ul",null,[R,s("li",null,[N,s("ul",null,[V,s("li",null,[l(a,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:n(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),z,s("ul",null,[H,s("li",null,[L,s("ul",null,[j,s("li",null,[l(a,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:n(()=>[e("Advanced > Architecture > Core Process and Hooks")]),_:1})])])])]),G,s("ul",null,[s("li",null,[e("Also see: "),s("ul",null,[O,s("li",null,[l(a,{to:"/advanced/cookbook/adding-extra-pages.html"},{default:n(()=>[e("Cookbook > Adding Extra Pages")]),_:1})])])])]),U,W,s("ul",null,[q,s("li",null,[$,J,s("p",null,[e("The page key would be used as the "),s("a",K,[e("name"),l(p)]),e(" of the page route.")])]),s("li",null,[Q,s("ul",null,[s("li",null,[l(a,{to:"/reference/components.html#content"},{default:n(()=>[e("Built-in Components > Content")]),_:1})])])])]),X,s("ul",null,[Y,Z,s("li",null,[ss,s("ul",null,[s("li",null,[l(a,{to:"/guide/page.html#routing"},{default:n(()=>[e("Guide > Page > Routing")]),_:1})]),es])])]),ls,s("ul",null,[as,ns,s("li",null,[os,s("ul",null,[s("li",null,[l(a,{to:"/reference/frontmatter.html#title"},{default:n(()=>[e("Frontmatter > title")]),_:1})])])])]),ps,s("ul",null,[ts,s("li",null,[is,s("ul",null,[s("li",null,[l(a,{to:"/reference/frontmatter.html#title"},{default:n(()=>[e("Frontmatter > lang")]),_:1})])])])]),rs,s("ul",null,[cs,ds,s("li",null,[Ds,s("ul",null,[s("li",null,[l(a,{to:"/reference/frontmatter.html"},{default:n(()=>[e("Frontmatter")]),_:1})])])])]),us,s("ul",null,[hs,s("li",null,[ys,s("ul",null,[s("li",null,[l(a,{to:"/reference/config.html#markdown-headers"},{default:n(()=>[e("Config > markdown.headers")]),_:1})])])])]),vs,s("ul",null,[ms,s("li",null,[Cs,s("ul",null,[s("li",null,[l(a,{to:"/reference/client-api.html#usepagedata"},{default:n(()=>[e("Client API > usePageData")]),_:1})]),s("li",null,[l(a,{to:"/reference/plugin-api.html#extendspage"},{default:n(()=>[e("Plugin API > extendsPage")]),_:1})])])])]),bs,s("ul",null,[fs,s("li",null,[gs,s("ul",null,[s("li",null,[l(a,{to:"/reference/frontmatter.html#date"},{default:n(()=>[e("Frontmatter > date")]),_:1})])])])]),_s,s("ul",null,[Es,As,s("li",null,[ks,s("ul",null,[s("li",null,[l(a,{to:"/reference/config.html#markdown-importcode"},{default:n(()=>[e("Config > markdown.importCode")]),_:1})])])])]),xs,s("ul",null,[ws,s("li",null,[Fs,s("ul",null,[s("li",null,[s("a",Ps,[e("markdown-it > API Documentation > MarkdownIt > parse"),l(p)])])])])]),Bs,s("ul",null,[Ts,s("li",null,[Is,s("ul",null,[s("li",null,[l(a,{to:"/guide/page.html#routing"},{default:n(()=>[e("Guide > Page > Routing")]),_:1})]),Ms])])]),Ss,s("ul",null,[Rs,s("li",null,[Ns,s("ul",null,[s("li",null,[l(a,{to:"/reference/config.html#locales"},{default:n(()=>[e("Config > locales")]),_:1})])])])]),Vs,s("ul",null,[zs,Hs,s("li",null,[Ls,s("ul",null,[s("li",null,[l(a,{to:"/reference/frontmatter.html#permalink"},{default:n(()=>[e("Frontmatter > permalink")]),_:1})]),s("li",null,[l(a,{to:"/reference/frontmatter.html#permalinkpattern"},{default:n(()=>[e("Frontmatter > permalinkPattern")]),_:1})])])])]),js,s("ul",null,[Gs,Os,s("li",null,[Us,s("ul",null,[s("li",null,[l(a,{to:"/reference/frontmatter.html#routemeta"},{default:n(()=>[e("Frontmatter > routeMeta")]),_:1})]),s("li",null,[s("a",Ws,[e("vue-router > API Reference > RouteRecordRaw > meta"),l(p)])])])])]),qs,s("ul",null,[$s,Js,s("li",null,[Ks,s("ul",null,[s("li",null,[l(a,{to:"/reference/config.html#markdown-sfc"},{default:n(()=>[e("Config > markdown.sfc")]),_:1})])])])]),Qs])}const ee=r(D,[["render",Xs],["__file","node-api.html.vue"]]);export{ee as default};
diff --git a/assets/node-api.html-lHGIfrDJ.js b/assets/node-api.html-lHGIfrDJ.js
new file mode 100644
index 000000000..10e8636e1
--- /dev/null
+++ b/assets/node-api.html-lHGIfrDJ.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4986678d","path":"/reference/node-api.html","title":"Node API","lang":"en-US","frontmatter":{},"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":"markdownEnv","slug":"markdownenv","link":"#markdownenv","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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/node-api.md"}');export{e as data};
diff --git a/assets/node-api.html-tuX36iXe.js b/assets/node-api.html-tuX36iXe.js
new file mode 100644
index 000000000..86fd512ca
--- /dev/null
+++ b/assets/node-api.html-tuX36iXe.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-e19cff04","path":"/zh/reference/node-api.html","title":"Node API","lang":"zh-CN","frontmatter":{},"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 属性","slug":"app-属性","link":"#app-属性","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 方法","slug":"app-方法","link":"#app-方法","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 属性","slug":"page-属性","link":"#page-属性","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":"markdownEnv","slug":"markdownenv","link":"#markdownenv","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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/node-api.md"}');export{e as data};
diff --git a/assets/nprogress.html-NpXpKxIh.js b/assets/nprogress.html-NpXpKxIh.js
new file mode 100644
index 000000000..06ad2ffcd
--- /dev/null
+++ b/assets/nprogress.html-NpXpKxIh.js
@@ -0,0 +1,11 @@
+import{_ as o,r as e,o as p,c,d as a,a as n,b as s,e as i}from"./app-eU2v8o1B.js";const t={},d=n("h1",{id:"nprogress-plugin",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#nprogress-plugin","aria-hidden":"true"},"#"),s(" nprogress Plugin")],-1),D={href:"https://github.com/rstacruz/nprogress",target:"_blank",rel:"noopener noreferrer"},u=i(`
This plugin has been integrated into the default theme.
`,7);function g(y,h){const l=e("NpmBadge"),r=e("ExternalLinkIcon");return p(),c("div",null,[d,a(l,{package:"@vuepress/plugin-nprogress"}),n("p",null,[s("Integrate "),n("a",D,[s("nprogress"),a(r)]),s(" into VuePress, which can provide a progress bar when navigating to another page.")]),u])}const m=o(t,[["render",g],["__file","nprogress.html.vue"]]);export{m as default};
diff --git a/assets/nprogress.html-RNgL0QGZ.js b/assets/nprogress.html-RNgL0QGZ.js
new file mode 100644
index 000000000..f076246bc
--- /dev/null
+++ b/assets/nprogress.html-RNgL0QGZ.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-46d4f19d","path":"/reference/plugin/nprogress.html","title":"nprogress","lang":"en-US","frontmatter":{"title":"nprogress"},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Styles","slug":"styles","link":"#styles","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/nprogress.md"}');export{e as data};
diff --git a/assets/nprogress.html-X5umHJyu.js b/assets/nprogress.html-X5umHJyu.js
new file mode 100644
index 000000000..43c2f8a3b
--- /dev/null
+++ b/assets/nprogress.html-X5umHJyu.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-9f56ece4","path":"/zh/reference/plugin/nprogress.html","title":"nprogress","lang":"zh-CN","frontmatter":{"title":"nprogress"},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"样式","slug":"样式","link":"#样式","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/nprogress.md"}');export{e as data};
diff --git a/assets/nprogress.html-gqI71Nvz.js b/assets/nprogress.html-gqI71Nvz.js
new file mode 100644
index 000000000..93929e4a9
--- /dev/null
+++ b/assets/nprogress.html-gqI71Nvz.js
@@ -0,0 +1,11 @@
+import{_ as o,r as a,o as p,c,d as e,a as n,b as s,e as i}from"./app-eU2v8o1B.js";const t={},d=n("h1",{id:"nprogress-插件",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#nprogress-插件","aria-hidden":"true"},"#"),s(" nprogress 插件")],-1),D={href:"https://github.com/rstacruz/nprogress",target:"_blank",rel:"noopener noreferrer"},u=i(`
`,6),h=t("code",null,"docs",-1),m=t("code",null,"vuepress dev docs",-1),f=r("
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:"custom-container tip"},g=t("p",{class:"custom-container-title"},"TIP",-1),v=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),b=t("code",null,"['**/*.md', '!**/README.md', '!.vuepress', '!node_modules']",-1),D=t("code",null,"README.md",-1),y=t("code",null,":",-1),k=t("code",null,"+",-1),w={href:"https://router.vuejs.org/guide/essentials/route-matching-syntax.html",target:"_blank",rel:"noopener noreferrer"},x=t("h2",{id:"frontmatter",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#frontmatter","aria-hidden":"true"},"#"),e(" Frontmatter")],-1),E={href:"https://yaml.org/",target:"_blank",rel:"noopener noreferrer"},M=r(`
---
+lang: en-US
+title: Title of this page
+description: Description of this page
+---
+
`,1),C=t("code",null,"lang",-1),R=t("code",null,"title",-1),A=t("code",null,"description",-1),P=t("p",null,"Also, VuePress has built-in support for some frontmatter fields, and your theme may have its own special frontmatter, too.",-1),V={class:"custom-container tip"},T=t("p",{class:"custom-container-title"},"TIP",-1),L=t("h2",{id:"content",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#content","aria-hidden":"true"},"#"),e(" Content")],-1),B=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),F={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"};function I(N,S){const o=d("RouterLink"),a=d("ExternalLinkIcon");return i(),c("div",null,[p,t("p",null,[e("Take the "),h,e(" directory as your "),n(o,{to:"/reference/cli.html"},{default:s(()=>[e("sourceDir")]),_:1}),e(", e.g. you are running "),m,e(" command. Then the route paths of your markdown files would be:")]),f,t("div",_,[g,v,t("p",null,[e("In such case, you can set the "),n(o,{to:"/reference/config.html#pagepatterns"},{default:s(()=>[e("pagePatterns")]),_:1}),e(" to avoid one of them being processed by VuePress, e.g. use "),b,e(" to exclude all "),D,e(" files.")]),t("p",null,[e("Also, some symbols like "),y,e(" and "),k,e(" may have special meanings for vue-router, so you should avoid using them, see "),t("a",w,[e("vue-router docs"),n(a)]),e(" for more details.")])]),x,t("p",null,[e("A markdown file could contain a "),t("a",E,[e("YAML"),n(a)]),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:")]),M,t("p",null,[e("You must have noticed that those fields are similar with the "),n(o,{to:"/guide/configuration.html#site-config"},{default:s(()=>[e("Site Config")]),_:1}),e(" in the "),n(o,{to:"/guide/configuration.html#config-file"},{default:s(()=>[e("Config File")]),_:1}),e(". You can override "),C,e(", "),R,e(", "),A,e(", etc., of current page via frontmatter. So you can take frontmatter as page scope config.")]),P,t("div",V,[T,t("p",null,[e("Check out the "),n(o,{to:"/reference/frontmatter.html"},{default:s(()=>[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:s(()=>[e("Default Theme > Frontmatter Reference")]),_:1}),e(" for the frontmatter of default theme.")])]),L,B,t("p",null,[e("With the power of "),t("a",F,[e("markdown-it"),n(a)]),e(" and Vue template syntax, the basic Markdown can be extended a lot. Next, check out the "),n(o,{to:"/guide/markdown.html"},{default:s(()=>[e("Markdown")]),_:1}),e(" guide for all the extensions of Markdown in VuePress.")])])}const Y=l(u,[["render",I],["__file","page.html.vue"]]);export{Y as default};
diff --git a/assets/page.html-qK-n-fJU.js b/assets/page.html-qK-n-fJU.js
new file mode 100644
index 000000000..ef0c69f6f
--- /dev/null
+++ b/assets/page.html-qK-n-fJU.js
@@ -0,0 +1,12 @@
+import{_ as l,r,o as c,c as i,a as t,b as e,d as n,w as o,e as d}from"./app-eU2v8o1B.js";const p={},u=d(`
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.
This option is used for generating tempPaletteFile and tempStyleFile, and you don't need to change this option in most cases.
`,27);function f(b,g){const p=n("NpmBadge"),a=n("ExternalLinkIcon");return o(),r("div",null,[d,l(p,{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",y,[e("CSS variables"),l(a)]),e(", "),s("a",h,[e("SASS variables"),l(a)]),e(", "),s("a",D,[e("LESS variables"),l(a)]),e(" or "),s("a",v,[e("Stylus variables"),l(a)]),e(" in the palette, and then you can use those variables in your theme styles.")]),m])}const x=i(c,[["render",f],["__file","palette.html.vue"]]);export{x as default};
diff --git a/assets/palette.html-mci2X1xJ.js b/assets/palette.html-mci2X1xJ.js
new file mode 100644
index 000000000..5d8f1755b
--- /dev/null
+++ b/assets/palette.html-mci2X1xJ.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5fd3efae","path":"/zh/reference/plugin/palette.html","title":"palette","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/palette.md"}');export{e as data};
diff --git a/assets/palette.html-svIiBuAj.js b/assets/palette.html-svIiBuAj.js
new file mode 100644
index 000000000..d03c5c4b9
--- /dev/null
+++ b/assets/palette.html-svIiBuAj.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-37c5e106","path":"/reference/plugin/palette.html","title":"palette","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/palette.md"}');export{e as data};
diff --git a/assets/passing-data-to-client-code.html-66UgnX14.js b/assets/passing-data-to-client-code.html-66UgnX14.js
new file mode 100644
index 000000000..dfc4b6bf7
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-66UgnX14.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":{},"headers":[{"level":2,"title":"使用 define Hook","slug":"使用-define-hook","link":"#使用-define-hook","children":[]},{"level":2,"title":"写入并加载临时文件","slug":"写入并加载临时文件","link":"#写入并加载临时文件","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/advanced/cookbook/passing-data-to-client-code.md"}');export{e as data};
diff --git a/assets/passing-data-to-client-code.html-7z7BFnaN.js b/assets/passing-data-to-client-code.html-7z7BFnaN.js
new file mode 100644
index 000000000..d45641514
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-7z7BFnaN.js
@@ -0,0 +1,26 @@
+import{_ as p,r as t,o as c,c as r,a as n,b as s,d as e,w as l,e as o}from"./app-eU2v8o1B.js";const i={},D=n("h1",{id:"passing-data-to-client-code",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#passing-data-to-client-code","aria-hidden":"true"},"#"),s(" Passing Data to Client Code")],-1),d=n("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),y=n("h2",{id:"use-define-hook",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#use-define-hook","aria-hidden":"true"},"#"),s(" Use "),n("code",null,"define"),s(" Hook")],-1),u=o(`
`,5);function v(b,h){const a=t("RouterLink");return c(),r("div",null,[D,d,y,n("p",null,[s("Plugin API provides a "),e(a,{to:"/reference/plugin-api.html#define"},{default:l(()=>[s("define")]),_:1}),s(" hook to define global constants for client code. You can make use of it to pass data to client.")]),u,n("p",null,[s("First, write a temp file "),C,s(", which will be generated in the "),e(a,{to:"/reference/config.html#temp"},{default:l(()=>[s("temp")]),_:1}),s(" directory:")]),m])}const _=p(i,[["render",v],["__file","passing-data-to-client-code.html.vue"]]);export{_ as default};
diff --git a/assets/passing-data-to-client-code.html-N0mtoojl.js b/assets/passing-data-to-client-code.html-N0mtoojl.js
new file mode 100644
index 000000000..5b2192f8c
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-N0mtoojl.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":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"advanced/cookbook/passing-data-to-client-code.md"}');export{e as data};
diff --git a/assets/passing-data-to-client-code.html-f-CVV22Z.js b/assets/passing-data-to-client-code.html-f-CVV22Z.js
new file mode 100644
index 000000000..8d00ef8dc
--- /dev/null
+++ b/assets/passing-data-to-client-code.html-f-CVV22Z.js
@@ -0,0 +1,26 @@
+import{_ as p,r as c,o as r,c as t,a as n,b as s,d as l,w as e,e as o}from"./app-eU2v8o1B.js";const D={},i=n("h1",{id:"向客户端代码传递数据",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#向客户端代码传递数据","aria-hidden":"true"},"#"),s(" 向客户端代码传递数据")],-1),d=n("p",null,"我们知道，VuePress 插件入口和主题入口是在 Node 端处理的，但有时候你可能需要向客户端动态传递数据。例如，你希望在用户传入不同的选项时生成不同的数据。",-1),y=n("h2",{id:"使用-define-hook",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#使用-define-hook","aria-hidden":"true"},"#"),s(" 使用 "),n("code",null,"define"),s(" Hook")],-1),C=o(`
`,4),f=s("h3",{id:"extendsmarkdown",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#extendsmarkdown","aria-hidden":"true"},"#"),n(" extendsMarkdown")],-1),E=s("li",null,[s("p",null,[n("Type: "),s("code",null,"(md: Markdown, app: App) => void | Promise")])],-1),F=s("p",null,"Details:",-1),k=s("p",null,"Markdown enhancement.",-1),x=s("code",null,"Markdown",-1),_={href:"https://github.com/markdown-it/markdown-it",target:"_blank",rel:"noopener noreferrer"},w=s("p",null,"This hook can be used for using extra markdown-it plugins and implementing customizations.",-1),A=s("li",null,[s("p",null,"Example:")],-1),P=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 B(I,N){const i=t("NpmBadge"),o=t("ExternalLinkIcon"),l=t("RouterLink");return c(),D("div",null,[y,a(i,{package:"@vuepress/core"}),s("p",null,[n("Plugin API is supported by "),s("a",u,[n("@vuepress/core"),a(o)]),n(" package. You could check out "),a(l,{to:"/reference/node-api.html"},{default:e(()=>[n("Node API")]),_:1}),n(" for how to use the VuePress app instance in plugin hooks.")]),C,s("blockquote",null,[s("p",null,[n("Check out "),a(l,{to:"/advanced/architecture.html#core-process-and-hooks"},{default:e(()=>[n("Advanced > Architecture > Core Process and Hooks")]),_:1}),n(" to understand the process better.")])]),h,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(l,{to:"/reference/client-api.html#defineclientconfig"},{default:e(()=>[n("Client API > defineClientConfig")]),_:1})]),s("li",null,[a(l,{to:"/advanced/cookbook/usage-of-client-config.html"},{default:e(()=>[n("Advanced > Cookbook > Usage of Client Config")]),_:1})])])])]),m,s("p",null,[n("Adding default "),s("a",v,[n("app.compilerOptions.isCustomElement"),a(o)]),n(" option:")]),b,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(l,{to:"/reference/bundler/vite.html"},{default:e(()=>[n("Bundlers > Vite")]),_:1})]),s("li",null,[a(l,{to:"/reference/bundler/webpack.html"},{default:e(()=>[n("Bundlers > Webpack")]),_:1})])])])]),g,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(l,{to:"/reference/config.html#markdown"},{default:e(()=>[n("Config > markdown")]),_:1})])])])]),f,s("ul",null,[E,s("li",null,[F,k,s("p",null,[n("This hook accepts a function that will receive an instance of "),x,n(" powered by "),s("a",_,[n("markdown-it"),a(o)]),n(" in its arguments.")]),w]),A]),P,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(l,{to:"/reference/node-api.html#createpage"},{default:e(()=>[n("Node API > Page > createPage")]),_:1})])])])]),O,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(l,{to:"/reference/client-api.html#usepagedata"},{default:e(()=>[n("Client API > usePageData")]),_:1})]),s("li",null,[a(l,{to:"/reference/node-api.html#data"},{default:e(()=>[n("Node API > Page Properties > data")]),_:1})]),s("li",null,[a(l,{to:"/reference/node-api.html#routemeta"},{default:e(()=>[n("Node API > Page Properties > routeMeta")]),_:1})])])])]),T])}const L=r(d,[["render",B],["__file","plugin-api.html.vue"]]);export{L as default};
diff --git a/assets/plugin-api.html-mxjJqHwg.js b/assets/plugin-api.html-mxjJqHwg.js
new file mode 100644
index 000000000..3fc6bd0bc
--- /dev/null
+++ b/assets/plugin-api.html-mxjJqHwg.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5e9d516d","path":"/zh/reference/plugin-api.html","title":"插件 API","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin-api.md"}');export{e as data};
diff --git a/assets/plugin-api.html-nvZZ9-9s.js b/assets/plugin-api.html-nvZZ9-9s.js
new file mode 100644
index 000000000..315de6cd9
--- /dev/null
+++ b/assets/plugin-api.html-nvZZ9-9s.js
@@ -0,0 +1,88 @@
+import{_ as D,r,o as c,c as i,d as a,a as s,b as n,w as e,e as p}from"./app-eU2v8o1B.js";const d={},y=s("h1",{id:"插件-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#插件-api","aria-hidden":"true"},"#"),n(" 插件 API")],-1),C={href:"https://www.npmjs.com/package/@vuepress/core",target:"_blank",rel:"noopener noreferrer"},u=p('
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),E=n("code",null,"name",-1),k=n("code",null,"vuepress-plugin-xxx",-1),x=n("code",null,"@org/vuepress-plugin-xxx",-1),P=n("em",null,"Plugin Object",-1),w=n("li",null,[s("Set "),n("code",null,"keywords"),s(" to include "),n("code",null,"vuepress-plugin"),s(", so that users can search your plugin on NPM.")],-1);function A(F,j){const l=p("RouterLink"),i=p("ExternalLinkIcon");return c(),r("div",null,[d,n("div",u,[y,n("p",null,[s("Before reading this guide, you'd better learn the VuePress "),a(l,{to:"/advanced/architecture.html"},{default:e(()=>[s("architecture")]),_:1}),s(" first.")])]),v,n("p",null,[s("A plugin should be a plain JavaScript object that satisfies the "),a(l,{to:"/reference/plugin-api.html"},{default:e(()=>[s("Plugin API")]),_:1}),s(", which is called a "),h,s(":")]),m,n("p",null,[s("A plugin could also be a function that receives the "),a(l,{to:"/reference/node-api.html#app"},{default:e(()=>[s("app instance")]),_:1}),s(" as the param and returns a "),b,s(", which is called a "),g,s(":")]),_,n("p",null,[s("After creating a plugin, you should follow some conventions in the "),n("a",C,[s("package.json"),a(i)]),s(" file before publishing it to NPM:")]),f,n("ul",null,[n("li",null,[s("Set "),E,s(" to follow the naming convention, i.e. "),k,s(" or "),x,s(", which should be consistent with the "),a(l,{to:"/reference/plugin-api.html#name"},{default:e(()=>[s("name")]),_:1}),s(" field of the "),P,s(".")]),w])])}const N=t(D,[["render",A],["__file","plugin.html.vue"]]);export{N as default};
diff --git a/assets/plugin.html-69wz8wnr.js b/assets/plugin.html-69wz8wnr.js
new file mode 100644
index 000000000..03a5bf971
--- /dev/null
+++ b/assets/plugin.html-69wz8wnr.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-301ab792","path":"/advanced/plugin.html","title":"Writing a Plugin","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"advanced/plugin.md"}');export{e as data};
diff --git a/assets/plugin.html-GL3IPvy_.js b/assets/plugin.html-GL3IPvy_.js
new file mode 100644
index 000000000..8d0e859fb
--- /dev/null
+++ b/assets/plugin.html-GL3IPvy_.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-9043126a","path":"/zh/guide/plugin.html","title":"插件","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"社区插件","slug":"社区插件","link":"#社区插件","children":[]},{"level":2,"title":"本地插件","slug":"本地插件","link":"#本地插件","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/guide/plugin.md"}');export{e as data};
diff --git a/assets/plugin.html-JBB6sUWc.js b/assets/plugin.html-JBB6sUWc.js
new file mode 100644
index 000000000..92101e2bc
--- /dev/null
+++ b/assets/plugin.html-JBB6sUWc.js
@@ -0,0 +1,15 @@
+import{_ as p,r as t,o as c,c as r,a as s,b as n,d as e,w as a,e as i}from"./app-eU2v8o1B.js";const u={},d=s("h1",{id:"plugin",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#plugin","aria-hidden":"true"},"#"),n(" Plugin")],-1),g=s("h2",{id:"community-plugin",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#community-plugin","aria-hidden":"true"},"#"),n(" Community Plugin")],-1),D={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"},h=i(`
`,1),y={class:"custom-container tip"},f=s("p",{class:"custom-container-title"},"TIP",-1),v=s("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),_=s("h2",{id:"local-plugin",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#local-plugin","aria-hidden":"true"},"#"),n(" Local Plugin")],-1),C=s("p",null,"If you want to use your own plugin but don't want to publish it, you can create a local plugin.",-1),b=i(`
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 w(k,x){const l=t("RouterLink"),o=t("ExternalLinkIcon");return c(),r("div",null,[d,s("p",null,[n("With the help of "),e(l,{to:"/reference/plugin-api.html"},{default:a(()=>[n("Plugin API")]),_:1}),n(", VuePress plugin can provide different features for you.")]),g,s("p",null,[n("Community users have created lots of plugins and published them to "),s("a",D,[n("NPM"),e(o)]),n(". VuePress team also maintains some official plugins under the "),s("a",m,[n("@vuepress"),e(o)]),n(" scope. You should check the plugin's own documentation for detailed guide.")]),s("p",null,[n("In general, you need to import the plugin and use it in your config file via the "),e(l,{to:"/reference/config.html#plugins"},{default:a(()=>[n("plugins")]),_:1}),n(" option. For example, use the "),e(l,{to:"/reference/plugin/google-analytics.html"},{default:a(()=>[n("@vuepress/plugin-google-analytics")]),_:1}),n(" to integrate Google Analytics:")]),h,s("div",y,[f,v,s("p",null,[n("However, some plugins can be used multiple times (e.g. "),e(l,{to:"/reference/plugin/container.html"},{default:a(()=>[n("@vuepress/plugin-container")]),_:1}),n("), and you should check the documentation of the plugin itself for detailed guide.")])]),_,C,s("p",null,[n("It is recommended to use the "),e(l,{to:"/guide/configuration.html#config-file"},{default:a(()=>[n("Config File")]),_:1}),n(" directly as a plugin, because "),e(l,{to:"/reference/config.html#plugin-api"},{default:a(()=>[n("almost all of the Plugin APIs are available")]),_:1}),n(", which would be more convenient in most cases.")]),b,s("p",null,[n("You can refer to "),e(l,{to:"/advanced/plugin.html"},{default:a(()=>[n("Advanced > Writing a Plugin")]),_:1}),n(" for how to write your own plugin.")])])}const P=p(u,[["render",w],["__file","plugin.html.vue"]]);export{P as default};
diff --git a/assets/plugin.html-LFMVvu2B.js b/assets/plugin.html-LFMVvu2B.js
new file mode 100644
index 000000000..eb806e3e5
--- /dev/null
+++ b/assets/plugin.html-LFMVvu2B.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-574aac41","path":"/zh/advanced/plugin.html","title":"开发插件","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"创建一个插件","slug":"创建一个插件","link":"#创建一个插件","children":[]},{"level":2,"title":"发布到 NPM","slug":"发布到-npm","link":"#发布到-npm","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/advanced/plugin.md"}');export{e as data};
diff --git a/assets/plugin.html-PD1th8Qg.js b/assets/plugin.html-PD1th8Qg.js
new file mode 100644
index 000000000..c302d9b1c
--- /dev/null
+++ b/assets/plugin.html-PD1th8Qg.js
@@ -0,0 +1,30 @@
+import{_ as r,r as o,o as i,c as t,a as n,b as s,d as a,w as e,e as p}from"./app-eU2v8o1B.js";const D={},d=n("h1",{id:"开发插件",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#开发插件","aria-hidden":"true"},"#"),s(" 开发插件")],-1),u={class:"custom-container tip"},y=n("p",{class:"custom-container-title"},"提示",-1),v=n("h2",{id:"创建一个插件",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#创建一个插件","aria-hidden":"true"},"#"),s(" 创建一个插件")],-1),m=n("em",null,"插件对象",-1),h=p(`
`,7),m=s("li",null,[s("p",null,[n("类型： "),s("code",null,"string[]")])],-1),h=s("li",null,[s("p",null,[n("默认值： "),s("code",null,"['markdown', 'jsdoc', 'yaml']")])],-1),_=s("p",null,"详情：",-1),v=s("p",null,"需要预加载的语言。",-1),y=s("p",null,"默认情况下，语言会在解析 Markdown 文件时按需加载。",-1),b={href:"https://github.com/PrismJS/prism/issues/2716",target:"_blank",rel:"noopener noreferrer"};function g(C,f){const r=l("NpmBadge"),e=l("ExternalLinkIcon");return o(),i("div",null,[d,a(r,{package:"@vuepress/plugin-prismjs"}),s("p",null,[n("该插件使用 "),s("a",u,[n("Prism.js"),a(e)]),n(" 来为 Markdown 代码块启用代码高亮。")]),D,s("ul",null,[m,h,s("li",null,[_,v,y,s("p",null,[n("然而， Prism.js 在动态加载语言时可能会遇到 "),s("a",b,[n("一些潜在的问题"),a(e)]),n(" 。为了避免这些问题，你可以使用该配置项来预加载一些语言。")])])])])}const x=p(t,[["render",g],["__file","prismjs.html.vue"]]);export{x as default};
diff --git a/assets/prismjs.html-hnhxNt6P.js b/assets/prismjs.html-hnhxNt6P.js
new file mode 100644
index 000000000..9bd6e2360
--- /dev/null
+++ b/assets/prismjs.html-hnhxNt6P.js
@@ -0,0 +1,11 @@
+import{_ as i,r as l,o as p,c as r,d as e,a as s,b as n,e as t}from"./app-eU2v8o1B.js";const c={},d=s("h1",{id:"prismjs",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#prismjs","aria-hidden":"true"},"#"),n(" prismjs")],-1),u={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},h=t(`
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=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string[]")])],-1),D=s("li",null,[s("p",null,[n("Default: "),s("code",null,"['markdown', 'jsdoc', 'yaml']")])],-1),g=s("p",null,"Details:",-1),y=s("p",null,"Languages to preload.",-1),v=s("p",null,"By default, languages will be loaded on demand when parsing markdown files.",-1),_={href:"https://github.com/PrismJS/prism/issues/2716",target:"_blank",rel:"noopener noreferrer"};function b(f,C){const o=l("NpmBadge"),a=l("ExternalLinkIcon");return p(),r("div",null,[d,e(o,{package:"@vuepress/plugin-prismjs"}),s("p",null,[n("This plugin will enable syntax highlighting for markdown code fence with "),s("a",u,[n("Prism.js"),e(a)]),n(".")]),h,s("ul",null,[m,D,s("li",null,[g,y,v,s("p",null,[n("However, Prism.js has "),s("a",_,[n("some potential issues"),e(a)]),n(" about loading languages dynamically. To avoid them, you can preload languages via this option.")])])])])}const x=i(c,[["render",b],["__file","prismjs.html.vue"]]);export{x as default};
diff --git a/assets/pwa-popup.html--uhGb_lp.js b/assets/pwa-popup.html--uhGb_lp.js
new file mode 100644
index 000000000..41100d2ee
--- /dev/null
+++ b/assets/pwa-popup.html--uhGb_lp.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-5f86289f","path":"/reference/plugin/pwa-popup.html","title":"pwa-popup","lang":"en-US","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/pwa-popup.md"}');export{e as data};
diff --git a/assets/pwa-popup.html-FEkQ6tW5.js b/assets/pwa-popup.html-FEkQ6tW5.js
new file mode 100644
index 000000000..f0b02b6ca
--- /dev/null
+++ b/assets/pwa-popup.html-FEkQ6tW5.js
@@ -0,0 +1,42 @@
+import{_ as i,r as p,o as r,c as t,d as a,a as s,b as n,w as e,e as o}from"./app-eU2v8o1B.js";const D={},d=s("h1",{id:"pwa-popup",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#pwa-popup","aria-hidden":"true"},"#"),n(" pwa-popup")],-1),u=s("p",null,"Provide a popup component for users to activate the new PWA service worker manually.",-1),y=s("code",null,"skipWaiting",-1),v=s("code",null,"true",-1),C=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.
`,3);function b(h,E){const c=p("NpmBadge"),l=p("RouterLink");return r(),t("div",null,[d,a(c,{package:"@vuepress/plugin-pwa-popup"}),u,s("p",null,[n("This plugin must be used together with "),a(l,{to:"/reference/plugin/pwa.html"},{default:e(()=>[n("pwa plugin")]),_:1}),n(", and the "),y,n(" option must not be set to "),v,n(".")]),C,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(l,{to:"/guide/i18n.html"},{default:e(()=>[n("Guide > I18n")]),_:1})])])])]),m])}const f=i(D,[["render",b],["__file","pwa-popup.html.vue"]]);export{f as default};
diff --git a/assets/pwa-popup.html-VMOi2wzE.js b/assets/pwa-popup.html-VMOi2wzE.js
new file mode 100644
index 000000000..6c7cebcc4
--- /dev/null
+++ b/assets/pwa-popup.html-VMOi2wzE.js
@@ -0,0 +1,42 @@
+import{_ as r,r as p,o as i,c as D,d as a,a as s,b as n,w as e,e as o}from"./app-eU2v8o1B.js";const t={},d=s("h1",{id:"pwa-popup",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#pwa-popup","aria-hidden":"true"},"#"),n(" pwa-popup")],-1),y=s("p",null,"提供一个弹窗组件，允许用户手动刷新 PWA Service Worker 。",-1),u=s("code",null,"skipWaiting",-1),v=s("code",null,"true",-1),C=o(`
当新的 Service Worker 就绪时，会在页面右下角出现一个弹窗，询问用户是否需要激活处于 Waiting 状态的 Service Worker 。
But if you omit skipWaiting or set it to false, you have to activate the new service worker manually:
`,3),P=s("li",null,[n("For developers, you can use our "),s("a",{href:"#composition-api"},"composition API"),n(" to take control of the service worker behavior.")],-1),S=s("h3",{id:"serviceworkerfilename",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#serviceworkerfilename","aria-hidden":"true"},"#"),n(" serviceWorkerFilename")],-1),T=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string")])],-1),V=s("li",null,[s("p",null,[n("Default: "),s("code",null,"'service-worker.js'")])],-1),I=s("p",null,"Details:",-1),z=s("p",null,[n("The service worker file will only be generated in "),s("code",null,"build"),n(" mode.")],-1),B=s("h2",{id:"composition-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#composition-api","aria-hidden":"true"},"#"),n(" Composition API")],-1),N=s("h3",{id:"usepwaevent",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#usepwaevent","aria-hidden":"true"},"#"),n(" usePwaEvent")],-1),M=s("p",null,"Details:",-1),U=s("p",null,"Returns the event emitter of this plugin.",-1),G={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},L=s("li",null,[s("p",null,"Example:")],-1),R=l(`
import { usePwaEvent, useSkipWaiting } from'@vuepress/plugin-pwa/client'
+
+exportdefault {
+setup() {
+constevent = usePwaEvent()
+event.on('updated', (registration) => {
+console.log('The waiting service worker is available.')
+// activate the waiting service worker
+useSkipWaiting(registration)
+ })
+ },
+}
+
`,1);function J(K,Q){const r=t("NpmBadge"),a=t("ExternalLinkIcon"),o=t("RouterLink");return c(),D("div",null,[u,e(r,{package:"@vuepress/plugin-pwa"}),s("p",null,[n("Make your VuePress site a "),s("a",y,[n("Progressive Web Application (PWA)"),e(a)]),n(".")]),s("p",null,[n("This plugin uses "),s("a",v,[n("workbox-build"),e(a)]),n(" to generate service worker file, and uses "),s("a",h,[n("register-service-worker"),e(a)]),n(" to register service worker.")]),m,s("p",null,[n("To make your website fully compliant with PWA, you need to create a "),s("a",C,[n("Web app manifests"),e(a)]),n(" file and set the icons, colors, etc. for your PWA.")]),s("p",null,[n("You need to put your manifest file and icons into the "),e(o,{to:"/guide/assets.html#public-files"},{default:p(()=>[n("public files directory")]),_:1}),n(". In the following example, we assume that you are using the default public directory "),b,n(".")]),g,s("div",_,[f,s("p",null,[n("Some tools can help to do that. For example, "),s("a",E,[n("Favicon Generator"),e(a)]),n(" would help you to generate icons together with a sample manifest file.")])]),k,s("p",null,[n("You also need to set some tags via "),e(o,{to:"/reference/config.html#head"},{default:p(()=>[n("head")]),_:1}),n(" option to "),s("a",w,[n("deploy the manifest"),e(a)]),n(":")]),x,s("p",null,[n("This plugin accepts all parameters of workbox-build's "),s("a",q,[n("generateSW method"),e(a)]),n(" in its options, except "),F,n(" and "),A,n(".")]),W,s("ul",null,[s("li",null,[n("For users, you can use our "),e(o,{to:"/reference/plugin/pwa-popup.html"},{default:p(()=>[n("pwa-popup")]),_:1}),n(" plugin together.")]),P]),S,s("ul",null,[T,V,s("li",null,[I,s("p",null,[n("File path of the generated service worker file, which is relative to the "),e(o,{to:"/reference/config.html#dest"},{default:p(()=>[n("dest")]),_:1}),n(" directory.")]),z])]),B,N,s("ul",null,[s("li",null,[M,U,s("p",null,[n("You can add listener function to events that provided by "),s("a",G,[n("register-service-worker"),e(a)]),n(".")])]),L]),R,s("ul",null,[s("li",null,[j,s("p",null,[n("Call "),s("a",Y,[n("skipWaiting()"),e(a)]),n(" to activate the waiting service worker.")])]),O]),H])}const Z=i(d,[["render",J],["__file","pwa.html.vue"]]);export{Z as default};
diff --git a/assets/pwa.html-SVcJrjev.js b/assets/pwa.html-SVcJrjev.js
new file mode 100644
index 000000000..f982d7618
--- /dev/null
+++ b/assets/pwa.html-SVcJrjev.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-01fcaa4f","path":"/zh/reference/plugin/pwa.html","title":"pwa","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/pwa.md"}');export{e as data};
diff --git a/assets/pwa.html-dJHRD2Jh.js b/assets/pwa.html-dJHRD2Jh.js
new file mode 100644
index 000000000..33526c637
--- /dev/null
+++ b/assets/pwa.html-dJHRD2Jh.js
@@ -0,0 +1,68 @@
+import{_ as i,r,o as c,c as D,d as a,a as s,b as n,w as p,e as l}from"./app-eU2v8o1B.js";const d={},u=s("h1",{id:"pwa",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#pwa","aria-hidden":"true"},"#"),n(" pwa")],-1),y={href:"https://developer.mozilla.org/zh-CN/docs/Web/Progressive_web_apps",target:"_blank",rel:"noopener noreferrer"},v={href:"https://developers.google.com/web/tools/workbox/modules/workbox-build",target:"_blank",rel:"noopener noreferrer"},C={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},m=l(`
`,16),y=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string[]")])],-1),m=s("li",null,[s("p",null,[n("Default: "),s("code",null,"['**/*.vue']")])],-1),u=s("p",null,"Details:",-1),v={href:"https://github.com/sindresorhus/globby",target:"_blank",rel:"noopener noreferrer"},C=s("p",null,[n("The patterns are relative to "),s("a",{href:"#componentsdir"},"componentsDir"),n(".")],-1),h=l('
Notice that the filename is a filepath relative to componentsDir.
',2);function b(g,E){const p=a("NpmBadge"),o=a("ExternalLinkIcon");return r(),i("div",null,[D,e(p,{package:"@vuepress/plugin-register-components"}),d,s("ul",null,[y,m,s("li",null,[u,s("p",null,[n("Patterns to match component files using "),s("a",v,[n("globby"),e(o)]),n(".")]),C])]),h])}const _=t(c,[["render",b],["__file","register-components.html.vue"]]);export{_ as default};
diff --git a/assets/register-components.html-RP8lipwZ.js b/assets/register-components.html-RP8lipwZ.js
new file mode 100644
index 000000000..c54fd2ca6
--- /dev/null
+++ b/assets/register-components.html-RP8lipwZ.js
@@ -0,0 +1,49 @@
+import{_ as r,r as a,o as c,c as t,d as l,a as s,b as n,e}from"./app-eU2v8o1B.js";const i={},D=s("h1",{id:"register-components",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#register-components","aria-hidden":"true"},"#"),n(" register-components")],-1),d=e(`
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.
exportinterfaceHotKeyOptions {
+/**
+ * Value of \`event.key\` to trigger the hot key
+ */
+key: string;
+/**
+ * Whether to press \`event.altKey\` at the same time
+ *
+ * @defaultfalse
+ */
+alt?: boolean;
+/**
+ * Whether to press \`event.ctrlKey\` at the same time
+ *
+ * @defaultfalse
+ */
+ctrl?: boolean;
+/**
+ * Whether to press \`event.shiftKey\` at the same time
+ *
+ * @defaultfalse
+ */
+shift?: boolean;
+}
+
`,3),m=s("li",null,[s("p",null,[n("Default: "),s("code",null,"['s', '/']")])],-1),b=s("p",null,"Details:",-1),C={href:"http://keycode.info/",target:"_blank",rel:"noopener noreferrer"},g=s("p",null,"When hotkeys are pressed, the search box input will be focused.",-1),f=s("p",null,"Set to an empty array to disable hotkeys.",-1),E=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.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
`,15);function x(A,_){const i=l("NpmBadge"),p=l("RouterLink"),c=l("ExternalLinkIcon");return t(),d("div",null,[y,a(i,{package:"@vuepress/plugin-search"}),u,s("p",null,[n("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(p,{to:"/reference/plugin/docsearch.html"},{default:o(()=>[n("docsearch")]),_:1}),n(".")]),h,s("ul",null,[s("li",null,[n("Also see: "),s("ul",null,[s("li",null,[a(p,{to:"/guide/i18n.html"},{default:o(()=>[n("Guide > I18n")]),_:1})])])])]),v,s("ul",null,[m,s("li",null,[b,s("p",null,[n("Specify the "),s("a",C,[n("event.key"),a(c)]),n(" of the hotkeys.")]),g,f])]),E])}const F=r(D,[["render",x],["__file","search.html.vue"]]);export{F as default};
diff --git a/assets/search.html-fZuVMAaU.js b/assets/search.html-fZuVMAaU.js
new file mode 100644
index 000000000..4b67c5728
--- /dev/null
+++ b/assets/search.html-fZuVMAaU.js
@@ -0,0 +1,77 @@
+import{_ as r,r as e,o as t,c as D,d as a,a as s,b as n,w as o,e as l}from"./app-eU2v8o1B.js";const d={},y=s("h1",{id:"search",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#search","aria-hidden":"true"},"#"),n(" search")],-1),u=l(`
exportinterfaceHotKeyOptions {
+/**
+ * Value of \`event.key\` to trigger the hot key
+ */
+key: string;
+/**
+ * Whether to press \`event.altKey\` at the same time
+ *
+ * @defaultfalse
+ */
+alt?: boolean;
+/**
+ * Whether to press \`event.ctrlKey\` at the same time
+ *
+ * @defaultfalse
+ */
+ctrl?: boolean;
+/**
+ * Whether to press \`event.shiftKey\` at the same time
+ *
+ * @defaultfalse
+ */
+shift?: boolean;
+}
+
`,15);function x(A,_){const c=e("NpmBadge"),p=e("RouterLink"),i=e("ExternalLinkIcon");return t(),D("div",null,[y,a(c,{package:"@vuepress/plugin-search"}),u,s("p",null,[n("然而，当你的站点包含大量页面时，搜索索引文件也会变得非常大，它可能会拖慢你的页面加载速度。在这种情况下，我们建议你使用更成熟的解决方案 - "),a(p,{to:"/zh/reference/plugin/docsearch.html"},{default:o(()=>[n("docsearch")]),_:1}),n(" 。")]),v,s("ul",null,[s("li",null,[n("参考： "),s("ul",null,[s("li",null,[a(p,{to:"/zh/guide/i18n.html"},{default:o(()=>[n("指南 > 多语言支持")]),_:1})])])])]),h,s("ul",null,[C,s("li",null,[m,s("p",null,[n("指定热键的 "),s("a",b,[n("event.key"),a(i)]),n(" 。")]),E,g])]),f])}const k=r(d,[["render",x],["__file","search.html.vue"]]);export{k as default};
diff --git a/assets/search.html-uJRJ7ae7.js b/assets/search.html-uJRJ7ae7.js
new file mode 100644
index 000000000..5038c9c90
--- /dev/null
+++ b/assets/search.html-uJRJ7ae7.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-260e1012","path":"/reference/plugin/search.html","title":"search","lang":"en-US","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/search.md"}');export{e as data};
diff --git a/assets/shiki.html-0DoPKGkm.js b/assets/shiki.html-0DoPKGkm.js
new file mode 100644
index 000000000..893ea7b00
--- /dev/null
+++ b/assets/shiki.html-0DoPKGkm.js
@@ -0,0 +1,11 @@
+import{_ as t,r as i,o as r,c as p,d as n,a as s,b as e,e as l}from"./app-eU2v8o1B.js";const c={},d=s("h1",{id:"shiki",tabindex:"-1"},[s("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:"custom-container tip"},g=s("p",{class:"custom-container-title"},"TIP",-1),D={href:"https://shiki.matsu.io/",target:"_blank",rel:"noopener noreferrer"},m={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},_=s("p",null,[e("You could consider disabling this plugin in "),s("code",null,"dev"),e(" mode to get better development experience.")],-1),b=l(`
This option will be forwarded to getHighlighter() method of shiki.
If no languages are provided, shiki will load all available languages automatically.
",3),x=s("p",null,"Also see:",-1),E={href:"https://github.com/shikijs/shiki/blob/master/docs/languages.md",target:"_blank",rel:"noopener noreferrer"};function w(T,A){const o=i("NpmBadge"),a=i("ExternalLinkIcon");return r(),p("div",null,[d,n(o,{package:"@vuepress/plugin-shiki"}),s("p",null,[e("This plugin will enable syntax highlighting for markdown code fence with "),s("a",h,[e("Shiki"),n(a)]),e(".")]),s("div",u,[g,s("p",null,[s("a",D,[e("Shiki"),n(a)]),e(" is the syntax highlighter being used by VSCode. It has higher fidelity, but it is slower than "),s("a",m,[e("Prism.js"),n(a)]),e(".")]),_]),b,s("ul",null,[k,s("li",null,[v,s("ul",null,[s("li",null,[s("a",y,[e("shiki > themes"),n(a)])])])])]),f,s("ul",null,[C,s("li",null,[x,s("ul",null,[s("li",null,[s("a",E,[e("shiki > languages"),n(a)])])])])])])}const N=t(c,[["render",w],["__file","shiki.html.vue"]]);export{N as default};
diff --git a/assets/shiki.html-10ErS_oq.js b/assets/shiki.html-10ErS_oq.js
new file mode 100644
index 000000000..6e0b743b4
--- /dev/null
+++ b/assets/shiki.html-10ErS_oq.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-bb2079f4","path":"/reference/plugin/shiki.html","title":"shiki","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/shiki.md"}');export{e as data};
diff --git a/assets/shiki.html-ANgciB6g.js b/assets/shiki.html-ANgciB6g.js
new file mode 100644
index 000000000..e8c131f64
--- /dev/null
+++ b/assets/shiki.html-ANgciB6g.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-7a12fb77","path":"/zh/reference/plugin/shiki.html","title":"shiki","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/shiki.md"}');export{e as data};
diff --git a/assets/shiki.html-WJxb9HXD.js b/assets/shiki.html-WJxb9HXD.js
new file mode 100644
index 000000000..b1ec69876
--- /dev/null
+++ b/assets/shiki.html-WJxb9HXD.js
@@ -0,0 +1,11 @@
+import{_ as r,r as i,o as t,c as p,d as n,a as s,b as e,e as l}from"./app-eU2v8o1B.js";const c={},d=s("h1",{id:"shiki",tabindex:"-1"},[s("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:"custom-container tip"},D=s("p",{class:"custom-container-title"},"提示",-1),_={href:"https://shiki.matsu.io/",target:"_blank",rel:"noopener noreferrer"},m={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},k=s("p",null,[e("你可以考虑在 "),s("code",null,"dev"),e(" 模式下禁用该插件来获取更好的开发体验。")],-1),g=l(`
`,12);function C(v,b){const p=a("NpmBadge"),o=a("ExternalLinkIcon");return D(),c("div",null,[i,l(p,{package:"@vuepress/theme-default"}),n("p",null,[s("默认主题使用 "),n("a",y,[s("SASS"),l(o)]),s(" 作为 CSS 预处理器。")]),d])}const u=e(t,[["render",C],["__file","styles.html.vue"]]);export{u as default};
diff --git a/assets/theme-api.html--P_ZE6Od.js b/assets/theme-api.html--P_ZE6Od.js
new file mode 100644
index 000000000..cfc0e4a50
--- /dev/null
+++ b/assets/theme-api.html--P_ZE6Od.js
@@ -0,0 +1,10 @@
+import{_ as o,r as a,o as p,c as r,d as n,a as e,b as l,w as t,e as d}from"./app-eU2v8o1B.js";const c={},u=e("h1",{id:"theme-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme-api","aria-hidden":"true"},"#"),l(" Theme API")],-1),h=d(`
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,[l("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),D=e("p",null,"Also see:",-1),_=e("h3",{id:"templatebuild",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#templatebuild","aria-hidden":"true"},"#"),l(" templateBuild")],-1),y=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),v=e("p",null,"Details:",-1),b=e("p",null,"Specify the path of the HTML template for build.",-1),g=e("p",null,"Also see:",-1),C=e("h3",{id:"templatebuildrenderer",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#templatebuildrenderer","aria-hidden":"true"},"#"),l(" templateBuildRenderer")],-1),x=e("li",null,[e("p",null,[l("Type: "),e("code",null,"TemplateRenderer")])],-1),T=e("p",null,"Details:",-1),w=e("p",null,"Specify the HTML template renderer to be used for build.",-1),A=e("p",null,"Also see:",-1),B=e("h3",{id:"templatedev",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#templatedev","aria-hidden":"true"},"#"),l(" templateDev")],-1),E=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),k=e("p",null,"Details:",-1),P=e("p",null,"Specify the HTML template for dev.",-1),I=e("p",null,"Also see:",-1);function F(N,R){const i=a("NpmBadge"),s=a("RouterLink");return p(),r("div",null,[u,n(i,{package:"@vuepress/core"}),e("p",null,[l("VuePress theme also works as a plugin, so Theme API can accept all the options of "),n(s,{to:"/reference/plugin-api.html"},{default:t(()=>[l("Plugin API")]),_:1}),l(" with following differences.")]),h,e("ul",null,[m,f,e("li",null,[D,e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#plugins"},{default:t(()=>[l("Config > plugins")]),_:1})])])])]),_,e("ul",null,[y,e("li",null,[v,b,e("p",null,[l("It would override the default value of "),n(s,{to:"/reference/config.html#templatebuild"},{default:t(()=>[l("templateBuild")]),_:1}),l(", and could be overridden by user config.")])]),e("li",null,[g,e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#templatebuild"},{default:t(()=>[l("Config > templateBuild")]),_:1})])])])]),C,e("ul",null,[x,e("li",null,[T,w,e("p",null,[l("It would override the default value of "),n(s,{to:"/reference/config.html#templatebuildrenderer"},{default:t(()=>[l("templateBuildRenderer")]),_:1}),l(", and could be overridden by user config.")])]),e("li",null,[A,e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#templatebuildrenderer"},{default:t(()=>[l("Config > templateBuildRenderer")]),_:1})])])])]),B,e("ul",null,[E,e("li",null,[k,P,e("p",null,[l("It would override the default value of "),n(s,{to:"/reference/config.html#templatedev"},{default:t(()=>[l("templateDev")]),_:1}),l(", but could be overridden by user config.")])]),e("li",null,[I,e("ul",null,[e("li",null,[n(s,{to:"/reference/config.html#templatedev"},{default:t(()=>[l("Config > templateDev")]),_:1})])])])])])}const L=o(c,[["render",F],["__file","theme-api.html.vue"]]);export{L as default};
diff --git a/assets/theme-api.html-KX9s0kwh.js b/assets/theme-api.html-KX9s0kwh.js
new file mode 100644
index 000000000..646821d7a
--- /dev/null
+++ b/assets/theme-api.html-KX9s0kwh.js
@@ -0,0 +1,10 @@
+import{_ as i,r as t,o,c as r,d as n,a as e,b as l,w as a,e as d}from"./app-eU2v8o1B.js";const c={},u=e("h1",{id:"主题-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#主题-api","aria-hidden":"true"},"#"),l(" 主题 API")],-1),h=d(`
`,17);function u(m,v){const e=n("NpmBadge"),p=n("RouterLink");return c(),t("div",null,[d,l(e,{package:"@vuepress/plugin-theme-data"}),a("p",null,[s("为你的主题提供客户端数据，包含 VuePress 的 "),l(p,{to:"/zh/guide/i18n.html"},{default:D(()=>[s("多语言支持")]),_:1}),s(" 。")]),y])}const h=o(r,[["render",u],["__file","theme-data.html.vue"]]);export{h as default};
diff --git a/assets/theme-data.html-O0pSpAdt.js b/assets/theme-data.html-O0pSpAdt.js
new file mode 100644
index 000000000..83e07138e
--- /dev/null
+++ b/assets/theme-data.html-O0pSpAdt.js
@@ -0,0 +1,51 @@
+import{_ as o,r as n,o as t,c as i,d as e,a,b as s,w as c,e as r}from"./app-eU2v8o1B.js";const D={},d=a("h1",{id:"theme-data",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#theme-data","aria-hidden":"true"},"#"),s(" theme-data")],-1),y=r(`
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 u(m,h){const l=n("NpmBadge"),p=n("RouterLink");return t(),i("div",null,[d,e(l,{package:"@vuepress/plugin-theme-data"}),a("p",null,[s("Provide client data for your theme, with VuePress "),e(p,{to:"/guide/i18n.html"},{default:c(()=>[s("i18n")]),_:1}),s(" support.")]),y])}const C=o(D,[["render",u],["__file","theme-data.html.vue"]]);export{C as default};
diff --git a/assets/theme-data.html-ODrPozv0.js b/assets/theme-data.html-ODrPozv0.js
new file mode 100644
index 000000000..5affce0a5
--- /dev/null
+++ b/assets/theme-data.html-ODrPozv0.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":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/theme-data.md"}');export{e as data};
diff --git a/assets/theme.html-1lMGI_to.js b/assets/theme.html-1lMGI_to.js
new file mode 100644
index 000000000..e0b114586
--- /dev/null
+++ b/assets/theme.html-1lMGI_to.js
@@ -0,0 +1,14 @@
+import{_ as i,r as t,o as r,c,a as e,b as s,d as n,w as o,e as p}from"./app-eU2v8o1B.js";const d={},u=e("h1",{id:"theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme","aria-hidden":"true"},"#"),s(" 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"},"#"),s(" Default Theme")],-1),D=e("p",null,"VuePress has a default theme out of the box, which is applied to our documentation site you are currently browsing.",-1),y=e("p",null,"If you don't specify the theme to use, the default theme will be used automatically.",-1),f=p(`
`,1),v=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),_=e("h2",{id:"community-theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#community-theme","aria-hidden":"true"},"#"),s(" Community Theme")],-1),b={href:"https://www.npmjs.com/search?q=keywords:vuepress-theme",target:"_blank",rel:"noopener noreferrer"},C=e("h2",{id:"local-theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#local-theme","aria-hidden":"true"},"#"),s(" Local Theme")],-1);function g(w,x){const a=t("RouterLink"),l=t("ExternalLinkIcon");return r(),c("div",null,[u,h,m,D,y,e("p",null,[s("To configure the default theme, you need to import and use it in your config file via the "),n(a,{to:"/reference/config.html#theme"},{default:o(()=>[s("theme")]),_:1}),s(" option:")]),f,e("p",null,[s("The default theme provides basic but useful features for documentation site, you can check out "),n(a,{to:"/reference/default-theme/config.html"},{default:o(()=>[s("Default Theme Config Reference")]),_:1}),s(" for a full list of config.")]),v,_,e("p",null,[s("Community users have created lots of theme and published them to "),e("a",b,[s("NPM"),n(l)]),s(". You should check the theme's own documentation for detailed guide.")]),C,e("p",null,[s("If you want to use your own custom theme but don't want to publish it, you can create a local theme. Refer to "),n(a,{to:"/advanced/theme.html"},{default:o(()=>[s("Advanced > Writing a Theme")]),_:1}),s(" for how to write your own theme.")])])}const E=i(d,[["render",g],["__file","theme.html.vue"]]);export{E as default};
diff --git a/assets/theme.html-AYISgrKz.js b/assets/theme.html-AYISgrKz.js
new file mode 100644
index 000000000..55dcad977
--- /dev/null
+++ b/assets/theme.html-AYISgrKz.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-06329db8","path":"/advanced/theme.html","title":"Writing a Theme","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"advanced/theme.md"}');export{e as data};
diff --git a/assets/theme.html-HAoqhZVd.js b/assets/theme.html-HAoqhZVd.js
new file mode 100644
index 000000000..98b577343
--- /dev/null
+++ b/assets/theme.html-HAoqhZVd.js
@@ -0,0 +1,14 @@
+import{_ as p,r as o,o as r,c,a as s,b as n,d as e,w as l,e as i}from"./app-eU2v8o1B.js";const d={},D=s("h1",{id:"主题",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#主题","aria-hidden":"true"},"#"),n(" 主题")],-1),h=s("p",null,"VuePress 主题为你提供了布局、样式和其他功能，帮助你专注于 Markdown 内容的写作。",-1),u=s("h2",{id:"默认主题",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#默认主题","aria-hidden":"true"},"#"),n(" 默认主题")],-1),m=s("p",null,"VuePress 有一个开箱即用的默认主题，正使用在你当前正在浏览的文档网站上。",-1),_=s("p",null,"如果你不指定要使用的主题，那么就会自动使用默认主题。",-1),y=i(`
`,1),f=n("code",null,"name",-1),k=n("code",null,"vuepress-theme-xxx",-1),x=n("code",null,"@org/vuepress-theme-xxx",-1),A=n("em",null,"主题对象",-1),N=n("li",null,[s("在 "),n("code",null,"keywords"),s(" 中包含 "),n("code",null,"vuepress-theme"),s(" ，这样用户可以在 NPM 上搜索到你的主题。")],-1);function L(q,j){const l=o("RouterLink"),c=o("ExternalLinkIcon");return r(),i("div",null,[d,n("div",y,[u,n("p",null,[s("在阅读该指南之前，你最好先了解一下 "),a(l,{to:"/zh/advanced/plugin.html"},{default:e(()=>[s("开发插件")]),_:1}),s(" 指南。")])]),v,n("p",null,[s("VuePress 主题是一个特殊的插件，它应该符合 "),a(l,{to:"/zh/reference/theme-api.html"},{default:e(()=>[s("主题 API")]),_:1}),s(" 。和插件一样，主题可以是一个 "),m,s(" 或一个 "),C,s(" ，并且通常通过一个函数来接收配置项：")]),b,n("p",null,[h,s(" 布局应该包含 "),a(l,{to:"/zh/reference/components.html#content"},{default:e(()=>[s("Content")]),_:1}),s(" 组件来展示 Markdown 内容：")]),_,n("p",null,[s("你可以提供多个布局，用户可以通过 "),a(l,{to:"/zh/reference/frontmatter.html#layout"},{default:e(()=>[s("layout")]),_:1}),s(" Frontmatter 来修改布局。")]),E,n("p",null,[s("同样的，对于主题也有 "),n("a",g,[s("package.json"),a(c)]),s(" 相关的约定：")]),F,n("ul",null,[n("li",null,[s("将 "),f,s(" 按照约定命名： "),k,s(" 或 "),x,s(" ，它应该和 "),A,s(" 的 "),a(l,{to:"/zh/reference/theme-api.html#name"},{default:e(()=>[s("name")]),_:1}),s(" 字段保持一致。")]),N])])}const z=t(D,[["render",L],["__file","theme.html.vue"]]);export{z as default};
diff --git a/assets/theme.html-PWswBlx_.js b/assets/theme.html-PWswBlx_.js
new file mode 100644
index 000000000..65f510447
--- /dev/null
+++ b/assets/theme.html-PWswBlx_.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-2efcb26a","path":"/zh/guide/theme.html","title":"主题","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"默认主题","slug":"默认主题","link":"#默认主题","children":[]},{"level":2,"title":"社区主题","slug":"社区主题","link":"#社区主题","children":[]},{"level":2,"title":"本地主题","slug":"本地主题","link":"#本地主题","children":[]}],"git":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/guide/theme.md"}');export{e as data};
diff --git a/assets/theme.html-bQwRzLau.js b/assets/theme.html-bQwRzLau.js
new file mode 100644
index 000000000..ed6ba4f47
--- /dev/null
+++ b/assets/theme.html-bQwRzLau.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-66c42ad6","path":"/zh/advanced/theme.html","title":"开发主题","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"创建一个主题","slug":"创建一个主题","link":"#创建一个主题","children":[]},{"level":2,"title":"发布到 NPM","slug":"发布到-npm","link":"#发布到-npm","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/advanced/theme.md"}');export{e as data};
diff --git a/assets/theme.html-pdgRQ6zJ.js b/assets/theme.html-pdgRQ6zJ.js
new file mode 100644
index 000000000..1e9ede4f1
--- /dev/null
+++ b/assets/theme.html-pdgRQ6zJ.js
@@ -0,0 +1,58 @@
+import{_ as c,r as p,o as r,c as i,a as n,b as s,d as a,w as e,e as o}from"./app-eU2v8o1B.js";const D={},d=n("h1",{id:"writing-a-theme",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#writing-a-theme","aria-hidden":"true"},"#"),s(" Writing a Theme")],-1),y={class:"custom-container tip"},u=n("p",{class:"custom-container-title"},"TIP",-1),m=n("h2",{id:"create-a-theme",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#create-a-theme","aria-hidden":"true"},"#"),s(" Create a Theme")],-1),v=n("em",null,"Theme Object",-1),h=n("em",null,"Theme Function",-1),C=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),f=n("h2",{id:"publish-to-npm",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#publish-to-npm","aria-hidden":"true"},"#"),s(" Publish to NPM")],-1),g={href:"https://docs.npmjs.com/cli/v8/configuring-npm/package-json",target:"_blank",rel:"noopener noreferrer"},E=o(`
`,1),F=n("code",null,"name",-1),k=n("code",null,"vuepress-theme-xxx",-1),A=n("code",null,"@org/vuepress-theme-xxx",-1),x=n("em",null,"Theme Object",-1),w=n("li",null,[s("Set "),n("code",null,"keywords"),s(" to include "),n("code",null,"vuepress-theme"),s(", so that users can search your theme on NPM.")],-1);function T(N,j){const l=p("RouterLink"),t=p("ExternalLinkIcon");return r(),i("div",null,[d,n("div",y,[u,n("p",null,[s("Before reading this guide, you'd better learn the guide of "),a(l,{to:"/advanced/plugin.html"},{default:e(()=>[s("Writing a Plugin")]),_:1}),s(" first.")])]),m,n("p",null,[s("A VuePress theme is a special plugin, which should satisfy the "),a(l,{to:"/reference/theme-api.html"},{default:e(()=>[s("Theme API")]),_:1}),s(". Like plugins, a theme should also be a "),v,s(" or a "),h,s(", and could be wrapped with a function to receive options:")]),C,n("p",null,[s("The "),b,s(" layout should contain the "),a(l,{to:"/reference/components.html#content"},{default:e(()=>[s("Content")]),_:1}),s(" component to display the markdown content:")]),_,n("p",null,[s("You can provide more layouts, and users can change layout via "),a(l,{to:"/reference/frontmatter.html#layout"},{default:e(()=>[s("layout")]),_:1}),s(" frontmatter.")]),f,n("p",null,[s("Also, there are some conventions for theme in "),n("a",g,[s("package.json"),a(t)]),s(":")]),E,n("ul",null,[n("li",null,[s("Set "),F,s(" to follow the naming convention: "),k,s(" or "),A,s(", which should be consistent with the "),a(l,{to:"/reference/theme-api.html#name"},{default:e(()=>[s("name")]),_:1}),s(" field of the "),x,s(".")]),w])])}const q=c(D,[["render",T],["__file","theme.html.vue"]]);export{q as default};
diff --git a/assets/theme.html-wQhmGWE7.js b/assets/theme.html-wQhmGWE7.js
new file mode 100644
index 000000000..1afd9f164
--- /dev/null
+++ b/assets/theme.html-wQhmGWE7.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-4d76029c","path":"/guide/theme.html","title":"Theme","lang":"en-US","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"guide/theme.md"}');export{e as data};
diff --git a/assets/toc.html-5nixziN1.js b/assets/toc.html-5nixziN1.js
new file mode 100644
index 000000000..eb024c2ad
--- /dev/null
+++ b/assets/toc.html-5nixziN1.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-76709450","path":"/reference/plugin/toc.html","title":"toc","lang":"en-US","frontmatter":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"reference/plugin/toc.md"}');export{e as data};
diff --git a/assets/toc.html-UM_HyWdr.js b/assets/toc.html-UM_HyWdr.js
new file mode 100644
index 000000000..b8a286546
--- /dev/null
+++ b/assets/toc.html-UM_HyWdr.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-048d95fe","path":"/zh/reference/plugin/toc.html","title":"toc","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"与 Markdown 目录语法的区别","slug":"与-markdown-目录语法的区别","link":"#与-markdown-目录语法的区别","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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/plugin/toc.md"}');export{e as data};
diff --git a/assets/toc.html-a3Qmvl1r.js b/assets/toc.html-a3Qmvl1r.js
new file mode 100644
index 000000000..b879a3bbd
--- /dev/null
+++ b/assets/toc.html-a3Qmvl1r.js
@@ -0,0 +1,74 @@
+import{_ as t,r as o,o as r,c as i,d as a,a as n,b as s,w as e,e as p}from"./app-eU2v8o1B.js";const D={},d=n("h1",{id:"toc",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#toc","aria-hidden":"true"},"#"),s(" toc")],-1),y=p(`
<template>
+<!-- container -->
+<navclass="vuepress-toc">
+<!-- list -->
+<ulclass="vuepress-toc-list">
+<!-- item -->
+<liclass="vuepress-toc-item">
+<!-- link -->
+<RouterLinkclass="vuepress-toc-link"to="#foo">Foo</RouterLink>
+</li>
+<!-- item with children -->
+<liclass="vuepress-toc-item">
+<!-- link (children active) -->
+<RouterLinkclass="vuepress-toc-link active"to="#bar">Bar</RouterLink>
+<!-- list (children) -->
+<ulclass="vuepress-toc-list">
+<!-- item -->
+<liclass="vuepress-toc-item">
+<!-- link (active) -->
+<RouterLinkclass="vuepress-toc-link active"to="#bar-child">
+ Bar Child
+</RouterLink>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</template>
+
`,20);function b(h,E){const c=o("NpmBadge"),l=o("RouterLink");return r(),i("div",null,[d,a(c,{package:"@vuepress/plugin-toc"}),y,n("p",null,[s("与 "),a(l,{to:"/zh/guide/markdown.html#%E7%9B%AE%E5%BD%95"},{default:e(()=>[s("Markdown 目录语法")]),_:1}),s(" 类似，该插件提供的目录组件可以直接在你的 Markdown 内容中使用：")]),u,n("p",null,[s("该插件可以和 "),a(l,{to:"/zh/reference/plugin/active-header-links.html"},{default:e(()=>[s("@vuepress/plugin-active-header-links")]),_:1}),s(" 协同工作，你只需要将 "),a(l,{to:"/zh/reference/plugin/active-header-links.html#headerlinkselector"},{default:e(()=>[s("headerLinkSelector")]),_:1}),s(" 与该插件的 "),v,s(" 匹配即可。当页面滚动至某个标题锚点后，对应的链接就会被加上 "),C,s(" 类名。")]),m])}const k=t(D,[["render",b],["__file","toc.html.vue"]]);export{k as default};
diff --git a/assets/toc.html-k5VmjERh.js b/assets/toc.html-k5VmjERh.js
new file mode 100644
index 000000000..e5505c426
--- /dev/null
+++ b/assets/toc.html-k5VmjERh.js
@@ -0,0 +1,74 @@
+import{_ as c,r as o,o as r,c as i,d as a,a as n,b as s,w as e,e as p}from"./app-eU2v8o1B.js";const D={},d=n("h1",{id:"toc",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#toc","aria-hidden":"true"},"#"),s(" toc")],-1),y=p(`
This plugin will provide a table-of-contents (TOC) component.
If the containerTag is set to an empty string '', the <nav> container will be removed totally.
Example:
The rendered TOC component with default options looks like:
<template>
+<!-- container -->
+<navclass="vuepress-toc">
+<!-- list -->
+<ulclass="vuepress-toc-list">
+<!-- item -->
+<liclass="vuepress-toc-item">
+<!-- link -->
+<RouterLinkclass="vuepress-toc-link"to="#foo">Foo</RouterLink>
+</li>
+<!-- item with children -->
+<liclass="vuepress-toc-item">
+<!-- link (children active) -->
+<RouterLinkclass="vuepress-toc-link active"to="#bar">Bar</RouterLink>
+<!-- list (children) -->
+<ulclass="vuepress-toc-list">
+<!-- item -->
+<liclass="vuepress-toc-item">
+<!-- link (active) -->
+<RouterLinkclass="vuepress-toc-link active"to="#bar-child">
+ Bar Child
+</RouterLink>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</template>
+
`,20);function h(b,g){const t=o("NpmBadge"),l=o("RouterLink");return r(),i("div",null,[d,a(t,{package:"@vuepress/plugin-toc"}),y,n("p",null,[s("Similar to the "),a(l,{to:"/guide/markdown.html#table-of-contents"},{default:e(()=>[s("Table of Contents Markdown Syntax")]),_:1}),s(", the TOC component that provided by this plugin could be used in your markdown content directly:")]),u,n("p",null,[s("This plugin could work together with "),a(l,{to:"/reference/plugin/active-header-links.html"},{default:e(()=>[s("@vuepress/plugin-active-header-links")]),_:1}),s(" by setting the "),a(l,{to:"/reference/plugin/active-header-links.html#headerlinkselector"},{default:e(()=>[s("headerLinkSelector")]),_:1}),s(" to match the "),v,s(" option. When the page scroll to a certain header anchor, this corresponding link will be added "),C,s(" class name.")]),m])}const k=c(D,[["render",h],["__file","toc.html.vue"]]);export{k as default};
diff --git a/assets/usage-of-client-config.html-2Br2VXom.js b/assets/usage-of-client-config.html-2Br2VXom.js
new file mode 100644
index 000000000..46d3764f4
--- /dev/null
+++ b/assets/usage-of-client-config.html-2Br2VXom.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":{},"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":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"advanced/cookbook/usage-of-client-config.md"}');export{e as data};
diff --git a/assets/usage-of-client-config.html-WviU2RhQ.js b/assets/usage-of-client-config.html-WviU2RhQ.js
new file mode 100644
index 000000000..58a800898
--- /dev/null
+++ b/assets/usage-of-client-config.html-WviU2RhQ.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-c03241b4","path":"/zh/advanced/cookbook/usage-of-client-config.html","title":"客户端配置的使用方法","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"enhance","slug":"enhance","link":"#enhance","children":[{"level":3,"title":"注册 Vue 组件","slug":"注册-vue-组件","link":"#注册-vue-组件","children":[]},{"level":3,"title":"使用不支持 SSR 的功能","slug":"使用不支持-ssr-的功能","link":"#使用不支持-ssr-的功能","children":[]},{"level":3,"title":"使用 Router 方法","slug":"使用-router-方法","link":"#使用-router-方法","children":[]}]},{"level":2,"title":"setup","slug":"setup","link":"#setup","children":[{"level":3,"title":"使用组合式 API","slug":"使用组合式-api","link":"#使用组合式-api","children":[]},{"level":3,"title":"使用不支持 SSR 的功能","slug":"使用不支持-ssr-的功能-1","link":"#使用不支持-ssr-的功能-1","children":[]}]},{"level":2,"title":"layouts","slug":"layouts","link":"#layouts","children":[]},{"level":2,"title":"rootComponents","slug":"rootcomponents","link":"#rootcomponents","children":[]}],"git":{"updatedTime":1702213846000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1},{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/advanced/cookbook/usage-of-client-config.md"}');export{e as data};
diff --git a/assets/usage-of-client-config.html-d0TxxEeJ.js b/assets/usage-of-client-config.html-d0TxxEeJ.js
new file mode 100644
index 000000000..37c4ff6e0
--- /dev/null
+++ b/assets/usage-of-client-config.html-d0TxxEeJ.js
@@ -0,0 +1,87 @@
+import{_ as r,r as t,o as c,c as i,a as n,b as s,d as a,w as e,e as o}from"./app-eU2v8o1B.js";const D={},d=n("h1",{id:"客户端配置的使用方法",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#客户端配置的使用方法","aria-hidden":"true"},"#"),s(" 客户端配置的使用方法")],-1),y=o(`
The enhance function could be either synchronous or asynchronous. It accepts a context param with following properties:
`,3),v=n("code",null,"app",-1),m={href:"https://vuejs.org/api/application.html#createapp",target:"_blank",rel:"noopener noreferrer"},h=n("code",null,"router",-1),f={href:"https://router.vuejs.org/api/#createrouter",target:"_blank",rel:"noopener noreferrer"},b=n("code",null,"siteData",-1),g=n("p",null,[s("The "),n("code",null,"enhance"),s(" function will be invoked after the client app is created. It's possible to implement any enhancements to the Vue application.")],-1),_=n("h3",{id:"register-vue-components",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#register-vue-components","aria-hidden":"true"},"#"),s(" Register Vue Components")],-1),E={href:"https://vuejs.org/api/application.html#app-component",target:"_blank",rel:"noopener noreferrer"},F=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),w=n("code",null,"setup",-1),M={href:"https://vuejs.org/api/composition-api-setup.html",target:"_blank",rel:"noopener noreferrer"},I=n("h3",{id:"use-composition-api",tabindex:"-1"},[n("a",{class:"header-anchor",href:"#use-composition-api","aria-hidden":"true"},"#"),s(" Use Composition API")],-1),V=n("code",null,"setup",-1),P={href:"https://vuejs.org/api/composition-api-setup.html",target:"_blank",rel:"noopener noreferrer"},j=o(`
import { defineClientConfig } from'@vuepress/client'
+import { provide, ref } from'vue'
+import { useRoute, useRouter } from'vue-router'
+
+exportdefaultdefineClientConfig({
+setup() {
+// get the current route location
+constroute = useRoute()
+// get the vue-router instance
+constrouter = useRouter()
+// provide a value that can be injected by layouts, pages and other components
+constcount = ref(0)
+provide('count', count)
+ },
+})
+
`,5);function G(Y,W){const e=t("RouterLink"),p=t("ExternalLinkIcon");return c(),i("div",null,[d,n("p",null,[s("You can make use of the "),a(e,{to:"/guide/configuration.html#client-config-file"},{default:l(()=>[s("client config file")]),_:1}),s(" directly in your project, or specify the file path in your plugin or theme via "),a(e,{to:"/reference/plugin-api.html#clientconfigfile"},{default:l(()=>[s("clientConfigFile")]),_:1}),s(" hook:")]),y,n("p",null,[s("Inside the client config file, "),u,s(" package provides a helper function "),a(e,{to:"/reference/client-api.html#defineclientconfig"},{default:l(()=>[s("defineClientConfig")]),_:1}),s(" to help you define the client config:")]),C,n("ul",null,[n("li",null,[v,s(" is the Vue application instance that created by "),n("a",m,[s("createApp"),a(p)]),s(".")]),n("li",null,[h,s(" is the Vue Router instance that created by "),n("a",f,[s("createRouter"),a(p)]),s(".")]),n("li",null,[b,s(" is a ref of an object that generated from user config, including "),a(e,{to:"/reference/config.html#base"},{default:l(()=>[s("base")]),_:1}),s(", "),a(e,{to:"/reference/config.html#lang"},{default:l(()=>[s("lang")]),_:1}),s(", "),a(e,{to:"/reference/config.html#title"},{default:l(()=>[s("title")]),_:1}),s(", "),a(e,{to:"/reference/config.html#description"},{default:l(()=>[s("description")]),_:1}),s(", "),a(e,{to:"/reference/config.html#head"},{default:l(()=>[s("head")]),_:1}),s(" and "),a(e,{to:"/reference/config.html#locales"},{default:l(()=>[s("locales")]),_:1}),s(".")])]),g,_,n("p",null,[s("You can register global Vue components via the "),n("a",E,[s("app.component"),a(p)]),s(" method:")]),F,n("p",null,[s("We already provides a "),a(e,{to:"/reference/components.html#clientonly"},{default:l(()=>[s("ClientOnly")]),_:1}),s(" component to wrap non-SSR-friendly content.")]),n("p",null,[s("In the "),A,s(" function, you can make use of the "),a(e,{to:"/reference/client-api.html#ssr"},{default:l(()=>[k]),_:1}),s(" flag for that purpose.")]),x,n("p",null,[s("You can make use of the "),n("a",S,[s("Router Methods"),a(p)]),s(" that provided by vue-router. For example, add navigation guard:")]),R,n("p",null,[s("The "),w,s(" function would be invoked inside the "),n("a",M,[s("setup"),a(p)]),s(" hook of the client vue app.")]),I,n("p",null,[s("You can take the "),V,s(" function as part of the "),n("a",P,[s("setup"),a(p)]),s(" hook of the root component. Thus, all composition APIs are available here.")]),j,n("p",null,[s("In the "),T,s(" function, the "),a(e,{to:"/reference/client-api.html#ssr"},{default:l(()=>[N]),_:1}),s(" flag is also available.")]),n("p",null,[s("Another way to use non-ssr-friendly features is to put them inside the "),n("a",U,[s("onMounted"),a(p)]),s(" hook:")]),L,n("p",null,[s("The "),B,s(" 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:l(()=>[s("layout")]),_:1}),s(" frontmatter.")]),O])}const z=r(D,[["render",G],["__file","usage-of-client-config.html.vue"]]);export{z as default};
diff --git a/assets/vite.html-ATywsxtj.js b/assets/vite.html-ATywsxtj.js
new file mode 100644
index 000000000..cb5e7f7d0
--- /dev/null
+++ b/assets/vite.html-ATywsxtj.js
@@ -0,0 +1,11 @@
+import{_ as p,r as a,o as r,c as t,d as n,a as s,b as e,e as i}from"./app-eU2v8o1B.js";const c={},d=s("h1",{id:"vite",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#vite","aria-hidden":"true"},"#"),e(" Vite")],-1),u={href:"https://www.npmjs.com/package/@vuepress/bundler-vite",target:"_blank",rel:"noopener noreferrer"},D={href:"https://www.npmjs.com/package/vuepress",target:"_blank",rel:"noopener noreferrer"},v=i(`
`,5),h=s("li",null,[s("p",null,"Details:"),s("p",null,"Accepts all options of Vite.")],-1),y=s("p",null,"Also see:",-1),_={href:"https://vitejs.dev/config/",target:"_blank",rel:"noopener noreferrer"},b=s("h3",{id:"vuepluginoptions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#vuepluginoptions","aria-hidden":"true"},"#"),e(" vuePluginOptions")],-1),m=s("p",null,"Details:",-1),f={href:"https://www.npmjs.com/package/@vitejs/plugin-vue",target:"_blank",rel:"noopener noreferrer"},C=s("p",null,"Also see:",-1),g={href:"https://vitejs.dev/plugins/#vitejs-plugin-vue",target:"_blank",rel:"noopener noreferrer"};function k(E,x){const o=a("NpmBadge"),l=a("ExternalLinkIcon");return t(),i("div",null,[d,n(o,{package:"@vuepress/bundler-vite"}),s("p",null,[e("Vite bundler is provided by "),s("a",u,[e("@vuepress/bundler-vite"),n(l)]),e(" package. It is a dependency of the "),s("a",D,[e("vuepress"),n(l)]),e(" package, and you can also install it separately.")]),v,s("ul",null,[h,s("li",null,[y,s("ul",null,[s("li",null,[s("a",_,[e("Vite > Config"),n(l)])])])])]),b,s("ul",null,[s("li",null,[m,s("p",null,[e("Accepts all options of "),s("a",f,[e("@vitejs/plugin-vue"),n(l)]),e(".")])]),s("li",null,[C,s("ul",null,[s("li",null,[s("a",g,[e("Vite > Plugins > Official Plugins"),n(l)])])])])])])}const w=p(c,[["render",k],["__file","vite.html.vue"]]);export{w as default};
diff --git a/assets/vite.html-UcIosjal.js b/assets/vite.html-UcIosjal.js
new file mode 100644
index 000000000..4ea0ed972
--- /dev/null
+++ b/assets/vite.html-UcIosjal.js
@@ -0,0 +1 @@
+const e=JSON.parse('{"key":"v-6ff623ea","path":"/zh/reference/bundler/vite.html","title":"Vite","lang":"zh-CN","frontmatter":{},"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":{"updatedTime":1701614677000,"contributors":[{"name":"meteorlxy","email":"meteor.lxy@foxmail.com","commits":1}]},"filePathRelative":"zh/reference/bundler/vite.md"}');export{e as data};
diff --git a/assets/vuepress-core-process-9C1P9KT4.js b/assets/vuepress-core-process-9C1P9KT4.js
new file mode 100644
index 000000000..948e92ec3
--- /dev/null
+++ b/assets/vuepress-core-process-9C1P9KT4.js
@@ -0,0 +1 @@
+const e="/images/guide/vuepress-architecture-overview.png",s="/images/guide/vuepress-core-process.png";export{e as _,s as a};
diff --git a/assets/webpack.html--2xfMMIX.js b/assets/webpack.html--2xfMMIX.js
new file mode 100644
index 000000000..96493b5a2
--- /dev/null
+++ b/assets/webpack.html--2xfMMIX.js
@@ -0,0 +1,11 @@
+import{_ as i,r as a,o as c,c as p,d as l,a as e,b as s,w as d,e as o}from"./app-eU2v8o1B.js";const u={},h=e("h1",{id:"webpack",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#webpack","aria-hidden":"true"},"#"),s(" 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"},v=o(`
`,5),g=e("li",null,[e("p",null,[s("Type: "),e("code",null,"(config: WebpackConfiguration, isServer: boolean, isBuild: boolean) => WebpackConfiguration | void")])],-1),D=e("p",null,"Details:",-1),v=e("p",null,"Edit the internal webpack config.",-1),k=e("code",null,"isServer",-1),y=e("code",null,"isBuild",-1),m={href:"https://github.com/survivejs/webpack-merge",target:"_blank",rel:"noopener noreferrer"},w=e("h3",{id:"chainwebpack",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#chainwebpack","aria-hidden":"true"},"#"),s(" chainWebpack")],-1),C=e("li",null,[e("p",null,[s("Type: "),e("code",null,"(config: WebpackChainConfig, isServer: boolean, isBuild: boolean) => void")])],-1),x=e("p",null,"Details:",-1),S={href:"https://github.com/mozilla-neutrino/webpack-chain",target:"_blank",rel:"noopener noreferrer"},E=e("p",null,[s("This option accepts a function that will receive a "),e("code",null,"Config"),s(" instance that provided by "),e("code",null,"webpack-chain"),s(" as the 1st argument an "),e("code",null,"isServer"),s(" flag as the 2nd argument and an "),e("code",null,"isBuild"),s(" flag as the 3rd argument.")],-1),O=e("h3",{id:"devserversetupmiddlewares",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#devserversetupmiddlewares","aria-hidden":"true"},"#"),s(" devServerSetupMiddlewares")],-1),A=e("li",null,[e("p",null,[s("Type: "),e("code",null,"(middlewares: Middleware[], devServer: Server) => Middleware[]")])],-1),T=e("li",null,[e("p",null,"Details:"),e("p",null,[s("A hook to be called in "),e("code",null,"devServer.setupMiddlewares"),s(" of webpack.")]),e("p",null,[s("The arguments of the function are those of "),e("code",null,"devServer.setupMiddlewares"),s(".")])],-1),B=e("p",null,"Also see:",-1),L={href:"https://webpack.js.org/configuration/dev-server/#devserversetupmiddlewares",target:"_blank",rel:"noopener noreferrer"},W=e("h3",{id:"vue",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#vue","aria-hidden":"true"},"#"),s(" vue")],-1),j=e("li",null,[e("p",null,[s("Type: "),e("code",null,"VueLoaderOptions")])],-1),F=e("li",null,[e("p",null,"Details:"),e("p",null,[s("Options for "),e("code",null,"vue-loader"),s(".")])],-1),M=e("p",null,"Also see:",-1),N={href:"https://vue-loader.vuejs.org/options.html",target:"_blank",rel:"noopener noreferrer"},V=e("h3",{id:"postcss",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#postcss","aria-hidden":"true"},"#"),s(" postcss")],-1),R=e("li",null,[e("p",null,[s("Type: "),e("code",null,"PostcssLoaderOptions")])],-1),U=e("li",null,[e("p",null,"Details:"),e("p",null,[s("Options for "),e("code",null,"postcss-loader"),s(".")])],-1),I=e("p",null,"Also see:",-1),q={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"},"#"),s(" stylus")],-1),z=e("li",null,[e("p",null,[s("Type: "),e("code",null,"StylusLoaderOptions")])],-1),H=e("li",null,[e("p",null,"Details:"),e("p",null,[s("Options for "),e("code",null,"stylus-loader"),s(".")])],-1),Q=e("p",null,"Also see:",-1),Y={href:"https://github.com/webpack-contrib/stylus-loader#options",target:"_blank",rel:"noopener noreferrer"},G=e("h3",{id:"scss",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#scss","aria-hidden":"true"},"#"),s(" scss")],-1),J=e("li",null,[e("p",null,[s("Type: "),e("code",null,"SassLoaderOptions")])],-1),K=e("li",null,[e("p",null,"Details:"),e("p",null,[s("Options for "),e("code",null,"sass-loader"),s(" for "),e("code",null,".scss"),s(" files.")])],-1),X=e("p",null,"Also see:",-1),Z={href:"https://github.com/webpack-contrib/sass-loader#options",target:"_blank",rel:"noopener noreferrer"},$=e("h3",{id:"sass",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sass","aria-hidden":"true"},"#"),s(" sass")],-1),ee=e("li",null,[e("p",null,[s("Type: "),e("code",null,"SassLoaderOptions")])],-1),se=e("li",null,[e("p",null,"Details:"),e("p",null,[s("Options for "),e("code",null,"sass-loader"),s(" for "),e("code",null,".sass"),s(" files.")])],-1),ne=e("p",null,"Also see:",-1),le={href:"https://github.com/webpack-contrib/sass-loader#options",target:"_blank",rel:"noopener noreferrer"},ae=e("h3",{id:"less",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#less","aria-hidden":"true"},"#"),s(" less")],-1),oe=e("li",null,[e("p",null,[s("Type: "),e("code",null,"LessLoaderOptions")])],-1),te=e("li",null,[e("p",null,"Details:"),e("p",null,[s("Options for "),e("code",null,"less-loader"),s(".")])],-1),re=e("p",null,"Also see:",-1),ie={href:"https://github.com/webpack-contrib/less-loader#options",target:"_blank",rel:"noopener noreferrer"},ce=o('
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),de=e("code",null,"base",-1),ue=e("h3",{id:"using-with-default-theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#using-with-default-theme","aria-hidden":"true"},"#"),s(" 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(ge,De){const t=a("NpmBadge"),l=a("ExternalLinkIcon"),r=a("RouterLink");return c(),p("div",null,[h,n(t,{package:"@vuepress/bundler-webpack"}),e("p",null,[s("Webpack bundler is provided by "),e("a",_,[s("@vuepress/bundler-webpack"),n(l)]),s(" package. It is a dependency of the "),e("a",b,[s("vuepress-webpack"),n(l)]),s(" package, and you can also install it separately.")]),f,e("ul",null,[g,e("li",null,[D,v,e("p",null,[s("This option accepts a function that will receive a webpack config object as the 1st argument, an "),k,s(" flag as the 2nd argument and an "),y,s(" flag as the 3rd argument. You can either mutate the config directly, or return an object to be merged by "),e("a",m,[s("webpack-merge"),n(l)]),s(".")])])]),w,e("ul",null,[C,e("li",null,[x,e("p",null,[s("Edit the internal webpack config with "),e("a",S,[s("webpack-chain"),n(l)]),s(".")]),E])]),O,e("ul",null,[A,T,e("li",null,[B,e("ul",null,[e("li",null,[e("a",L,[s("Webpack > Configuration > DevServer > devServer.setupMiddlewares"),n(l)])])])])]),W,e("ul",null,[j,F,e("li",null,[M,e("ul",null,[e("li",null,[e("a",N,[s("vue-loader > Options Reference"),n(l)])])])])]),V,e("ul",null,[R,U,e("li",null,[I,e("ul",null,[e("li",null,[e("a",q,[s("postcss-loader > Options"),n(l)])])])])]),P,e("ul",null,[z,H,e("li",null,[Q,e("ul",null,[e("li",null,[e("a",Y,[s("stylus-loader > Options"),n(l)])])])])]),G,e("ul",null,[J,K,e("li",null,[X,e("ul",null,[e("li",null,[e("a",Z,[s("sass-loader > Options"),n(l)])])])])]),$,e("ul",null,[ee,se,e("li",null,[ne,e("ul",null,[e("li",null,[e("a",le,[s("sass-loader > Options"),n(l)])])])])]),ae,e("ul",null,[oe,te,e("li",null,[re,e("ul",null,[e("li",null,[e("a",ie,[s("less-loader > Options"),n(l)])])])])]),ce,e("p",null,[s("Unlike Vite, Webpack won't handle "),pe,s(" for public files automatically. So if you change the "),de,s(" of your site, you'd better to use "),n(r,{to:"/guide/assets.html#base-helper"},{default:d(()=>[s("Base Helper")]),_:1}),s(" when referencing an public image file.")]),ue,e("p",null,[s("Default theme is using "),e("a",he,[s("SASS"),n(l)]),s(" as CSS pre-processor, so you might need to install "),e("a",_e,[s("sass-loader"),n(l)]),s(" as a peer dependency to make it work with Webpack, especially when you are using "),e("a",be,[s("pnpm"),n(l)]),s(".")])])}const ke=i(u,[["render",fe],["__file","webpack.html.vue"]]);export{ke as default};
diff --git a/browserconfig.xml b/browserconfig.xml
new file mode 100644
index 000000000..5bdd109f9
--- /dev/null
+++ b/browserconfig.xml
@@ -0,0 +1,9 @@
+
+
+
+
+
+ #ffffff
+
+
+
diff --git a/favicon.ico b/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..e481e5dda71327b885d4797cac93939d8030d0d6
GIT binary patch
literal 15086
zcmeI2eQZ@{9mk)p&@xv73ES+pKU&Nj`(tm3yDbc8dlLg#kyS!60xPsw=$J()2(q=%
z7I4!)=9Vqd$jpq6Z5S8ljJg)1>7of@jEQy$(Jb1SAc>OL1f~QT$ItiNb8gQ)J?A;+
z-WIq^xXHKA+wbN3yqu@!`JKm@3R7twddQI0o8zA}rok9fU+fPVnx#Y&*8zb;h7=gpX*+s%ffoqr}ysN=657puJaxcSs4LI*%O}X<8
z@`LjN@GIbWP<}yBrkwL|?E#lP?&^c`J>|^V=LXNa!D--+y`QSCtp5YS?tOI|v@*2rH
z`(9Y?;xKuuY|d8QwdeypD!>sdANUTu+2U+{ywQd7Df%Fr6<50t_{e}WR{p$u?iyU`
zZ2C;bh4M-Ap3ThFE61yaP0klFb8UrOu{;nkDW8gAA9$JKZ8Qf!7}{6
z{PktdrqeZWp7cmY_sAN)bH)3u>7dh7#pAQ{P~=!1M#
zPPY%(XafJT@_#4m?Cc9Yvp(l=$~uzlVRWoEb3U7R&9>)zV=4U6y%YS-
zYM-&+_u_JA^Xl~6{pVUb(oHc3;&5lNeL$xV#GeV_KKP>+XIp2?ei<5bpLafG9Z6R<
z68azxeZ}xc{sAx!;^!CsyN^u1$t#T4kF9+UJ828+X0GJax3m>3Gz>U-Epu(Y3yDj-b4azii27igzP%<4a}qkG5`L
zJrfT7q{Z3(#A5q?*_t`q`DjC}pMwPCu3=l4
zyI)qDWMcKPEgwldJg)BgB>yq+npKB&)BnA|nQ$s^w@-}k$d+}DvCo&?MuUv7|9Oz
zeYa`2qpe|>wKI(0D4bwihuA9|a{7vH9UD#;ppUkzia?pEV>KXGcEdOFrd0j+a-TI9~pUvN9|dvmqH3F6qWMHMY_9~iGql=PCK@V10K182U}Q8d*0X2{u3Z)EZUdJ*
zA93Taddb9|HA?Z1y?XE`Q0SNQL(KcUWa~@u71qIy&XCVU`R+f~>U^6ZN64&Ak&
z@C?SB7sNL?n_A+P(p_810HAjp_%)ca=5~LT?>V8fs_J6afo$AXEC+OY!G{I@>HC4#
zBjSsUfg3NRErNq=^cLeE`9;7d>e_455hrhG2c&QYf%~w$mzS(i(%hxeD7uA
zdu=iCJ^ZWfDP&^SqHHFf1(9h1=feKo_}q5;_Y61QhD=PnO*UI>V?evU3+bI|%9`8z
z4W74z_?p(FWF#B04rEidW54^*)(-SeHR+!<=iZr!ijTEs&TuY1Q}8S>4{p3G`fi16
zw?~Zu^>=~a7x?ygxbdyf^M=pM>^)x+lrP|btR-G0A9sa0PKX&EV#1};IO$h
z^KNHb!vaD10{@JGZS{2=%{m>hTV?wy0)$oSHE;-+oB4dwBFKFpy9-I%)x
z^7WwfNfl@LPT04eq5a>CzB9lYJ4VbczppE=x&r@<74a0;M$GdlpYr_}D14{V9{(2K
z{JSE)VX@wbS5CRlqPnQHC>ydB@jS?;j;z)2tQJ;@!Xll18%eG1|fb$hpOT{7ja
zwCdD`{HdUhY{-^u`u4q4KIMC^2R-{ajAUz=yPC&8{csJof|$!($G+dH4f(l29ogvV
zeWZr|PukDVqYH_@u;uH!?)PsDSVituWe$1QR5lep8Ls$QET8eO)7e!C!
zf?s-2SBmc(K$}db~138V^*8;k}4b>%%B{GY_S?LeG-Qq%d
zuWqr812Q**S$9-!I(#p1ilud?1-9ed=!qzX9$Y
z(4O7i{?7jlwpt!u-R&b}OHS;`s@AKGj?>VW>)7N}RN4l%QIn^ILUT~-A
zH2=dtA)tR+-?7}gM96qH&Uw18kiJLV81prToW8k@@xOPg-$&(Dr#8t**3}u#O1D;E
zd~5liP}{yDQ;Y1!*`KTO`s7uoHpxiV*Yjh!R}@nPmz#;95
+
+
+
+
+
+
+
+ Assets | VuePress
+
+
+
+
+
+
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:
VuePress has been using Webpackopen in new window as the bundler to dev and build sites. Since VuePress v2, other bundlers are also supported, and now we are using Viteopen in new window as the default bundler. Of course, you can still choose to use Webpack.
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 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:
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:
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>/".
Create .github/workflows/docs.yml to set up the workflow.
Click to expand sample config
name: docs
+
+on:
+# trigger deployment on every push to main branch
+push:
+branches: [main]
+# trigger deployment manually
+workflow_dispatch:
+
+jobs:
+docs:
+runs-on: ubuntu-latest
+
+steps:
+ - uses: actions/checkout@v4
+with:
+# fetch all commits to get last updated time or other git log info
+fetch-depth: 0
+
+ - name: Setup pnpm
+uses: pnpm/action-setup@v2
+with:
+# choose pnpm version to use
+version: 8
+# install deps with pnpm
+run_install: true
+
+ - name: Setup Node.js
+uses: actions/setup-node@v4
+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@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 }}
+
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>/".
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 changelogopen in new window carefully each time you upgrade a RC version.
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
pnpmdocs:dev
+
yarndocs:dev
+
npmrundocs:dev
+
VuePress will start a hot-reloading development server at http://localhost:8080open in new window. When you modify your markdown files, the content in the browser will be auto updated.
By now, you should have a basic but functional VuePress documentation site. Next, learn about the basics of configuration in VuePress.
Then, specify the locales option in your config file:
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:
VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in Markdownopen in new window, 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.
Routes are generated according to the relative path of your markdown files. Each Markdown file is compiled into HTML with markdown-itopen in new window 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 Nuxtopen in new window's nuxt generate command and other projects like Gatsbyopen in new window.
Nuxt is an outstanding Vue SSR framework, and it is capable of doing what VuePress does. But Nuxt is designed for building applications, while VuePress is more lightweight and focused on content-centric static sites.
VitePress is the little brother of VuePress. It's also created and maintained by our Vue.js team. It's even more lightweight and faster than VuePress. However, as a tradeoff, it's more opinionated and less configurable. For example, it does not support plugins. But VitePress is powerful enough to make your content online if you don't need advanced customizations.
It might not be an appropriate comparison, but you can take VuePress and VitePress as Laravel and Lumen.
Both are great projects and also Vue-powered. Except they are both fully runtime-driven and therefore not SEO-friendly. If you don’t care for SEO and don’t want to mess with installing dependencies, these are still great choices.
Hexo has been serving the Vue 2.x docs well. The biggest problem is that its theming system is static and string-based - we want to take advantage of Vue for both the layout and the interactivity. Also, Hexo’s Markdown rendering isn’t the most flexible to configure.
We’ve been using GitBook for most of our sub project docs. The primary problem with GitBook is that its development reload performance is intolerable with a large amount of files. The default theme also has a pretty limiting navigation structure, and the theming system is, again, not Vue based. The team behind GitBook is also more focused on turning it into a commercial product rather than an open-source tool.
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 option and extendsMarkdown option.
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.
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
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+```
+
+```ts:no-line-numbers
+// line-numbers is disabled
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+```
+
Output
// line-numbers is enabled by default
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+
// line-numbers is disabled
+constline2 = 'This is line 2'
+constline3 = 'This is line 3'
+
TIP
This line numbers extension is supported by our built-in plugin.
To avoid your code blocks being compiled by Vue, VuePress will add v-preopen in new window 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
+<!-- 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
+constonePlusTwoPlusThree = {{ 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
+
// This won't be compiled correctly because of js syntax highlighting
+constonePlusTwoPlusThree = {{ 1 + 2 + 3 }}
+
TIP
This v-pre extension is supported by our built-in plugin.
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:
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:
If you want to use those tags anyway, try either of the following workarounds:
Adding a v-preopen in new window directive to skip the compilation of the element and its children. Notice that the template syntax would also be invalid.
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.
Theme authors can use their own way to allow users to customize styles, and not be limited with stylus.
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 Default Theme > Styles.
Markdown image syntax does not support webpack aliases anymore. Links without ./ prefix are also treated as relative links, which is aligned with the behavior of the native markdown image syntax. If you want to use aliases in image paths, or use images from external packages, you should use <img> tag instead.
-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.
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.
Most of the v1 hooks have equivalents in v2. The only exception is extendsCli, which has been removed.
Webpack related hooks are removed, because VuePress Core has decoupled with webpack. You can try to use extendsBundlerOptions hook for similar purpose, and make sure to work with all bundlers.
Although we do not allow using other plugins in a plugin anymore, you can still use plugins in your theme.
Some major breaking changes:
There is no conventional theme directory structure anymore.
The file theme/enhanceApp.js will not be used as client app enhance file implicitly. You need to specify it explicitly in clientConfigFile hook.
Files in theme/global-components/ directory will not be registered as Vue components automatically. You need to use @vuepress/plugin-register-components, or register components manually in clientConfigFile.
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.
themeConfig is removed from user config and site data. To access the themeConfig as you would via this.$site.themeConfig in v1, we now recommend using the @vuepress/plugin-theme-data plugin and its useThemeData composition API.
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, @vuepress/plugin-palette may help.
Markdown code blocks syntax highlighting by Prism.js is not embedded by default. You can use either @vuepress/plugin-prismjs or @vuepress/plugin-shiki, or implement syntax highlighting in your own way.
For scalability concerns, this.$site.pages is not available any more.
Take the docs directory as your sourceDir, e.g. you are running vuepress dev docs command. Then the route paths of your markdown files would be:
Relative Path
Route Path
/README.md
/
/index.md
/
/contributing.md
/contributing.html
/guide/README.md
/guide/
/guide/getting-started.md
/guide/getting-started.html
TIP
By default, both README.md and index.md would be converted to index.html and generate a slash-ending route path. However, it might cause conflicts if you want to keep both of the two files.
In such case, you can set the pagePatterns to avoid one of them being processed by VuePress, e.g. use ['**/*.md', '!**/README.md', '!.vuepress', '!node_modules'] to exclude all README.md files.
Also, some symbols like : and + may have special meanings for vue-router, so you should avoid using them, see vue-router docsopen in new window for more details.
A markdown file could contain a YAMLopen in new window 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:
---
+lang: en-US
+title: Title of this page
+description: Description of this page
+---
+
You must have noticed that those fields are similar with the Site Config in the Config File. You can override lang, title, description, etc., of current page via frontmatter. So you can take frontmatter as page scope config.
Also, VuePress has built-in support for some frontmatter fields, and your theme may have its own special frontmatter, too.
TIP
Check out the Frontmatter Reference for a full list of VuePress built-in frontmatter.
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 <template> of Vue SFC.
With the power of markdown-itopen in new window and Vue template syntax, the basic Markdown can be extended a lot. Next, check out the Markdown guide for all the extensions of Markdown in VuePress.
Community users have created lots of plugins and published them to NPMopen in new window. VuePress team also maintains some official plugins under the @vuepressopen in new window scope. You should check the plugin's own documentation for detailed guide.
In general, you need to import the plugin and use it in your config file via the plugins option. For example, use the @vuepress/plugin-google-analytics to integrate Google Analytics:
Most plugins can only be used once. If the same plugin is used multiple times, only the last one will take effect.
However, some plugins can be used multiple times (e.g. @vuepress/plugin-container), and you should check the documentation of the plugin itself for detailed guide.
The default theme provides basic but useful features for documentation site, you can check out Default Theme Config Reference for a full list of config.
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.
Community users have created lots of theme and published them to NPMopen in new window. You should check the theme's own documentation for detailed guide.
If you want to use your own custom theme but don't want to publish it, you can create a local theme. Refer to Advanced > Writing a Theme for how to write your own theme.
VuePress
