KJZH001/nezhahq.github.io
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

deploy: 3326975422873f42a48e422e26e0b1d289ac183c

Browse Source
This commit is contained in:
naiba 2022-05-17 15:58:37 +00:00
parent 2634e0a57d
commit c65dcaa5f6
155 changed files with 1032 additions and 1601 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
assets/app.54944ef9.js
View File

File diff suppressed because one or more lines are too long

1
assets/app.61e847e1.js Normal file
View File

File diff suppressed because one or more lines are too long

13
assets/chunks/AlgoliaSearchBox.e5144af4.js
View File

File diff suppressed because one or more lines are too long

1
assets/chunks/ui-custom.1a068566.js
View File

@ -1 +0,0 @@
import{_ as o,g as t,h as r,i as l,o as _,c as d}from"../app.54944ef9.js";const p=t({props:{code:null,placement:null},setup(n){const{code:c,placement:s}=n,a=r();return l(()=>{const e=document.createElement("script");e.id="_carbonads_js",e.src=`//cdn.carbonads.com/carbon.js?serve=${c}&placement=${s}`,a.value.appendChild(e)}),(e,u)=>(_(),d("div",{class:"carbon-ads",ref_key:"el",ref:a},null,512))}});var i=o(p,[["__scopeId","data-v-5941b830"]]);export{i as default};

1
assets/chunks/ui-custom.30ce3a39.js
View File

@ -1 +0,0 @@
import{_ as n,g as d,i as l,o as p,c as _,p as i,j as r,b as u}from"../app.54944ef9.js";const m=s=>(i("data-v-4ce5ad17"),s=s(),r(),s),b={class:"buy-sell-ads"},f=m(()=>u("div",{class:"bsa-cpc"},null,-1)),y=[f],h=d({props:{code:null,placement:null},setup(s){const{code:a,placement:o}=s,t="bsa-cpc-script";l(()=>{if(document.getElementById(t))c();else{const e=document.createElement("script");e.id=t,e.src="//m.servedby-buysellads.com/monetization.js",document.head.appendChild(e),e.onload=()=>{c()}}});function c(){if(typeof _bsa!="undefined"&&_bsa){const e=document.querySelector(".bsa-cpc");e.innerHTML="",_bsa.init("default",a,`placement:${o}`,{target:".bsa-cpc",align:"horizontal",disable_css:"true"})}}return(e,v)=>(p(),_("div",b,y))}});var I=n(h,[["__scopeId","data-v-4ce5ad17"]]);export{I as default};

1
assets/config_algolia-search.md.da33e9e2.lean.js
View File

@ -1 +0,0 @@
import{_ as a,c as n,o as s,a as e}from"./app.54944ef9.js";const y='{"title":"Theme Config: Algolia Search","description":"","frontmatter":{},"headers":[{"level":2,"title":"Internationalization (i18n)","slug":"internationalization-i18n"}],"relativePath":"config/algolia-search.md","lastUpdated":1652768268000}',t={},p=e("",9),o=[p];function r(l,c,i,u,k,d){return s(),n("div",null,o)}var g=a(t,[["render",r]]);export{y as __pageData,g as default};

1
assets/config_basics.md.8b6d1758.lean.js
View File

@ -1 +0,0 @@
import{_ as e,c as a,o as s,a as t}from"./app.54944ef9.js";const f='{"title":"App Config: Basics","description":"","frontmatter":{},"headers":[{"level":2,"title":"base","slug":"base"},{"level":2,"title":"lang","slug":"lang"},{"level":2,"title":"title","slug":"title"},{"level":2,"title":"description","slug":"description"}],"relativePath":"config/basics.md","lastUpdated":1652768268000}',n={},o=t("",19),i=[o];function p(l,r,c,d,u,h){return s(),a("div",null,i)}var b=e(n,[["render",p]]);export{f as __pageData,b as default};

1
assets/config_carbon-ads.md.2699d04a.lean.js
View File

@ -1 +0,0 @@
import{_ as a,c as n,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"Theme Config: Carbon Ads","description":"","frontmatter":{},"headers":[],"relativePath":"config/carbon-ads.md","lastUpdated":1652768268000}',t={},o=e("",3),p=[o];function r(c,l,i,d,u,_){return s(),n("div",null,p)}var f=a(t,[["render",r]]);export{h as __pageData,f as default};

1
assets/config_homepage.md.2f01ca2d.lean.js
View File

@ -1 +0,0 @@
import{_ as n,c as a,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"Theme Config: Homepage","description":"","frontmatter":{},"headers":[],"relativePath":"config/homepage.md","lastUpdated":1652768268000}',t={},o=e("",3),p=[o];function c(u,i,l,r,k,d){return s(),a("div",null,p)}var g=n(t,[["render",c]]);export{h as __pageData,g as default};

2
assets/config_algolia-search.md.da33e9e2.js → assets/developer_algolia-search.md.9d2c511a.js
View File

@ -1,4 +1,4 @@
import{_ as a,c as n,o as s,a as e}from"./app.54944ef9.js";const y='{"title":"Theme Config: Algolia Search","description":"","frontmatter":{},"headers":[{"level":2,"title":"Internationalization (i18n)","slug":"internationalization-i18n"}],"relativePath":"config/algolia-search.md","lastUpdated":1652768268000}',t={},p=e(`<h1 id="theme-config-algolia-search" tabindex="-1">Theme Config: Algolia Search <a class="header-anchor" href="#theme-config-algolia-search" aria-hidden="true">#</a></h1><p>The <code>themeConfig.algolia</code> option allows you to use <a href="https://docsearch.algolia.com" target="_blank" rel="noopener noreferrer">Algolia DocSearch</a>. To enable it, you need to provide at least appId, apiKey and indexName:</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span> import{_ as a,c as n,o as s,a as e}from"./app.61e847e1.js";const y='{"title":"Theme Config: Algolia Search","description":"","frontmatter":{},"headers":[{"level":2,"title":"Internationalization (i18n)","slug":"internationalization-i18n"}],"relativePath":"developer/algolia-search.md"}',t={},p=e(`<h1 id="theme-config-algolia-search" tabindex="-1">Theme Config: Algolia Search <a class="header-anchor" href="#theme-config-algolia-search" aria-hidden="true">#</a></h1><p>The <code>themeConfig.algolia</code> option allows you to use <a href="https://docsearch.algolia.com" target="_blank" rel="noopener noreferrer">Algolia DocSearch</a>. To enable it, you need to provide at least appId, apiKey and indexName:</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">themeConfig</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">themeConfig</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">algolia</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">algolia</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">appId</span><span class="token operator">:</span> <span class="token string">&#39;your_app_id&#39;</span><span class="token punctuation">,</span> <span class="token literal-property property">appId</span><span class="token operator">:</span> <span class="token string">&#39;your_app_id&#39;</span><span class="token punctuation">,</span>

1
assets/developer_algolia-search.md.9d2c511a.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as n,o as s,a as e}from"./app.61e847e1.js";const y='{"title":"Theme Config: Algolia Search","description":"","frontmatter":{},"headers":[{"level":2,"title":"Internationalization (i18n)","slug":"internationalization-i18n"}],"relativePath":"developer/algolia-search.md"}',t={},p=e("",9),o=[p];function r(l,c,i,u,k,d){return s(),n("div",null,o)}var g=a(t,[["render",r]]);export{y as __pageData,g as default};

2
assets/config_basics.md.8b6d1758.js → assets/developer_basics.md.6e738cda.js
View File

@ -1,4 +1,4 @@
import{_ as e,c as a,o as s,a as t}from"./app.54944ef9.js";const f='{"title":"App Config: Basics","description":"","frontmatter":{},"headers":[{"level":2,"title":"base","slug":"base"},{"level":2,"title":"lang","slug":"lang"},{"level":2,"title":"title","slug":"title"},{"level":2,"title":"description","slug":"description"}],"relativePath":"config/basics.md","lastUpdated":1652768268000}',n={},o=t(`<h1 id="app-config-basics" tabindex="-1">App Config: Basics <a class="header-anchor" href="#app-config-basics" aria-hidden="true">#</a></h1><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>The config reference is incomplete since the config format may still receive further changes. For a complete reference of the current available options, refer to <a href="https://github.com/vuejs/vitepress/blob/45b65ce8b63bd54f345bfc3383eb2416b6769dc9/src/node/config.ts#L30-L65" target="_blank" rel="noopener noreferrer">config.ts</a>.</p></div><h2 id="base" tabindex="-1">base <a class="header-anchor" href="#base" aria-hidden="true">#</a></h2><ul><li>Type: <code>string</code></li><li>Default: <code>/</code></li></ul><p>The base URL the site will be deployed at. You will need to set this if you plan to deploy your site under a sub path, for example, GitHub pages. If you plan to deploy your site to <code>https://foo.github.io/bar/</code>, then you should set base to <code>&#39;/bar/&#39;</code>. It should always start and end with a slash.</p><p>The <code>base</code> is automatically prepended to all the URLs that start with <code>/</code> in other options, so you only need to specify it once.</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span> import{_ as e,c as a,o as s,a as t}from"./app.61e847e1.js";const f='{"title":"App Config: Basics","description":"","frontmatter":{},"headers":[{"level":2,"title":"base","slug":"base"},{"level":2,"title":"lang","slug":"lang"},{"level":2,"title":"title","slug":"title"},{"level":2,"title":"description","slug":"description"}],"relativePath":"developer/basics.md"}',n={},o=t(`<h1 id="app-config-basics" tabindex="-1">App Config: Basics <a class="header-anchor" href="#app-config-basics" aria-hidden="true">#</a></h1><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>The config reference is incomplete since the config format may still receive further changes. For a complete reference of the current available options, refer to <a href="https://github.com/vuejs/vitepress/blob/45b65ce8b63bd54f345bfc3383eb2416b6769dc9/src/node/config.ts#L30-L65" target="_blank" rel="noopener noreferrer">config.ts</a>.</p></div><h2 id="base" tabindex="-1">base <a class="header-anchor" href="#base" aria-hidden="true">#</a></h2><ul><li>Type: <code>string</code></li><li>Default: <code>/</code></li></ul><p>The base URL the site will be deployed at. You will need to set this if you plan to deploy your site under a sub path, for example, GitHub pages. If you plan to deploy your site to <code>https://foo.github.io/bar/</code>, then you should set base to <code>&#39;/bar/&#39;</code>. It should always start and end with a slash.</p><p>The <code>base</code> is automatically prepended to all the URLs that start with <code>/</code> in other options, so you only need to specify it once.</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">base</span><span class="token operator">:</span> <span class="token string">&#39;/base/&#39;</span> <span class="token literal-property property">base</span><span class="token operator">:</span> <span class="token string">&#39;/base/&#39;</span>
<span class="token punctuation">}</span> <span class="token punctuation">}</span>
</code></pre></div><h2 id="lang" tabindex="-1">lang <a class="header-anchor" href="#lang" aria-hidden="true">#</a></h2><ul><li>Type: <code>string</code></li><li>Default: <code>en-US</code></li></ul><p>The <code>lang</code> attribute for the site. This will render as a <code>&lt;html lang=&quot;en-US&quot;&gt;</code> tag in the page HTML.</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span> </code></pre></div><h2 id="lang" tabindex="-1">lang <a class="header-anchor" href="#lang" aria-hidden="true">#</a></h2><ul><li>Type: <code>string</code></li><li>Default: <code>en-US</code></li></ul><p>The <code>lang</code> attribute for the site. This will render as a <code>&lt;html lang=&quot;en-US&quot;&gt;</code> tag in the page HTML.</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>

1
assets/developer_basics.md.6e738cda.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as a,o as s,a as t}from"./app.61e847e1.js";const f='{"title":"App Config: Basics","description":"","frontmatter":{},"headers":[{"level":2,"title":"base","slug":"base"},{"level":2,"title":"lang","slug":"lang"},{"level":2,"title":"title","slug":"title"},{"level":2,"title":"description","slug":"description"}],"relativePath":"developer/basics.md"}',n={},o=t("",19),i=[o];function p(l,r,c,d,u,h){return s(),a("div",null,i)}var b=e(n,[["render",p]]);export{f as __pageData,b as default};

4
assets/config_carbon-ads.md.2699d04a.js → assets/developer_carbon-ads.md.6f2a5c7f.js
View File

@ -1,4 +1,4 @@
import{_ as a,c as n,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"Theme Config: Carbon Ads","description":"","frontmatter":{},"headers":[],"relativePath":"config/carbon-ads.md","lastUpdated":1652768268000}',t={},o=e(`<h1 id="theme-config-carbon-ads" tabindex="-1">Theme Config: Carbon Ads <a class="header-anchor" href="#theme-config-carbon-ads" aria-hidden="true">#</a></h1><p>VitePress has built in native support for <a href="https://www.carbonads.net" target="_blank" rel="noopener noreferrer">Carbon Ads</a>. By defining the Carbon Ads credentials in config, VitePress will display ads on the page.</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span> import{_ as n,c as a,o as s,a as e}from"./app.61e847e1.js";const h='{"title":"Theme Config: Carbon Ads","description":"","frontmatter":{},"headers":[],"relativePath":"developer/carbon-ads.md"}',t={},o=e(`<h1 id="theme-config-carbon-ads" tabindex="-1">Theme Config: Carbon Ads <a class="header-anchor" href="#theme-config-carbon-ads" aria-hidden="true">#</a></h1><p>VitePress has built in native support for <a href="https://www.carbonads.net" target="_blank" rel="noopener noreferrer">Carbon Ads</a>. By defining the Carbon Ads credentials in config, VitePress will display ads on the page.</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">themeConfig</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">themeConfig</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">carbonAds</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">carbonAds</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">carbon</span><span class="token operator">:</span> <span class="token string">&#39;your-carbon-key&#39;</span><span class="token punctuation">,</span> <span class="token literal-property property">carbon</span><span class="token operator">:</span> <span class="token string">&#39;your-carbon-key&#39;</span><span class="token punctuation">,</span>
@ -7,4 +7,4 @@ import{_ as a,c as n,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"Th
<span class="token punctuation">}</span> <span class="token punctuation">}</span>
<span class="token punctuation">}</span> <span class="token punctuation">}</span>
<span class="token punctuation">}</span> <span class="token punctuation">}</span>
</code></pre></div>`,3),p=[o];function r(c,l,i,d,u,_){return s(),n("div",null,p)}var f=a(t,[["render",r]]);export{h as __pageData,f as default}; </code></pre></div>`,3),p=[o];function r(c,l,i,d,u,_){return s(),a("div",null,p)}var f=n(t,[["render",r]]);export{h as __pageData,f as default};

1
assets/developer_carbon-ads.md.6f2a5c7f.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as n,c as a,o as s,a as e}from"./app.61e847e1.js";const h='{"title":"Theme Config: Carbon Ads","description":"","frontmatter":{},"headers":[],"relativePath":"developer/carbon-ads.md"}',t={},o=e("",3),p=[o];function r(c,l,i,d,u,_){return s(),a("div",null,p)}var f=n(t,[["render",r]]);export{h as __pageData,f as default};

4
assets/config_homepage.md.2f01ca2d.js → assets/developer_homepage.md.ce767e19.js
View File

@ -1,4 +1,4 @@
import{_ as n,c as a,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"Theme Config: Homepage","description":"","frontmatter":{},"headers":[],"relativePath":"config/homepage.md","lastUpdated":1652768268000}',t={},o=e(`<h1 id="theme-config-homepage" tabindex="-1">Theme Config: Homepage <a class="header-anchor" href="#theme-config-homepage" aria-hidden="true">#</a></h1><p>VitePress provides a homepage layout. To use it, specify <code>home: true</code> plus some other metadata in your root <code>index.md</code>&#39;s <a href="./../guide/frontmatter.html">YAML frontmatter</a>. This is an example of how it works:</p><div class="language-yaml"><pre><code><span class="token punctuation">---</span> import{_ as n,c as a,o as s,a as e}from"./app.61e847e1.js";const h='{"title":"Theme Config: Homepage","description":"","frontmatter":{},"headers":[],"relativePath":"developer/homepage.md"}',t={},o=e(`<h1 id="theme-config-homepage" tabindex="-1">Theme Config: Homepage <a class="header-anchor" href="#theme-config-homepage" aria-hidden="true">#</a></h1><p>VitePress provides a homepage layout. To use it, specify <code>home: true</code> plus some other metadata in your root <code>index.md</code>&#39;s YAML frontmatter. This is an example of how it works:</p><div class="language-yaml"><pre><code><span class="token punctuation">---</span>
<span class="token key atrule">home</span><span class="token punctuation">:</span> <span class="token boolean important">true</span> <span class="token key atrule">home</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
<span class="token key atrule">heroImage</span><span class="token punctuation">:</span> /logo.png <span class="token key atrule">heroImage</span><span class="token punctuation">:</span> /logo.png
<span class="token key atrule">heroAlt</span><span class="token punctuation">:</span> Logo image <span class="token key atrule">heroAlt</span><span class="token punctuation">:</span> Logo image
@ -15,4 +15,4 @@ import{_ as n,c as a,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"Th
<span class="token key atrule">details</span><span class="token punctuation">:</span> VitePress generates pre<span class="token punctuation">-</span>rendered static HTML for each page<span class="token punctuation">,</span> and runs as an SPA once a page is loaded. <span class="token key atrule">details</span><span class="token punctuation">:</span> VitePress generates pre<span class="token punctuation">-</span>rendered static HTML for each page<span class="token punctuation">,</span> and runs as an SPA once a page is loaded.
<span class="token key atrule">footer</span><span class="token punctuation">:</span> MIT Licensed <span class="token punctuation">|</span> Copyright \xA9 2019<span class="token punctuation">-</span>present Evan You <span class="token key atrule">footer</span><span class="token punctuation">:</span> MIT Licensed <span class="token punctuation">|</span> Copyright \xA9 2019<span class="token punctuation">-</span>present Evan You
<span class="token punctuation">---</span> <span class="token punctuation">---</span>
</code></pre></div>`,3),p=[o];function c(u,i,l,r,k,d){return s(),a("div",null,p)}var g=n(t,[["render",c]]);export{h as __pageData,g as default}; </code></pre></div>`,3),p=[o];function c(u,l,i,r,k,d){return s(),a("div",null,p)}var _=n(t,[["render",c]]);export{h as __pageData,_ as default};

1
assets/developer_homepage.md.ce767e19.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as n,c as a,o as s,a as e}from"./app.61e847e1.js";const h='{"title":"Theme Config: Homepage","description":"","frontmatter":{},"headers":[],"relativePath":"developer/homepage.md"}',t={},o=e("",3),p=[o];function c(u,l,i,r,k,d){return s(),a("div",null,p)}var _=n(t,[["render",c]]);export{h as __pageData,_ as default};

1
assets/en_US_developer_algolia-search.md.3a14c84d.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as o,o as t,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"Theme Config: Algolia Search","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/algolia-search.md"}',c={},s=e("h1",{id:"theme-config-algolia-search",tabindex:"-1"},[r("Theme Config: Algolia Search "),e("a",{class:"header-anchor",href:"#theme-config-algolia-search","aria-hidden":"true"},"#")],-1),i=[s];function n(l,h,d,_,f,g){return t(),o("div",null,i)}var u=a(c,[["render",n]]);export{m as __pageData,u as default};

1
assets/en_US_developer_algolia-search.md.3a14c84d.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as o,o as t,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"Theme Config: Algolia Search","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/algolia-search.md"}',c={},s=e("h1",{id:"theme-config-algolia-search",tabindex:"-1"},[r("Theme Config: Algolia Search "),e("a",{class:"header-anchor",href:"#theme-config-algolia-search","aria-hidden":"true"},"#")],-1),i=[s];function n(l,h,d,_,f,g){return t(),o("div",null,i)}var u=a(c,[["render",n]]);export{m as __pageData,u as default};

1
assets/en_US_developer_basics.md.b46eb68d.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as s,o as t,b as e,d as c}from"./app.61e847e1.js";const m='{"title":"App Config: Basics","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/basics.md"}',o={},r=e("h1",{id:"app-config-basics",tabindex:"-1"},[c("App Config: Basics "),e("a",{class:"header-anchor",href:"#app-config-basics","aria-hidden":"true"},"#")],-1),i=[r];function n(d,p,_,f,h,l){return t(),s("div",null,i)}var u=a(o,[["render",n]]);export{m as __pageData,u as default};

1
assets/en_US_developer_basics.md.b46eb68d.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as s,o as t,b as e,d as c}from"./app.61e847e1.js";const m='{"title":"App Config: Basics","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/basics.md"}',o={},r=e("h1",{id:"app-config-basics",tabindex:"-1"},[c("App Config: Basics "),e("a",{class:"header-anchor",href:"#app-config-basics","aria-hidden":"true"},"#")],-1),i=[r];function n(d,p,_,f,h,l){return t(),s("div",null,i)}var u=a(o,[["render",n]]);export{m as __pageData,u as default};

1
assets/en_US_developer_carbon-ads.md.c38e789e.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as o,o as t,b as e,d as r}from"./app.61e847e1.js";const b='{"title":"Theme Config: Carbon Ads","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/carbon-ads.md"}',n={},s=e("h1",{id:"theme-config-carbon-ads",tabindex:"-1"},[r("Theme Config: Carbon Ads "),e("a",{class:"header-anchor",href:"#theme-config-carbon-ads","aria-hidden":"true"},"#")],-1),c=[s];function d(i,_,h,f,p,l){return t(),o("div",null,c)}var u=a(n,[["render",d]]);export{b as __pageData,u as default};

1
assets/en_US_developer_carbon-ads.md.c38e789e.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as o,o as t,b as e,d as r}from"./app.61e847e1.js";const b='{"title":"Theme Config: Carbon Ads","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/carbon-ads.md"}',n={},s=e("h1",{id:"theme-config-carbon-ads",tabindex:"-1"},[r("Theme Config: Carbon Ads "),e("a",{class:"header-anchor",href:"#theme-config-carbon-ads","aria-hidden":"true"},"#")],-1),c=[s];function d(i,_,h,f,p,l){return t(),o("div",null,c)}var u=a(n,[["render",d]]);export{b as __pageData,u as default};

1
assets/en_US_developer_homepage.md.1539b68e.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as o,o as t,b as e,d as r}from"./app.61e847e1.js";const l='{"title":"Theme Config: Homepage","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/homepage.md"}',n={},s=e("h1",{id:"theme-config-homepage",tabindex:"-1"},[r("Theme Config: Homepage "),e("a",{class:"header-anchor",href:"#theme-config-homepage","aria-hidden":"true"},"#")],-1),c=[s];function d(i,h,p,m,_,f){return t(),o("div",null,c)}var u=a(n,[["render",d]]);export{l as __pageData,u as default};

1
assets/en_US_developer_homepage.md.1539b68e.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as a,c as o,o as t,b as e,d as r}from"./app.61e847e1.js";const l='{"title":"Theme Config: Homepage","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/developer/homepage.md"}',n={},s=e("h1",{id:"theme-config-homepage",tabindex:"-1"},[r("Theme Config: Homepage "),e("a",{class:"header-anchor",href:"#theme-config-homepage","aria-hidden":"true"},"#")],-1),c=[s];function d(i,h,p,m,_,f){return t(),o("div",null,c)}var u=a(n,[["render",d]]);export{l as __pageData,u as default};

24
assets/en_US_guide_agent.md.8a7cb7f6.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/en_US_guide_agent.md.8a7cb7f6.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as n,c as e,o as a,a as t}from"./app.61e847e1.js";const b='{"title":"Install Agent using one-click script","description":"","frontmatter":{},"headers":[{"level":2,"title":"Install Agent using one-click script","slug":"install-agent-using-one-click-script"},{"level":3,"title":"\u51C6\u5907\u5DE5\u4F5C","slug":"\u51C6\u5907\u5DE5\u4F5C"},{"level":3,"title":"Linux\u4E00\u952E\u5B89\u88C5","slug":"linux\u4E00\u952E\u5B89\u88C5"},{"level":3,"title":"Windows\u4E00\u952E\u5B89\u88C5","slug":"windows\u4E00\u952E\u5B89\u88C5"},{"level":2,"title":"\u5176\u4ED6\u65B9\u5F0F\u5B89\u88C5Agent","slug":"\u5176\u4ED6\u65B9\u5F0F\u5B89\u88C5agent"},{"level":3,"title":"Linux\u5B89\u88C5Agent","slug":"linux\u5B89\u88C5agent"},{"level":3,"title":"Windows\u5B89\u88C5Agent","slug":"windows\u5B89\u88C5agent"},{"level":3,"title":"OpenWRT\u5B89\u88C5Agent","slug":"openwrt\u5B89\u88C5agent"},{"level":2,"title":"\u81EA\u5B9A\u4E49Agent\u76D1\u63A7\u9879\u76EE","slug":"\u81EA\u5B9A\u4E49agent\u76D1\u63A7\u9879\u76EE"}],"relativePath":"en_US/guide/agent.md"}',s={},i=t("",38),l=[i];function o(r,c,p,d,h,u){return a(),e("div",null,l)}var k=n(s,[["render",o]]);export{b as __pageData,k as default};

24
assets/en_US_guide_dashboard.md.6fea9c12.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/en_US_guide_dashboard.md.6fea9c12.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as a,o as n,a as t}from"./app.61e847e1.js";const k='{"title":"Preparations","description":"","frontmatter":{},"headers":[{"level":3,"title":"Preparations","slug":"preparations"},{"level":3,"title":"\u83B7\u53D6Github\u7684Client ID\u548C\u5BC6\u94A5","slug":"\u83B7\u53D6github\u7684client-id\u548C\u5BC6\u94A5"},{"level":3,"title":"\u5728\u670D\u52A1\u5668\u4E2D\u5B89\u88C5Dashboard","slug":"\u5728\u670D\u52A1\u5668\u4E2D\u5B89\u88C5dashboard"},{"level":3,"title":"\u914D\u7F6E\u53CD\u5411\u4EE3\u7406","slug":"\u914D\u7F6E\u53CD\u5411\u4EE3\u7406"},{"level":3,"title":"\u5728\u5B9D\u5854\u9762\u677F\u4E2D\u914D\u7F6ESSL","slug":"\u5728\u5B9D\u5854\u9762\u677F\u4E2D\u914D\u7F6Essl"}],"relativePath":"en_US/guide/dashboard.md"}',s={},o=t("",32),r=[o];function p(l,c,i,d,h,u){return n(),a("div",null,r)}var m=e(s,[["render",p]]);export{k as __pageData,m as default};

1
assets/en_US_guide_notifications.md.5ae91a4b.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as e,o,b as a}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/notifications.md"}',n={},s=a("p",null,"notifications",-1),i=[s];function c(r,_,d,p,f,l){return o(),e("div",null,i)}var h=t(n,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_notifications.md.5ae91a4b.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as e,o,b as a}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/notifications.md"}',n={},s=a("p",null,"notifications",-1),i=[s];function c(r,_,d,p,f,l){return o(),e("div",null,i)}var h=t(n,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q1.md.fa5773ca.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q1.md"}',s={},r=o("p",null,"q1",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q1.md.fa5773ca.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q1.md"}',s={},r=o("p",null,"q1",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q2.md.f321ac98.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md"}',s={},r=o("p",null,"q2",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q2.md.f321ac98.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q2.md"}',s={},r=o("p",null,"q2",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q3.md.31314441.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md"}',s={},r=o("p",null,"q3",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q3.md.31314441.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q3.md"}',s={},r=o("p",null,"q3",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q4.md.9d306ec0.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md"}',s={},r=o("p",null,"q4",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q4.md.9d306ec0.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q4.md"}',s={},r=o("p",null,"q4",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q5.md.709d6485.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md"}',s={},r=o("p",null,"q5",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_q5.md.709d6485.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a,b as o}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/q5.md"}',s={},r=o("p",null,"q5",-1),n=[r];function c(_,d,i,p,l,f){return a(),t("div",null,n)}var h=e(s,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_servers.md.e153f6cc.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as r}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/servers.md"}',a={},o=r("p",null,"servers",-1),n=[o];function c(_,d,i,p,l,f){return s(),t("div",null,n)}var v=e(a,[["render",c]]);export{m as __pageData,v as default};

1
assets/en_US_guide_servers.md.e153f6cc.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as r}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/servers.md"}',a={},o=r("p",null,"servers",-1),n=[o];function c(_,d,i,p,l,f){return s(),t("div",null,n)}var v=e(a,[["render",c]]);export{m as __pageData,v as default};

1
assets/en_US_guide_services.md.48d769db.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as r}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/services.md"}',a={},o=r("p",null,"services",-1),c=[o];function n(_,i,d,p,l,f){return s(),t("div",null,c)}var v=e(a,[["render",n]]);export{m as __pageData,v as default};

1
assets/en_US_guide_services.md.48d769db.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as r}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/services.md"}',a={},o=r("p",null,"services",-1),c=[o];function n(_,i,d,p,l,f){return s(),t("div",null,c)}var v=e(a,[["render",n]]);export{m as __pageData,v as default};

1
assets/en_US_guide_settings.md.85014554.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as a}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/settings.md"}',n={},o=a("p",null,"settings",-1),r=[o];function c(_,i,d,p,l,f){return s(),t("div",null,r)}var g=e(n,[["render",c]]);export{m as __pageData,g as default};

1
assets/en_US_guide_settings.md.85014554.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as a}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/settings.md"}',n={},o=a("p",null,"settings",-1),r=[o];function c(_,i,d,p,l,f){return s(),t("div",null,r)}var g=e(n,[["render",c]]);export{m as __pageData,g as default};

1
assets/en_US_guide_tasks.md.b89a1dc0.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as a}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/tasks.md"}',o={},r=a("p",null,"tasks",-1),n=[r];function c(_,d,i,p,l,f){return s(),t("div",null,n)}var h=e(o,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_guide_tasks.md.b89a1dc0.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as s,b as a}from"./app.61e847e1.js";const m='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en_US/guide/tasks.md"}',o={},r=a("p",null,"tasks",-1),n=[r];function c(_,d,i,p,l,f){return s(),t("div",null,n)}var h=e(o,[["render",c]]);export{m as __pageData,h as default};

1
assets/en_US_index.md.9c539dde.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a}from"./app.61e847e1.js";const m='{"title":"Home","description":"","frontmatter":{"home":true,"heroImage":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","heroText":"Nezha Monitoring","tagline":"Self-hosted lightweight multi-server and website monitoring and alerting.","actionText":"Learn more \u2192","actionLink":"/en_US/guide/dashboard","features":[{"title":"\u7279\u60271","details":"\u7279\u60271\u7279\u60271\u7279\u60271"},{"title":"\u7279\u60272","details":"\u7279\u60272\u7279\u60272\u7279\u60272"},{"title":"\u7279\u60273","details":"\u7279\u60273\u7279\u60273\u7279\u60273"}],"footer":"Licence | Copyright \xA9 2022-present Nezhahq"},"headers":[],"relativePath":"en_US/index.md"}',r={};function i(n,o,s,c,d,h){return a(),t("div")}var p=e(r,[["render",i]]);export{m as __pageData,p as default};

1
assets/en_US_index.md.9c539dde.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a}from"./app.61e847e1.js";const m='{"title":"Home","description":"","frontmatter":{"home":true,"heroImage":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","heroText":"Nezha Monitoring","tagline":"Self-hosted lightweight multi-server and website monitoring and alerting.","actionText":"Learn more \u2192","actionLink":"/en_US/guide/dashboard","features":[{"title":"\u7279\u60271","details":"\u7279\u60271\u7279\u60271\u7279\u60271"},{"title":"\u7279\u60272","details":"\u7279\u60272\u7279\u60272\u7279\u60272"},{"title":"\u7279\u60273","details":"\u7279\u60273\u7279\u60273\u7279\u60273"}],"footer":"Licence | Copyright \xA9 2022-present Nezhahq"},"headers":[],"relativePath":"en_US/index.md"}',r={};function i(n,o,s,c,d,h){return a(),t("div")}var p=e(r,[["render",i]]);export{m as __pageData,p as default};

24
assets/guide_agent.md.4f40dc30.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/guide_agent.md.4f40dc30.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as n,o as a,a as t}from"./app.61e847e1.js";const b='{"title":"\u4E00\u952E\u5B89\u88C5Agent","description":"","frontmatter":{},"headers":[{"level":2,"title":"\u4E00\u952E\u5B89\u88C5Agent","slug":"\u4E00\u952E\u5B89\u88C5agent"},{"level":3,"title":"\u51C6\u5907\u5DE5\u4F5C","slug":"\u51C6\u5907\u5DE5\u4F5C"},{"level":3,"title":"Linux\u4E00\u952E\u5B89\u88C5","slug":"linux\u4E00\u952E\u5B89\u88C5"},{"level":3,"title":"Windows\u4E00\u952E\u5B89\u88C5","slug":"windows\u4E00\u952E\u5B89\u88C5"},{"level":2,"title":"\u5176\u4ED6\u65B9\u5F0F\u5B89\u88C5Agent","slug":"\u5176\u4ED6\u65B9\u5F0F\u5B89\u88C5agent"},{"level":3,"title":"Linux\u5B89\u88C5Agent","slug":"linux\u5B89\u88C5agent"},{"level":3,"title":"Windows\u5B89\u88C5Agent","slug":"windows\u5B89\u88C5agent"},{"level":3,"title":"OpenWRT\u5B89\u88C5Agent","slug":"openwrt\u5B89\u88C5agent"},{"level":2,"title":"\u81EA\u5B9A\u4E49Agent\u76D1\u63A7\u9879\u76EE","slug":"\u81EA\u5B9A\u4E49agent\u76D1\u63A7\u9879\u76EE"}],"relativePath":"guide/agent.md"}',s={},o=t("",39),i=[o];function l(r,c,p,d,h,u){return a(),n("div",null,i)}var m=e(s,[["render",l]]);export{b as __pageData,m as default};

35
assets/guide_api.md.03e88529.js
View File

@ -1,35 +0,0 @@
import{_ as a,c as n,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"API Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Helper Methods","slug":"helper-methods"},{"level":3,"title":"useData","slug":"usedata"},{"level":3,"title":"useRoute","slug":"useroute"},{"level":3,"title":"useRouter","slug":"userouter"},{"level":3,"title":"withBase","slug":"withbase"},{"level":2,"title":"Global Components","slug":"global-components"},{"level":3,"title":"<Content/>","slug":"content"},{"level":3,"title":"<ClientOnly/>","slug":"clientonly"}],"relativePath":"guide/api.md","lastUpdated":1652768268000}',t={},o=e(`<h1 id="api-reference" tabindex="-1">API Reference <a class="header-anchor" href="#api-reference" aria-hidden="true">#</a></h1><h2 id="helper-methods" tabindex="-1">Helper Methods <a class="header-anchor" href="#helper-methods" aria-hidden="true">#</a></h2><p>The following methods are globally importable from <code>vitepress</code> and are typically used in custom theme Vue components. However, they are also usable inside <code>.md</code> pages because markdown files are compiled into Vue single-file components.</p><p>Methods that start with <code>use*</code> indicates that it is a <a href="https://vuejs.org/guide/introduction.html#composition-api" target="_blank" rel="noopener noreferrer">Vue 3 Composition API</a> function that can only be used inside <code>setup()</code> or <code>&lt;script setup&gt;</code>.</p><h3 id="usedata" tabindex="-1"><code>useData</code> <a class="header-anchor" href="#usedata" aria-hidden="true">#</a></h3><p>Returns page-specific data. The returned object has the following type:</p><div class="language-ts"><pre><code><span class="token keyword">interface</span> <span class="token class-name">VitePressData</span> <span class="token punctuation">{</span>
site<span class="token operator">:</span> Ref<span class="token operator">&lt;</span>SiteData<span class="token operator">&gt;</span>
page<span class="token operator">:</span> Ref<span class="token operator">&lt;</span>PageData<span class="token operator">&gt;</span>
theme<span class="token operator">:</span> Ref<span class="token operator">&lt;</span><span class="token builtin">any</span><span class="token operator">&gt;</span> <span class="token comment">// themeConfig from .vitepress/config.js</span>
frontmatter<span class="token operator">:</span> Ref<span class="token operator">&lt;</span>PageData<span class="token punctuation">[</span><span class="token string">&#39;frontmatter&#39;</span><span class="token punctuation">]</span><span class="token operator">&gt;</span>
title<span class="token operator">:</span> Ref<span class="token operator">&lt;</span><span class="token builtin">string</span><span class="token operator">&gt;</span>
description<span class="token operator">:</span> Ref<span class="token operator">&lt;</span><span class="token builtin">string</span><span class="token operator">&gt;</span>
lang<span class="token operator">:</span> Ref<span class="token operator">&lt;</span><span class="token builtin">string</span><span class="token operator">&gt;</span>
localePath<span class="token operator">:</span> Ref<span class="token operator">&lt;</span><span class="token builtin">string</span><span class="token operator">&gt;</span>
<span class="token punctuation">}</span>
</code></pre></div><p><strong>Example:</strong></p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">setup</span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">import</span> <span class="token punctuation">{</span> useData <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&#39;vitepress&#39;</span>
<span class="token keyword">const</span> <span class="token punctuation">{</span> theme <span class="token punctuation">}</span> <span class="token operator">=</span> <span class="token function">useData</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>h1</span><span class="token punctuation">&gt;</span></span>{{ theme.heroText }}<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>h1</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><h3 id="useroute" tabindex="-1"><code>useRoute</code> <a class="header-anchor" href="#useroute" aria-hidden="true">#</a></h3><p>Returns the current route object with the following type:</p><div class="language-ts"><pre><code><span class="token keyword">interface</span> <span class="token class-name">Route</span> <span class="token punctuation">{</span>
path<span class="token operator">:</span> <span class="token builtin">string</span>
data<span class="token operator">:</span> PageData
component<span class="token operator">:</span> Component <span class="token operator">|</span> <span class="token keyword">null</span>
<span class="token punctuation">}</span>
</code></pre></div><h3 id="userouter" tabindex="-1"><code>useRouter</code> <a class="header-anchor" href="#userouter" aria-hidden="true">#</a></h3><p>Returns the VitePress router instance so you can programmatically navigate to another page.</p><div class="language-ts"><pre><code><span class="token keyword">interface</span> <span class="token class-name">Router</span> <span class="token punctuation">{</span>
route<span class="token operator">:</span> Route
<span class="token function-variable function">go</span><span class="token operator">:</span> <span class="token punctuation">(</span>href<span class="token operator">?</span><span class="token operator">:</span> <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token builtin">Promise</span><span class="token operator">&lt;</span><span class="token keyword">void</span><span class="token operator">&gt;</span>
<span class="token punctuation">}</span>
</code></pre></div><h3 id="withbase" tabindex="-1"><code>withBase</code> <a class="header-anchor" href="#withbase" aria-hidden="true">#</a></h3><ul><li><p><strong>Type</strong>: <code>(path: string) =&gt; string</code></p><p>Appends the configured <a href="./../config/basics.html#base"><code>base</code></a> to a given URL path. Also see <a href="./assets.html#base-url">Base URL</a>.</p></li></ul><h2 id="global-components" tabindex="-1">Global Components <a class="header-anchor" href="#global-components" aria-hidden="true">#</a></h2><p>VitePress comes with few built-in component that can be used globally. You may use these components in your markdown or your custom theme configuration.</p><h3 id="content" tabindex="-1"><code>&lt;Content/&gt;</code> <a class="header-anchor" href="#content" aria-hidden="true">#</a></h3><p>The <code>&lt;Content/&gt;</code> component displays the rendered markdown contents. Useful <a href="./theming.html">when creating your own theme</a>.</p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>h1</span><span class="token punctuation">&gt;</span></span>Custom Layout!<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>h1</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>Content</span> <span class="token punctuation">/&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><h3 id="clientonly" tabindex="-1"><code>&lt;ClientOnly/&gt;</code> <a class="header-anchor" href="#clientonly" aria-hidden="true">#</a></h3><p>The <code>&lt;ClientOnly/&gt;</code> component renders its slot only at client side.</p><p>Because VitePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the universal code requirements. In short, make sure to only access Browser / DOM APIs in beforeMount or mounted hooks.</p><p>If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the <code>ClientOnly</code> component.</p><div class="language-html"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>ClientOnly</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>NonSSRFriendlyComponent</span> <span class="token punctuation">/&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>ClientOnly</span><span class="token punctuation">&gt;</span></span>
</code></pre></div>`,27),p=[o];function c(l,r,i,u,d,k){return s(),n("div",null,p)}var m=a(t,[["render",c]]);export{h as __pageData,m as default};

1
assets/guide_api.md.03e88529.lean.js
View File

@ -1 +0,0 @@
import{_ as a,c as n,o as s,a as e}from"./app.54944ef9.js";const h='{"title":"API Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Helper Methods","slug":"helper-methods"},{"level":3,"title":"useData","slug":"usedata"},{"level":3,"title":"useRoute","slug":"useroute"},{"level":3,"title":"useRouter","slug":"userouter"},{"level":3,"title":"withBase","slug":"withbase"},{"level":2,"title":"Global Components","slug":"global-components"},{"level":3,"title":"<Content/>","slug":"content"},{"level":3,"title":"<ClientOnly/>","slug":"clientonly"}],"relativePath":"guide/api.md","lastUpdated":1652768268000}',t={},o=e("",27),p=[o];function c(l,r,i,u,d,k){return s(),n("div",null,p)}var m=a(t,[["render",c]]);export{h as __pageData,m as default};

13
assets/guide_assets.md.aae76804.js
View File

@ -1,13 +0,0 @@
import{_ as e,c as a,o as s,a as n}from"./app.54944ef9.js";const k='{"title":"Asset Handling","description":"","frontmatter":{},"headers":[{"level":2,"title":"Public Files","slug":"public-files"},{"level":2,"title":"Base URL","slug":"base-url"}],"relativePath":"guide/assets.md","lastUpdated":1652768268000}',t={},o=n(`<h1 id="asset-handling" tabindex="-1">Asset Handling <a class="header-anchor" href="#asset-handling" aria-hidden="true">#</a></h1><p>All Markdown files are compiled into Vue components and processed by <a href="https://github.com/vitejs/vite" target="_blank" rel="noopener noreferrer">Vite</a>. You can, <strong>and should</strong>, reference any assets using relative URLs:</p><div class="language-md"><pre><code><span class="token url"><span class="token operator">!</span>[<span class="token content">An image</span>](<span class="token url">./image.png</span>)</span>
</code></pre></div><p>You can reference static assets in your markdown files, your <code>*.vue</code> components in the theme, styles and plain <code>.css</code> files either using absolute public paths (based on project root) or relative paths (based on your file system). The latter is similar to the behavior you are used to if you have used <code>vue-cli</code> or webpack&#39;s <code>file-loader</code>.</p><p>Common image, media, and font filetypes are detected and included as assets automatically.</p><p>All referenced assets, including those using absolute paths, will be copied to the dist folder with a hashed file name in the production build. Never-referenced assets will not be copied. Similar to <code>vue-cli</code>, image assets smaller than 4kb will be base64 inlined.</p><p>All <strong>static</strong> path references, including absolute paths, should be based on your working directory structure.</p><h2 id="public-files" tabindex="-1">Public Files <a class="header-anchor" href="#public-files" aria-hidden="true">#</a></h2><p>Sometimes you may need to provide static assets that are not directly referenced in any of your Markdown or theme components (for example, favicons and PWA icons). The <code>public</code> directory under project root can be used as an escape hatch to provide static assets that either are never referenced in source code (e.g. <code>robots.txt</code>), or must retain the exact same file name (without hashing).</p><p>Assets placed in <code>public</code> will be copied to the root of the dist directory as-is.</p><p>Note that you should reference files placed in <code>public</code> using root absolute path - for example, <code>public/icon.png</code> should always be referenced in source code as <code>/icon.png</code>.</p><h2 id="base-url" tabindex="-1">Base URL <a class="header-anchor" href="#base-url" aria-hidden="true">#</a></h2><p>If your site is deployed to a non-root URL, you will need to set the <code>base</code> option in <code>.vitepress/config.js</code>. For example, if you plan to deploy your site to <code>https://foo.github.io/bar/</code>, then <code>base</code> should be set to <code>&#39;/bar/&#39;</code> (it should always start and end with a slash).</p><p>All your static asset paths are automatically processed to adjust for different <code>base</code> config values. For example, if you have an absolute reference to an asset under <code>public</code> in your markdown:</p><div class="language-md"><pre><code><span class="token url"><span class="token operator">!</span>[<span class="token content">An image</span>](<span class="token url">/image-inside-public.png</span>)</span>
</code></pre></div><p>You do <strong>not</strong> need to update it when you change the <code>base</code> config value in this case.</p><p>However, if you are authoring a theme component that links to assets dynamically, e.g. an image whose <code>src</code> is based on a theme config value:</p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>img</span> <span class="token attr-name">:src</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>theme.logoPath<span class="token punctuation">&quot;</span></span> <span class="token punctuation">/&gt;</span></span>
</code></pre></div><p>In this case it is recommended to wrap the path with the <a href="./api.html#withbase"><code>withBase</code> helper</a> provided by VitePress:</p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">setup</span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">import</span> <span class="token punctuation">{</span> withBase<span class="token punctuation">,</span> useData <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&#39;vitepress&#39;</span>
<span class="token keyword">const</span> <span class="token punctuation">{</span> theme <span class="token punctuation">}</span> <span class="token operator">=</span> <span class="token function">useData</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>img</span> <span class="token attr-name">:src</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>withBase(theme.logoPath)<span class="token punctuation">&quot;</span></span> <span class="token punctuation">/&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
</code></pre></div>`,20),p=[o];function c(i,l,r,d,u,h){return s(),a("div",null,p)}var m=e(t,[["render",c]]);export{k as __pageData,m as default};

1
assets/guide_assets.md.aae76804.lean.js
View File

@ -1 +0,0 @@
import{_ as e,c as a,o as s,a as n}from"./app.54944ef9.js";const k='{"title":"Asset Handling","description":"","frontmatter":{},"headers":[{"level":2,"title":"Public Files","slug":"public-files"},{"level":2,"title":"Base URL","slug":"base-url"}],"relativePath":"guide/assets.md","lastUpdated":1652768268000}',t={},o=n("",20),p=[o];function c(i,l,r,d,u,h){return s(),a("div",null,p)}var m=e(t,[["render",c]]);export{k as __pageData,m as default};

39
assets/guide_configuration.md.bb340dd8.js
View File

@ -1,39 +0,0 @@
import{_ as n,c as s,o as e,a}from"./app.54944ef9.js";const h='{"title":"Configuration","description":"","frontmatter":{},"headers":[{"level":2,"title":"Overview","slug":"overview"},{"level":2,"title":"Config Intellisense","slug":"config-intellisense"},{"level":2,"title":"Typed Theme Config","slug":"typed-theme-config"}],"relativePath":"guide/configuration.md","lastUpdated":1652768268000}',t={},o=a(`<h1 id="configuration" tabindex="-1">Configuration <a class="header-anchor" href="#configuration" aria-hidden="true">#</a></h1><h2 id="overview" tabindex="-1">Overview <a class="header-anchor" href="#overview" aria-hidden="true">#</a></h2><p>Without any configuration, the page is pretty minimal, and the user has no way to navigate around the site. To customize your site, let\u2019s first create a <code>.vitepress</code> directory inside your docs directory. This is where all VitePress-specific files will be placed. Your project structure is probably like this:</p><div class="language-bash"><pre><code><span class="token builtin class-name">.</span>
\u251C\u2500 docs
\u2502 \u251C\u2500 .vitepress
\u2502 \u2502 \u2514\u2500 config.js
\u2502 \u2514\u2500 index.md
\u2514\u2500 package.json
</code></pre></div><p>The essential file for configuring a VitePress site is <code>.vitepress/config.js</code>, which should export a JavaScript object:</p><div class="language-js"><pre><code><span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token literal-property property">title</span><span class="token operator">:</span> <span class="token string">&#39;Hello VitePress&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">description</span><span class="token operator">:</span> <span class="token string">&#39;Just playing around.&#39;</span>
<span class="token punctuation">}</span>
</code></pre></div><p>Check out the <a href="./../config/basics.html">Config Reference</a> for a full list of options.</p><h2 id="config-intellisense" tabindex="-1">Config Intellisense <a class="header-anchor" href="#config-intellisense" aria-hidden="true">#</a></h2><p>Since VitePress ships with TypeScript typings, you can leverage your IDE&#39;s intellisense with jsdoc type hints:</p><div class="language-js"><pre><code><span class="token comment">/**
* @type {import(&#39;vitepress&#39;).UserConfig}
*/</span>
<span class="token keyword">const</span> config <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token comment">// ...</span>
<span class="token punctuation">}</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> config
</code></pre></div><p>Alternatively, you can use the <code>defineConfig</code> helper at which should provide intellisense without the need for jsdoc annotations:</p><div class="language-js"><pre><code><span class="token keyword">import</span> <span class="token punctuation">{</span> defineConfig <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&#39;vitepress&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token function">defineConfig</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token comment">// ...</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre></div><p>VitePress also directly supports TS config files. You can use <code>.vitepress/config.ts</code> with the <code>defineConfig</code> helper as well.</p><h2 id="typed-theme-config" tabindex="-1">Typed Theme Config <a class="header-anchor" href="#typed-theme-config" aria-hidden="true">#</a></h2><p>By default, <code>defineConfig</code> helper leverages the theme config type from default theme:</p><div class="language-ts"><pre><code><span class="token keyword">import</span> <span class="token punctuation">{</span> defineConfig <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&#39;vitepress&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token function">defineConfig</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
themeConfig<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// Type is \`DefaultTheme.Config\`</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre></div><p>If you use a custom theme and want type checks for the theme config, you&#39;ll need to use <code>defineConfigWithTheme</code> instead, and pass the config type for your custom theme via a generic argument:</p><div class="language-ts"><pre><code><span class="token keyword">import</span> <span class="token punctuation">{</span> defineConfigWithTheme <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&#39;vitepress&#39;</span>
<span class="token keyword">import</span> <span class="token punctuation">{</span> ThemeConfig <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&#39;your-theme&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token generic-function"><span class="token function">defineConfigWithTheme</span><span class="token generic class-name"><span class="token operator">&lt;</span>ThemeConfig<span class="token operator">&gt;</span></span></span><span class="token punctuation">(</span><span class="token punctuation">{</span>
themeConfig<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// Type is \`ThemeConfig\`</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre></div>`,18),p=[o];function i(c,r,l,d,u,f){return e(),s("div",null,p)}var g=n(t,[["render",i]]);export{h as __pageData,g as default};

1
assets/guide_configuration.md.bb340dd8.lean.js
View File

@ -1 +0,0 @@
import{_ as n,c as s,o as e,a}from"./app.54944ef9.js";const h='{"title":"Configuration","description":"","frontmatter":{},"headers":[{"level":2,"title":"Overview","slug":"overview"},{"level":2,"title":"Config Intellisense","slug":"config-intellisense"},{"level":2,"title":"Typed Theme Config","slug":"typed-theme-config"}],"relativePath":"guide/configuration.md","lastUpdated":1652768268000}',t={},o=a("",18),p=[o];function i(c,r,l,d,u,f){return e(),s("div",null,p)}var g=n(t,[["render",i]]);export{h as __pageData,g as default};

24
assets/guide_dashboard.md.82ab28f6.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/guide_dashboard.md.82ab28f6.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as a,o as n,a as t}from"./app.61e847e1.js";const k='{"title":"\u51C6\u5907\u5DE5\u4F5C","description":"","frontmatter":{},"headers":[{"level":3,"title":"\u51C6\u5907\u5DE5\u4F5C","slug":"\u51C6\u5907\u5DE5\u4F5C"},{"level":3,"title":"\u83B7\u53D6Github\u7684Client ID\u548C\u5BC6\u94A5","slug":"\u83B7\u53D6github\u7684client-id\u548C\u5BC6\u94A5"},{"level":3,"title":"\u5728\u670D\u52A1\u5668\u4E2D\u5B89\u88C5Dashboard","slug":"\u5728\u670D\u52A1\u5668\u4E2D\u5B89\u88C5dashboard"},{"level":3,"title":"\u914D\u7F6E\u53CD\u5411\u4EE3\u7406","slug":"\u914D\u7F6E\u53CD\u5411\u4EE3\u7406"},{"level":3,"title":"\u5728\u5B9D\u5854\u9762\u677F\u4E2D\u914D\u7F6ESSL","slug":"\u5728\u5B9D\u5854\u9762\u677F\u4E2D\u914D\u7F6Essl"}],"relativePath":"guide/dashboard.md"}',s={},o=t("",32),r=[o];function p(l,c,i,d,h,u){return n(),a("div",null,r)}var m=e(s,[["render",p]]);export{k as __pageData,m as default};

101
assets/guide_deploy.md.661eacb4.js
View File

@ -1,101 +0,0 @@
import{_ as e,c as s,o as n,a}from"./app.54944ef9.js";var t="/assets/vercel-configuration.e8badd11.png";const b='{"title":"Deploying","description":"","frontmatter":{"sidebarDepth":3},"headers":[{"level":2,"title":"Building The Docs","slug":"building-the-docs"},{"level":3,"title":"Testing The Docs Locally","slug":"testing-the-docs-locally"},{"level":2,"title":"GitHub Pages","slug":"github-pages"},{"level":3,"title":"GitHub Pages and Travis CI","slug":"github-pages-and-travis-ci"},{"level":2,"title":"GitLab Pages and GitLab CI","slug":"gitlab-pages-and-gitlab-ci"},{"level":2,"title":"Netlify","slug":"netlify"},{"level":2,"title":"Google Firebase","slug":"google-firebase"},{"level":2,"title":"Surge","slug":"surge"},{"level":2,"title":"Heroku","slug":"heroku"},{"level":2,"title":"Vercel","slug":"vercel"}],"relativePath":"guide/deploy.md","lastUpdated":1652768268000}',o={},p=a(`<h1 id="deploying" tabindex="-1">Deploying <a class="header-anchor" href="#deploying" aria-hidden="true">#</a></h1><p>The following guides are based on some shared assumptions:</p><ul><li>You are placing your docs inside the <code>docs</code> directory of your project;</li><li>You are using the default build output location (<code>.vitepress/dist</code>);</li><li>VitePress is installed as a local dependency in your project, and you have setup the following npm scripts:</li></ul><div class="language-json"><pre><code><span class="token punctuation">{</span>
<span class="token property">&quot;scripts&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">&quot;docs:build&quot;</span><span class="token operator">:</span> <span class="token string">&quot;vitepress build docs&quot;</span><span class="token punctuation">,</span>
<span class="token property">&quot;docs:serve&quot;</span><span class="token operator">:</span> <span class="token string">&quot;vitepress serve docs&quot;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="building-the-docs" tabindex="-1">Building The Docs <a class="header-anchor" href="#building-the-docs" aria-hidden="true">#</a></h2><p>You may run <code>yarn docs:build</code> command to build the docs.</p><div class="language-bash"><pre><code>$ <span class="token function">yarn</span> docs:build
</code></pre></div><p>By default, the build output will be placed at <code>.vitepress/dist</code>. You may deploy this <code>dist</code> folder to any of your preferred platforms.</p><h3 id="testing-the-docs-locally" tabindex="-1">Testing The Docs Locally <a class="header-anchor" href="#testing-the-docs-locally" aria-hidden="true">#</a></h3><p>Once you&#39;ve built the docs, you may test them locally by running <code>yarn docs:serve</code> command.</p><div class="language-bash"><pre><code>$ <span class="token function">yarn</span> docs:build
$ <span class="token function">yarn</span> docs:serve
</code></pre></div><p>The <code>serve</code> command will boot up local static web server that serves the files from <code>.vitepress/dist</code> at <code>http://localhost:5000</code>. It&#39;s an easy way to check if the production build looks OK in your local environment.</p><p>You may configure the port of the server py passing <code>--port</code> flag as an argument.</p><div class="language-json"><pre><code><span class="token punctuation">{</span>
<span class="token property">&quot;scripts&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">&quot;docs:serve&quot;</span><span class="token operator">:</span> <span class="token string">&quot;vitepress serve docs --port 8080&quot;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p>Now the <code>docs:serve</code> method will launch the server at <code>http://localhost:8080</code>.</p><h2 id="github-pages" tabindex="-1">GitHub Pages <a class="header-anchor" href="#github-pages" aria-hidden="true">#</a></h2><ol><li><p>Set the correct <code>base</code> in <code>docs/.vitepress/config.js</code>.</p><p>If you are deploying to <code>https://&lt;USERNAME&gt;.github.io/</code>, you can omit <code>base</code> as it defaults to <code>&#39;/&#39;</code>.</p><p>If you are deploying to <code>https://&lt;USERNAME&gt;.github.io/&lt;REPO&gt;/</code>, for example your repository is at <code>https://github.com/&lt;USERNAME&gt;/&lt;REPO&gt;</code>, then set <code>base</code> to <code>&#39;/&lt;REPO&gt;/&#39;</code>.</p></li><li><p>Inside your project, create <code>deploy.sh</code> with the following content (with highlighted lines uncommented appropriately), and run it to deploy:</p></li></ol><div class="language-bash"><div class="highlight-lines"><br><br><br><br><br><br><br><br><br><br><br><br><div class="highlighted">\xA0</div><br><br><br><br><br><br><div class="highlighted">\xA0</div><br><br><div class="highlighted">\xA0</div><br><br><br></div><pre><code><span class="token shebang important">#!/usr/bin/env sh</span>
<span class="token comment"># abort on errors</span>
<span class="token builtin class-name">set</span> -e
<span class="token comment"># build</span>
<span class="token function">npm</span> run docs:build
<span class="token comment"># navigate into the build output directory</span>
<span class="token builtin class-name">cd</span> docs/.vitepress/dist
<span class="token comment"># if you are deploying to a custom domain</span>
<span class="token comment"># echo &#39;www.example.com&#39; &gt; CNAME</span>
<span class="token function">git</span> init
<span class="token function">git</span> <span class="token function">add</span> -A
<span class="token function">git</span> commit -m <span class="token string">&#39;deploy&#39;</span>
<span class="token comment"># if you are deploying to https://&lt;USERNAME&gt;.github.io</span>
<span class="token comment"># git push -f git@github.com:&lt;USERNAME&gt;/&lt;USERNAME&gt;.github.io.git main</span>
<span class="token comment"># if you are deploying to https://&lt;USERNAME&gt;.github.io/&lt;REPO&gt;</span>
<span class="token comment"># git push -f git@github.com:&lt;USERNAME&gt;/&lt;REPO&gt;.git main:gh-pages</span>
<span class="token builtin class-name">cd</span> -
</code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>You can also run the above script in your CI setup to enable automatic deployment on each push.</p></div><h3 id="github-pages-and-travis-ci" tabindex="-1">GitHub Pages and Travis CI <a class="header-anchor" href="#github-pages-and-travis-ci" aria-hidden="true">#</a></h3><ol><li><p>Set the correct <code>base</code> in <code>docs/.vitepress/config.js</code>.</p><p>If you are deploying to <code>https://&lt;USERNAME or GROUP&gt;.github.io/</code>, you can omit <code>base</code> as it defaults to <code>&#39;/&#39;</code>.</p><p>If you are deploying to <code>https://&lt;USERNAME or GROUP&gt;.github.io/&lt;REPO&gt;/</code>, for example your repository is at <code>https://github.com/&lt;USERNAME&gt;/&lt;REPO&gt;</code>, then set <code>base</code> to <code>&#39;/&lt;REPO&gt;/&#39;</code>.</p></li><li><p>Create a file named <code>.travis.yml</code> in the root of your project.</p></li><li><p>Run <code>yarn</code> or <code>npm install</code> locally and commit the generated lockfile (that is <code>yarn.lock</code> or <code>package-lock.json</code>).</p></li><li><p>Use the GitHub Pages deploy provider template, and follow the <a href="https://docs.travis-ci.com/user/deployment/pages" target="_blank" rel="noopener noreferrer">Travis CI documentation</a>.</p></li></ol><div class="language-yaml"><pre><code><span class="token key atrule">language</span><span class="token punctuation">:</span> node_js
<span class="token key atrule">node_js</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> lts/*
<span class="token key atrule">install</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> yarn install <span class="token comment"># npm ci</span>
<span class="token key atrule">script</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> yarn docs<span class="token punctuation">:</span>build <span class="token comment"># npm run docs:build</span>
<span class="token key atrule">deploy</span><span class="token punctuation">:</span>
<span class="token key atrule">provider</span><span class="token punctuation">:</span> pages
<span class="token key atrule">skip_cleanup</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
<span class="token key atrule">local_dir</span><span class="token punctuation">:</span> docs/.vitepress/dist
<span class="token comment"># A token generated on GitHub allowing Travis to push code on you repository.</span>
<span class="token comment"># Set in the Travis settings page of your repository, as a secure variable.</span>
<span class="token key atrule">github_token</span><span class="token punctuation">:</span> $GITHUB_TOKEN
<span class="token key atrule">keep_history</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
<span class="token key atrule">on</span><span class="token punctuation">:</span>
<span class="token key atrule">branch</span><span class="token punctuation">:</span> main
</code></pre></div><h2 id="gitlab-pages-and-gitlab-ci" tabindex="-1">GitLab Pages and GitLab CI <a class="header-anchor" href="#gitlab-pages-and-gitlab-ci" aria-hidden="true">#</a></h2><ol><li><p>Set the correct <code>base</code> in <code>docs/.vitepress/config.js</code>.</p><p>If you are deploying to <code>https://&lt;USERNAME or GROUP&gt;.gitlab.io/</code>, you can omit <code>base</code> as it defaults to <code>&#39;/&#39;</code>.</p><p>If you are deploying to <code>https://&lt;USERNAME or GROUP&gt;.gitlab.io/&lt;REPO&gt;/</code>, for example your repository is at <code>https://gitlab.com/&lt;USERNAME&gt;/&lt;REPO&gt;</code>, then set <code>base</code> to <code>&#39;/&lt;REPO&gt;/&#39;</code>.</p></li><li><p>Set <code>outDir</code> in <code>.vitepress/config.js</code> to <code>../public</code>.</p></li><li><p>Create a file called <code>.gitlab-ci.yml</code> in the root of your project with the content below. This will build and deploy your site whenever you make changes to your content:</p></li></ol><div class="language-yaml"><pre><code><span class="token key atrule">image</span><span class="token punctuation">:</span> node<span class="token punctuation">:</span>16.5.0
<span class="token key atrule">pages</span><span class="token punctuation">:</span>
<span class="token key atrule">stage</span><span class="token punctuation">:</span> deploy
<span class="token key atrule">cache</span><span class="token punctuation">:</span>
<span class="token key atrule">paths</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> node_modules/
<span class="token key atrule">script</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> yarn install <span class="token comment"># npm install</span>
<span class="token punctuation">-</span> yarn docs<span class="token punctuation">:</span>build <span class="token comment"># npm run docs:build</span>
<span class="token key atrule">artifacts</span><span class="token punctuation">:</span>
<span class="token key atrule">paths</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> public
<span class="token key atrule">rules</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> <span class="token key atrule">if</span><span class="token punctuation">:</span> $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
</code></pre></div><h2 id="netlify" tabindex="-1">Netlify <a class="header-anchor" href="#netlify" aria-hidden="true">#</a></h2><ol><li>On <a href="https://www.netlify.com/" target="_blank" rel="noopener noreferrer">Netlify</a>, setup up a new project from GitHub with the following settings:</li></ol><ul><li><strong>Build Command:</strong> <code>vitepress build docs</code> or <code>yarn docs:build</code> or <code>npm run docs:build</code></li><li><strong>Publish directory:</strong> <code>docs/.vitepress/dist</code></li></ul><ol start="2"><li>Hit the deploy button.</li></ol><h2 id="google-firebase" tabindex="-1">Google Firebase <a class="header-anchor" href="#google-firebase" aria-hidden="true">#</a></h2><ol><li><p>Make sure you have <a href="https://www.npmjs.com/package/firebase-tools" target="_blank" rel="noopener noreferrer">firebase-tools</a> installed.</p></li><li><p>Create <code>firebase.json</code> and <code>.firebaserc</code> at the root of your project with the following content:</p></li></ol><p><code>firebase.json</code>:</p><div class="language-json"><pre><code><span class="token punctuation">{</span>
<span class="token property">&quot;hosting&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">&quot;public&quot;</span><span class="token operator">:</span> <span class="token string">&quot;./docs/.vitepress/dist&quot;</span><span class="token punctuation">,</span>
<span class="token property">&quot;ignore&quot;</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p><code>.firebaserc</code>:</p><div class="language-js"><pre><code><span class="token punctuation">{</span>
<span class="token string-property property">&quot;projects&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token string-property property">&quot;default&quot;</span><span class="token operator">:</span> <span class="token string">&quot;&lt;YOUR_FIREBASE_ID&gt;&quot;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><ol start="3"><li>After running <code>yarn docs:build</code> or <code>npm run docs:build</code>, deploy using the command <code>firebase deploy</code>.</li></ol><h2 id="surge" tabindex="-1">Surge <a class="header-anchor" href="#surge" aria-hidden="true">#</a></h2><ol><li><p>First install <a href="https://www.npmjs.com/package/surge" target="_blank" rel="noopener noreferrer">surge</a>, if you haven\u2019t already.</p></li><li><p>Run <code>yarn docs:build</code> or <code>npm run docs:build</code>.</p></li><li><p>Deploy to surge by typing <code>surge docs/.vitepress/dist</code>.</p></li></ol><p>You can also deploy to a <a href="https://surge.sh/help/adding-a-custom-domain" target="_blank" rel="noopener noreferrer">custom domain</a> by adding <code>surge docs/.vitepress/dist yourdomain.com</code>.</p><h2 id="heroku" tabindex="-1">Heroku <a class="header-anchor" href="#heroku" aria-hidden="true">#</a></h2><ol><li><p>Install <a href="https://devcenter.heroku.com/articles/heroku-cli" target="_blank" rel="noopener noreferrer">Heroku CLI</a>.</p></li><li><p>Create a Heroku account by <a href="https://signup.heroku.com" target="_blank" rel="noopener noreferrer">signing up</a>.</p></li><li><p>Run <code>heroku login</code> and fill in your Heroku credentials:</p></li></ol><div class="language-bash"><pre><code>$ heroku login
</code></pre></div><ol start="4"><li>Create a file called <code>static.json</code> in the root of your project with the below content:</li></ol><p><code>static.json</code>:</p><div class="language-json"><pre><code><span class="token punctuation">{</span>
<span class="token property">&quot;root&quot;</span><span class="token operator">:</span> <span class="token string">&quot;./docs/.vitepress/dist&quot;</span>
<span class="token punctuation">}</span>
</code></pre></div><p>This is the configuration of your site; read more at <a href="https://github.com/heroku/heroku-buildpack-static" target="_blank" rel="noopener noreferrer">heroku-buildpack-static</a>.</p><ol start="5"><li>Set up your Heroku git remote:</li></ol><div class="language-bash"><pre><code><span class="token comment"># version change</span>
$ <span class="token function">git</span> init
$ <span class="token function">git</span> <span class="token function">add</span> <span class="token builtin class-name">.</span>
$ <span class="token function">git</span> commit -m <span class="token string">&quot;My site ready for deployment.&quot;</span>
<span class="token comment"># creates a new app with a specified name</span>
$ heroku apps:create example
<span class="token comment"># set buildpack for static sites</span>
$ heroku buildpacks:set https://github.com/heroku/heroku-buildpack-static.git
</code></pre></div><ol start="6"><li>Deploy your site:</li></ol><div class="language-bash"><pre><code><span class="token comment"># publish site</span>
$ <span class="token function">git</span> push heroku main
<span class="token comment"># opens a browser to view the Dashboard version of Heroku CI</span>
$ heroku <span class="token function">open</span>
</code></pre></div><h2 id="vercel" tabindex="-1">Vercel <a class="header-anchor" href="#vercel" aria-hidden="true">#</a></h2><p>To deploy your VitePress app with a <a href="https://vercel.com/docs/concepts/git" target="_blank" rel="noopener noreferrer">Vercel for Git</a>, make sure it has been pushed to a Git repository.</p><p>Go to <a href="https://vercel.com/new" target="_blank" rel="noopener noreferrer">https://vercel.com/new</a> and import the project into Vercel using your Git of choice (GitHub, GitLab or BitBucket). Follow the wizard to select the project root with the project&#39;s <code>package.json</code> and override the build step using <code>yarn docs:build</code> or <code>npm run docs:build</code> and the output dir to be <code>./docs/.vitepress/dist</code></p><p><img src="`+t+'" alt=""></p><p>After your project has been imported, all subsequent pushes to branches will generate Preview Deployments, and all changes made to the Production Branch (commonly &quot;main&quot;) will result in a Production Deployment.</p><p>Once deployed, you will get a URL to see your app live, such as the following: <a href="https://vitepress.vercel.app" target="_blank" rel="noopener noreferrer">https://vitepress.vercel.app</a></p>',56),c=[p];function l(i,r,d,u,h,g){return n(),s("div",null,c)}var y=e(o,[["render",l]]);export{b as __pageData,y as default};

1
assets/guide_deploy.md.661eacb4.lean.js
View File

@ -1 +0,0 @@
import{_ as e,c as s,o as n,a}from"./app.54944ef9.js";var t="/assets/vercel-configuration.e8badd11.png";const b='{"title":"Deploying","description":"","frontmatter":{"sidebarDepth":3},"headers":[{"level":2,"title":"Building The Docs","slug":"building-the-docs"},{"level":3,"title":"Testing The Docs Locally","slug":"testing-the-docs-locally"},{"level":2,"title":"GitHub Pages","slug":"github-pages"},{"level":3,"title":"GitHub Pages and Travis CI","slug":"github-pages-and-travis-ci"},{"level":2,"title":"GitLab Pages and GitLab CI","slug":"gitlab-pages-and-gitlab-ci"},{"level":2,"title":"Netlify","slug":"netlify"},{"level":2,"title":"Google Firebase","slug":"google-firebase"},{"level":2,"title":"Surge","slug":"surge"},{"level":2,"title":"Heroku","slug":"heroku"},{"level":2,"title":"Vercel","slug":"vercel"}],"relativePath":"guide/deploy.md","lastUpdated":1652768268000}',o={},p=a("",56),c=[p];function l(i,r,d,u,h,g){return n(),s("div",null,c)}var y=e(o,[["render",l]]);export{b as __pageData,y as default};

1
assets/guide_differences-from-vuepress.md.459a9c4a.js
View File

File diff suppressed because one or more lines are too long

1
assets/guide_differences-from-vuepress.md.459a9c4a.lean.js
View File

@ -1 +0,0 @@
import{_ as e,c as r,o as t,a}from"./app.54944ef9.js";const g='{"title":"Differences from VuePress","description":"","frontmatter":{"sidebarDepth":2},"headers":[{"level":2,"title":"General","slug":"general"},{"level":2,"title":"Markdown","slug":"markdown"},{"level":2,"title":"Site Config","slug":"site-config"},{"level":2,"title":"Default Theme Config","slug":"default-theme-config"},{"level":2,"title":"Default Theme","slug":"default-theme"},{"level":2,"title":"Computed Globals","slug":"computed-globals"},{"level":2,"title":"Frontmatter Predefined Variables","slug":"frontmatter-predefined-variables"},{"level":2,"title":"Frontmatter Default Theme Variables","slug":"frontmatter-default-theme-variables"},{"level":2,"title":"siteData","slug":"sitedata"},{"level":2,"title":"pageData","slug":"pagedata"},{"level":2,"title":"Global Components","slug":"global-components"}],"relativePath":"guide/differences-from-vuepress.md","lastUpdated":1652768268000}',o={},l=a("",27),s=[l];function i(n,d,c,u,h,p){return t(),r("div",null,s)}var m=e(o,[["render",i]]);export{g as __pageData,m as default};

28
assets/guide_frontmatter.md.07dc76f0.js
View File

@ -1,28 +0,0 @@
import{_ as e,c as a,o as n,a as t}from"./app.54944ef9.js";const f='{"title":"Frontmatter","description":"","frontmatter":{},"headers":[{"level":2,"title":"Alternative frontmatter Formats","slug":"alternative-frontmatter-formats"},{"level":2,"title":"Predefined Variables","slug":"predefined-variables"},{"level":3,"title":"title","slug":"title"},{"level":3,"title":"head","slug":"head"},{"level":3,"title":"navbar","slug":"navbar"},{"level":3,"title":"sidebar","slug":"sidebar"},{"level":3,"title":"editLink","slug":"editlink"}],"relativePath":"guide/frontmatter.md","lastUpdated":1652768268000}',s={},o=t(`<h1 id="frontmatter" tabindex="-1">Frontmatter <a class="header-anchor" href="#frontmatter" aria-hidden="true">#</a></h1><p>Any Markdown file that contains a YAML frontmatter block will be processed by <a href="https://github.com/jonschlinkert/gray-matter" target="_blank" rel="noopener noreferrer">gray-matter</a>. The frontmatter must be at the top of the Markdown file, and must take the form of valid YAML set between triple-dashed lines. Example:</p><div class="language-md"><pre><code><span class="token front-matter-block"><span class="token punctuation">---</span>
<span class="token front-matter yaml language-yaml"><span class="token key atrule">title</span><span class="token punctuation">:</span> Docs with VitePress
<span class="token key atrule">editLink</span><span class="token punctuation">:</span> <span class="token boolean important">true</span></span>
<span class="token punctuation">---</span></span>
</code></pre></div><p>Between the triple-dashed lines, you can set <a href="#predefined-variables">predefined variables</a>, or even create custom ones of your own. These variables can be used via the special <code>$frontmatter</code> variable.</p><p>Here\u2019s an example of how you could use it in your Markdown file:</p><div class="language-md"><pre><code><span class="token front-matter-block"><span class="token punctuation">---</span>
<span class="token front-matter yaml language-yaml"><span class="token key atrule">title</span><span class="token punctuation">:</span> Docs with VitePress
<span class="token key atrule">editLink</span><span class="token punctuation">:</span> <span class="token boolean important">true</span></span>
<span class="token punctuation">---</span></span>
<span class="token title important"><span class="token punctuation">#</span> {{ $frontmatter.title }}</span>
Guide content
</code></pre></div><h2 id="alternative-frontmatter-formats" tabindex="-1">Alternative frontmatter Formats <a class="header-anchor" href="#alternative-frontmatter-formats" aria-hidden="true">#</a></h2><p>VitePress also supports JSON frontmatter syntax, starting and ending in curly braces:</p><div class="language-json"><pre><code>---
<span class="token punctuation">{</span>
<span class="token property">&quot;title&quot;</span><span class="token operator">:</span> <span class="token string">&quot;Blogging Like a Hacker&quot;</span><span class="token punctuation">,</span>
<span class="token property">&quot;editLink&quot;</span><span class="token operator">:</span> <span class="token boolean">true</span>
<span class="token punctuation">}</span>
---
</code></pre></div><h2 id="predefined-variables" tabindex="-1">Predefined Variables <a class="header-anchor" href="#predefined-variables" aria-hidden="true">#</a></h2><h3 id="title" tabindex="-1">title <a class="header-anchor" href="#title" aria-hidden="true">#</a></h3><ul><li>Type: <code>string</code></li><li>Default: <code>h1_title || siteData.title</code></li></ul><p>Title of the current page.</p><h3 id="head" tabindex="-1">head <a class="header-anchor" href="#head" aria-hidden="true">#</a></h3><ul><li>Type: <code>array</code></li><li>Default: <code>undefined</code></li></ul><p>Specify extra head tags to be injected:</p><div class="language-yaml"><pre><code><span class="token punctuation">---</span>
<span class="token key atrule">head</span><span class="token punctuation">:</span>
<span class="token punctuation">-</span> <span class="token punctuation">-</span> meta
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> description
<span class="token key atrule">content</span><span class="token punctuation">:</span> hello
<span class="token punctuation">-</span> <span class="token punctuation">-</span> meta
<span class="token punctuation">-</span> <span class="token key atrule">name</span><span class="token punctuation">:</span> keywords
<span class="token key atrule">content</span><span class="token punctuation">:</span> super duper SEO
<span class="token punctuation">---</span>
</code></pre></div><h3 id="navbar" tabindex="-1">navbar <a class="header-anchor" href="#navbar" aria-hidden="true">#</a></h3><ul><li>Type: <code>boolean</code></li><li>Default: <code>undefined</code></li></ul><p>You can disable the navbar on a specific page with <code>navbar: false</code></p><h3 id="sidebar" tabindex="-1">sidebar <a class="header-anchor" href="#sidebar" aria-hidden="true">#</a></h3><ul><li>Type: <code>boolean|&#39;auto&#39;</code></li><li>Default: <code>undefined</code></li></ul><p>You can decide to show the sidebar on a specific page with <code>sidebar: auto</code> or disable it with <code>sidebar: false</code></p><h3 id="editlink" tabindex="-1">editLink <a class="header-anchor" href="#editlink" aria-hidden="true">#</a></h3><ul><li>Type: <code>boolean</code></li><li>Default: <code>undefined</code></li></ul><p>Define if this page should include an edit link.</p>`,26),i=[o];function l(r,p,c,d,u,h){return n(),a("div",null,i)}var m=e(s,[["render",l]]);export{f as __pageData,m as default};

1
assets/guide_frontmatter.md.07dc76f0.lean.js
View File

@ -1 +0,0 @@
import{_ as e,c as a,o as n,a as t}from"./app.54944ef9.js";const f='{"title":"Frontmatter","description":"","frontmatter":{},"headers":[{"level":2,"title":"Alternative frontmatter Formats","slug":"alternative-frontmatter-formats"},{"level":2,"title":"Predefined Variables","slug":"predefined-variables"},{"level":3,"title":"title","slug":"title"},{"level":3,"title":"head","slug":"head"},{"level":3,"title":"navbar","slug":"navbar"},{"level":3,"title":"sidebar","slug":"sidebar"},{"level":3,"title":"editLink","slug":"editlink"}],"relativePath":"guide/frontmatter.md","lastUpdated":1652768268000}',s={},o=t("",26),i=[o];function l(r,p,c,d,u,h){return n(),a("div",null,i)}var m=e(s,[["render",l]]);export{f as __pageData,m as default};

13
assets/guide_getting-started.md.f9753073.js
View File

@ -1,13 +0,0 @@
import{_ as s,c as e,o as t,a}from"./app.54944ef9.js";const h='{"title":"Getting Started","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started.md","lastUpdated":1652768268000}',n={},o=a(`<h1 id="getting-started" tabindex="-1">Getting Started <a class="header-anchor" href="#getting-started" aria-hidden="true">#</a></h1><p>This section will help you build a basic VitePress 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.</p><ul><li><p><strong>Step. 1:</strong> Create and change into a new directory.</p><div class="language-bash"><pre><code>$ <span class="token function">mkdir</span> vitepress-starter <span class="token operator">&amp;&amp;</span> <span class="token builtin class-name">cd</span> vitepress-starter
</code></pre></div></li><li><p><strong>Step. 2:</strong> Initialize with your preferred package manager.</p><div class="language-bash"><pre><code>$ <span class="token function">yarn</span> init
</code></pre></div></li><li><p><strong>Step. 3:</strong> Install VitePress locally.</p><div class="language-bash"><pre><code>$ <span class="token function">yarn</span> <span class="token function">add</span> --dev vitepress
</code></pre></div></li><li><p><strong>Step. 4:</strong> Create your first document.</p><div class="language-bash"><pre><code>$ <span class="token function">mkdir</span> docs <span class="token operator">&amp;&amp;</span> <span class="token builtin class-name">echo</span> <span class="token string">&#39;# Hello VitePress&#39;</span> <span class="token operator">&gt;</span> docs/index.md
</code></pre></div></li><li><p><strong>Step. 5:</strong> Add some scripts to <code>package.json</code>.</p><div class="language-json"><pre><code><span class="token punctuation">{</span>
<span class="token property">&quot;scripts&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">&quot;docs:dev&quot;</span><span class="token operator">:</span> <span class="token string">&quot;vitepress dev docs&quot;</span><span class="token punctuation">,</span>
<span class="token property">&quot;docs:build&quot;</span><span class="token operator">:</span> <span class="token string">&quot;vitepress build docs&quot;</span><span class="token punctuation">,</span>
<span class="token property">&quot;docs:serve&quot;</span><span class="token operator">:</span> <span class="token string">&quot;vitepress serve docs&quot;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div></li><li><p><strong>Step. 6:</strong> Serve the documentation site in the local server.</p><div class="language-bash"><pre><code>$ <span class="token function">yarn</span> docs:dev
</code></pre></div><p>VitePress will start a hot-reloading development server at <code>http://localhost:3000</code>.</p></li></ul><p>By now, you should have a basic but functional VitePress documentation site.</p><p>When your documentation site starts to take shape, be sure to read the <a href="./deploy.html">deployment guide</a>.</p>`,5),p=[o];function r(i,c,d,l,u,g){return t(),e("div",null,p)}var v=s(n,[["render",r]]);export{h as __pageData,v as default};

1
assets/guide_getting-started.md.f9753073.lean.js
View File

@ -1 +0,0 @@
import{_ as s,c as e,o as t,a}from"./app.54944ef9.js";const h='{"title":"Getting Started","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started.md","lastUpdated":1652768268000}',n={},o=a("",5),p=[o];function r(i,c,d,l,u,g){return t(),e("div",null,p)}var v=s(n,[["render",r]]);export{h as __pageData,v as default};

8
assets/guide_global-component.md.01405ea5.js
View File

@ -1,8 +0,0 @@
import{_ as n,c as t,o as e,a}from"./app.54944ef9.js";const k='{"title":"Global Component","description":"","frontmatter":{},"headers":[{"level":2,"title":"Content","slug":"content"},{"level":2,"title":"ClientOnly","slug":"clientonly"},{"level":2,"title":"OutboundLink","slug":"outboundlink"}],"relativePath":"guide/global-component.md","lastUpdated":1652768268000}',s={},o=a(`<h1 id="global-component" tabindex="-1">Global Component <a class="header-anchor" href="#global-component" aria-hidden="true">#</a></h1><p>VitePress comes with few built-in component that can be used globally. You may use these components in your markdown or your custom theme configuration.</p><h2 id="content" tabindex="-1">Content <a class="header-anchor" href="#content" aria-hidden="true">#</a></h2><p>The <code>Content</code> component displays the rendered markdown contents. Useful <a href="./theming.html">when creating your own theme</a>.</p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>h1</span><span class="token punctuation">&gt;</span></span>Custom Layout!<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>h1</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>Content</span> <span class="token punctuation">/&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><h2 id="clientonly" tabindex="-1">ClientOnly <a class="header-anchor" href="#clientonly" aria-hidden="true">#</a></h2><p>The <code>ClientOnly</code> component renderes its slot only at client side.</p><p>Because VitePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the universal code requirements. In short, make sure to only access Browser / DOM APIs in beforeMount or mounted hooks.</p><p>If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the <code>ClientOnly</code> component.</p><div class="language-html"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>ClientOnly</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>NonSSRFriendlyComponent</span> <span class="token punctuation">/&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>ClientOnly</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><h2 id="outboundlink" tabindex="-1">OutboundLink <a class="header-anchor" href="#outboundlink" aria-hidden="true">#</a></h2><p>The indicator <code>OutboundLink</code> is used to denote external links. In VitePress, this component has been followed by every external link.</p>`,12),l=[o];function p(c,i,r,u,d,h){return e(),t("div",null,l)}var m=n(s,[["render",p]]);export{k as __pageData,m as default};

1
assets/guide_global-component.md.01405ea5.lean.js
View File

@ -1 +0,0 @@
import{_ as n,c as t,o as e,a}from"./app.54944ef9.js";const k='{"title":"Global Component","description":"","frontmatter":{},"headers":[{"level":2,"title":"Content","slug":"content"},{"level":2,"title":"ClientOnly","slug":"clientonly"},{"level":2,"title":"OutboundLink","slug":"outboundlink"}],"relativePath":"guide/global-component.md","lastUpdated":1652768268000}',s={},o=a("",12),l=[o];function p(c,i,r,u,d,h){return e(),t("div",null,l)}var m=n(s,[["render",p]]);export{k as __pageData,m as default};

162
assets/guide_markdown.md.6ff83e9e.js
View File

@ -1,162 +0,0 @@
import{_ as a,c as e,o as t,a as o}from"./app.54944ef9.js";var n="/assets/line-numbers-mobile.f5ca96ee.gif",s="/assets/line-numbers-desktop.cc304762.png";const v='{"title":"Markdown Extensions","description":"","frontmatter":{"sidebarDepth":3},"headers":[{"level":2,"title":"Header Anchors","slug":"header-anchors"},{"level":2,"title":"Links","slug":"links"},{"level":3,"title":"Internal Links","slug":"internal-links"},{"level":3,"title":"Page Suffix","slug":"page-suffix"},{"level":3,"title":"External Links","slug":"external-links"},{"level":2,"title":"Frontmatter","slug":"frontmatter"},{"level":2,"title":"GitHub-Style Tables","slug":"github-style-tables"},{"level":2,"title":"Emoji \u{1F389}","slug":"emoji"},{"level":2,"title":"Table of Contents","slug":"table-of-contents"},{"level":2,"title":"Custom Containers","slug":"custom-containers"},{"level":3,"title":"Default Title","slug":"default-title"},{"level":3,"title":"Custom Title","slug":"custom-title"},{"level":2,"title":"Syntax Highlighting in Code Blocks","slug":"syntax-highlighting-in-code-blocks"},{"level":2,"title":"Line Highlighting in Code Blocks","slug":"line-highlighting-in-code-blocks"},{"level":2,"title":"Line Numbers","slug":"line-numbers"},{"level":2,"title":"Import Code Snippets","slug":"import-code-snippets"},{"level":2,"title":"Advanced Configuration","slug":"advanced-configuration"}],"relativePath":"guide/markdown.md","lastUpdated":1652768268000}',p={},i=n,l=s,r=o(`<h1 id="markdown-extensions" tabindex="-1">Markdown Extensions <a class="header-anchor" href="#markdown-extensions" aria-hidden="true">#</a></h1><h2 id="header-anchors" tabindex="-1">Header Anchors <a class="header-anchor" href="#header-anchors" aria-hidden="true">#</a></h2><p>Headers automatically get anchor links applied. Rendering of anchors can be configured using the <code>markdown.anchor</code> option.</p><h2 id="links" tabindex="-1">Links <a class="header-anchor" href="#links" aria-hidden="true">#</a></h2><h3 id="internal-links" tabindex="-1">Internal Links <a class="header-anchor" href="#internal-links" aria-hidden="true">#</a></h3><p>Internal links are converted to router link for SPA navigation. Also, every <code>index.md</code> contained in each sub-directory will automatically be converted to <code>index.html</code>, with corresponding URL <code>/</code>.</p><p>For example, given the following directory structure:</p><div class="language-"><pre><code>.
\u251C\u2500 index.md
\u251C\u2500 foo
\u2502 \u251C\u2500 index.md
\u2502 \u251C\u2500 one.md
\u2502 \u2514\u2500 two.md
\u2514\u2500 bar
\u251C\u2500 index.md
\u251C\u2500 three.md
\u2514\u2500 four.md
</code></pre></div><p>And providing you are in <code>foo/one.md</code>:</p><div class="language-md"><pre><code><span class="token url">[<span class="token content">Home</span>](<span class="token url">/</span>)</span> <span class="token comment">&lt;!-- sends the user to the root index.md --&gt;</span>
<span class="token url">[<span class="token content">foo</span>](<span class="token url">/foo/</span>)</span> <span class="token comment">&lt;!-- sends the user to index.html of directory foo --&gt;</span>
<span class="token url">[<span class="token content">foo heading</span>](<span class="token url">./#heading</span>)</span> <span class="token comment">&lt;!-- anchors user to a heading in the foo index file --&gt;</span>
<span class="token url">[<span class="token content">bar - three</span>](<span class="token url">../bar/three</span>)</span> <span class="token comment">&lt;!-- you can omit extention --&gt;</span>
<span class="token url">[<span class="token content">bar - three</span>](<span class="token url">../bar/three.md</span>)</span> <span class="token comment">&lt;!-- you can append .md --&gt;</span>
<span class="token url">[<span class="token content">bar - four</span>](<span class="token url">../bar/four.html</span>)</span> <span class="token comment">&lt;!-- or you can append .html --&gt;</span>
</code></pre></div><h3 id="page-suffix" tabindex="-1">Page Suffix <a class="header-anchor" href="#page-suffix" aria-hidden="true">#</a></h3><p>Pages and internal links get generated with the <code>.html</code> suffix by default.</p><h3 id="external-links" tabindex="-1">External Links <a class="header-anchor" href="#external-links" aria-hidden="true">#</a></h3><p>Outbound links automatically get <code>target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;</code>:</p><ul><li><a href="https://vuejs.org" target="_blank" rel="noopener noreferrer">vuejs.org</a></li><li><a href="https://github.com/vuejs/vitepress" target="_blank" rel="noopener noreferrer">VitePress on GitHub</a></li></ul><h2 id="frontmatter" tabindex="-1">Frontmatter <a class="header-anchor" href="#frontmatter" aria-hidden="true">#</a></h2><p><a href="https://jekyllrb.com/docs/front-matter/" target="_blank" rel="noopener noreferrer">YAML frontmatter</a> is supported out of the box:</p><div class="language-yaml"><pre><code><span class="token punctuation">---</span>
<span class="token key atrule">title</span><span class="token punctuation">:</span> Blogging Like a Hacker
<span class="token key atrule">lang</span><span class="token punctuation">:</span> en<span class="token punctuation">-</span>US
<span class="token punctuation">---</span>
</code></pre></div><p>This data will be available to the rest of the page, along with all custom and theming components.</p><p>For more details, see <a href="./frontmatter.html">Frontmatter</a>.</p><h2 id="github-style-tables" tabindex="-1">GitHub-Style Tables <a class="header-anchor" href="#github-style-tables" aria-hidden="true">#</a></h2><p><strong>Input</strong></p><div class="language-"><pre><code>| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
</code></pre></div><p><strong>Output</strong></p><table><thead><tr><th>Tables</th><th style="text-align:center;">Are</th><th style="text-align:right;">Cool</th></tr></thead><tbody><tr><td>col 3 is</td><td style="text-align:center;">right-aligned</td><td style="text-align:right;">$1600</td></tr><tr><td>col 2 is</td><td style="text-align:center;">centered</td><td style="text-align:right;">$12</td></tr><tr><td>zebra stripes</td><td style="text-align:center;">are neat</td><td style="text-align:right;">$1</td></tr></tbody></table><h2 id="emoji" tabindex="-1">Emoji \u{1F389} <a class="header-anchor" href="#emoji" aria-hidden="true">#</a></h2><p><strong>Input</strong></p><div class="language-"><pre><code>:tada: :100:
</code></pre></div><p><strong>Output</strong></p><p>\u{1F389} \u{1F4AF}</p><p>A <a href="https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.json" target="_blank" rel="noopener noreferrer">list of all emojis</a> is available.</p><h2 id="table-of-contents" tabindex="-1">Table of Contents <a class="header-anchor" href="#table-of-contents" aria-hidden="true">#</a></h2><p><strong>Input</strong></p><div class="language-"><pre><code>[[toc]]
</code></pre></div><p><strong>Output</strong></p><p><div class="table-of-contents"><ul><li><a href="#header-anchors">Header Anchors</a></li><li><a href="#links">Links</a><ul><li><a href="#internal-links">Internal Links</a></li><li><a href="#page-suffix">Page Suffix</a></li><li><a href="#external-links">External Links</a></li></ul></li><li><a href="#frontmatter">Frontmatter</a></li><li><a href="#github-style-tables">GitHub-Style Tables</a></li><li><a href="#emoji">Emoji</a></li><li><a href="#table-of-contents">Table of Contents</a></li><li><a href="#custom-containers">Custom Containers</a><ul><li><a href="#default-title">Default Title</a></li><li><a href="#custom-title">Custom Title</a></li></ul></li><li><a href="#syntax-highlighting-in-code-blocks">Syntax Highlighting in Code Blocks</a></li><li><a href="#line-highlighting-in-code-blocks">Line Highlighting in Code Blocks</a></li><li><a href="#line-numbers">Line Numbers</a></li><li><a href="#import-code-snippets">Import Code Snippets</a></li><li><a href="#advanced-configuration">Advanced Configuration</a></li></ul></div></p><p>Rendering of the TOC can be configured using the <code>markdown.toc</code> option.</p><h2 id="custom-containers" tabindex="-1">Custom Containers <a class="header-anchor" href="#custom-containers" aria-hidden="true">#</a></h2><p>Custom containers can be defined by their types, titles, and contents.</p><h3 id="default-title" tabindex="-1">Default Title <a class="header-anchor" href="#default-title" aria-hidden="true">#</a></h3><p><strong>Input</strong></p><div class="language-md"><pre><code>::: tip
This is a tip
:::
::: info
This is an info box
:::
::: warning
This is a warning
:::
::: danger
This is a dangerous warning
:::
::: details
This is a details block, which does not work in Internet Explorer or old versions of Edge.
:::
</code></pre></div><p><strong>Output</strong></p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>This is a tip</p></div><div class="info custom-block"><p class="custom-block-title">INFO</p><p>This is an info box</p></div><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>This is a warning</p></div><div class="danger custom-block"><p class="custom-block-title">WARNING</p><p>This is a dangerous warning</p></div><details class="details custom-block"><p>This is a details block, which does not work in Internet Explorer or Edge.</p></details><h3 id="custom-title" tabindex="-1">Custom Title <a class="header-anchor" href="#custom-title" aria-hidden="true">#</a></h3><p><strong>Input</strong></p><div class="language-md"><pre><code>::: danger STOP
Danger zone, do not proceed
:::
::: details Click me to view the code
<span class="token code"><span class="token punctuation">\`\`\`</span><span class="token code-language">js</span>
<span class="token code-block language-js">console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">&#39;Hello, VitePress!&#39;</span><span class="token punctuation">)</span></span>
<span class="token punctuation">\`\`\`</span></span>
:::
</code></pre></div><p><strong>Output</strong></p><div class="danger custom-block"><p class="custom-block-title">STOP</p><p>Danger zone, do not proceed</p></div><details class="details custom-block"><summary>Click me to view the code</summary><div class="language-js"><pre><code>console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">&#39;Hello, VitePress!&#39;</span><span class="token punctuation">)</span>
</code></pre></div></details><h2 id="syntax-highlighting-in-code-blocks" tabindex="-1">Syntax Highlighting in Code Blocks <a class="header-anchor" href="#syntax-highlighting-in-code-blocks" aria-hidden="true">#</a></h2><p>VitePress uses <a href="https://prismjs.com" target="_blank" rel="noopener noreferrer">Prism</a> to highlight language syntax in Markdown code blocks, using coloured text. Prism supports a wide variety of programming languages. All you need to do is append a valid language alias to the beginning backticks for the code block:</p><p><strong>Input</strong></p><div class="language-"><pre><code>\`\`\`js
export default {
name: &#39;MyComponent&#39;,
// ...
}
\`\`\`
</code></pre></div><p><strong>Output</strong></p><div class="language-js"><pre><code><span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token literal-property property">name</span><span class="token operator">:</span> <span class="token string">&#39;MyComponent&#39;</span>
<span class="token comment">// ...</span>
<span class="token punctuation">}</span>
</code></pre></div><p><strong>Input</strong></p><div class="language-"><pre><code>\`\`\`html
&lt;ul&gt;
&lt;li v-for=&quot;todo in todos&quot; :key=&quot;todo.id&quot;&gt;
{{ todo.text }}
&lt;/li&gt;
&lt;/ul&gt;
\`\`\`
</code></pre></div><p><strong>Output</strong></p><div class="language-html"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>ul</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>li</span> <span class="token attr-name">v-for</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>todo in todos<span class="token punctuation">&quot;</span></span> <span class="token attr-name">:key</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>todo.id<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span>{{ todo.text }}<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>li</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>ul</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p>A <a href="https://prismjs.com/#languages-list" target="_blank" rel="noopener noreferrer">list of valid languages</a> is available on Prism\u2019s site.</p><h2 id="line-highlighting-in-code-blocks" tabindex="-1">Line Highlighting in Code Blocks <a class="header-anchor" href="#line-highlighting-in-code-blocks" aria-hidden="true">#</a></h2><p><strong>Input</strong></p><div class="language-"><pre><code>\`\`\`js{4}
export default {
data () {
return {
msg: &#39;Highlighted!&#39;
}
}
}
\`\`\`
</code></pre></div><p><strong>Output</strong></p><div class="language-js"><div class="highlight-lines"><br><br><br><div class="highlighted">\xA0</div><br><br><br><br></div><pre><code><span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token function">data</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">return</span> <span class="token punctuation">{</span>
<span class="token literal-property property">msg</span><span class="token operator">:</span> <span class="token string">&#39;Highlighted!&#39;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p>In addition to a single line, you can also specify multiple single lines, ranges, or both:</p><ul><li>Line ranges: for example <code>{5-8}</code>, <code>{3-10}</code>, <code>{10-17}</code></li><li>Multiple single lines: for example <code>{4,7,9}</code></li><li>Line ranges and single lines: for example <code>{4,7-13,16,23-27,40}</code></li></ul><p><strong>Input</strong></p><div class="language-"><pre><code>\`\`\`js{1,4,6-7}
export default { // Highlighted
data () {
return {
msg: \`Highlighted!
This line isn&#39;t highlighted,
but this and the next 2 are.\`,
motd: &#39;VitePress is awesome&#39;,
lorem: &#39;ipsum&#39;,
}
}
}
\`\`\`
</code></pre></div><p><strong>Output</strong></p><div class="language-js"><div class="highlight-lines"><div class="highlighted">\xA0</div><br><br><div class="highlighted">\xA0</div><br><div class="highlighted">\xA0</div><div class="highlighted">\xA0</div><div class="highlighted">\xA0</div><br><br><br><br></div><pre><code><span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span> <span class="token comment">// Highlighted</span>
<span class="token function">data</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">return</span> <span class="token punctuation">{</span>
<span class="token literal-property property">msg</span><span class="token operator">:</span> <span class="token template-string"><span class="token template-punctuation string">\`</span><span class="token string">Highlighted!
This line isn&#39;t highlighted,
but this and the next 2 are.</span><span class="token template-punctuation string">\`</span></span><span class="token punctuation">,</span>
<span class="token literal-property property">motd</span><span class="token operator">:</span> <span class="token string">&#39;VitePress is awesome&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">lorem</span><span class="token operator">:</span> <span class="token string">&#39;ipsum&#39;</span><span class="token punctuation">,</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="line-numbers" tabindex="-1">Line Numbers <a class="header-anchor" href="#line-numbers" aria-hidden="true">#</a></h2><p>You can enable line numbers for each code blocks via config:</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">markdown</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">lineNumbers</span><span class="token operator">:</span> <span class="token boolean">true</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><ul><li>Demo:</li></ul><picture><source srcset="`+i+'" media="(max-width: 719px)"><img class="line-numbers-mobile-snap" src="'+n+'" alt="Image"></picture><picture><source srcset="'+l+'" media="(min-width: 720px)"><img class="line-numbers-desktop-snap" src="'+s+`" alt="Image"></picture><h2 id="import-code-snippets" tabindex="-1">Import Code Snippets <a class="header-anchor" href="#import-code-snippets" aria-hidden="true">#</a></h2><p>You can import code snippets from existing files via following syntax:</p><div class="language-md"><pre><code>&lt;&lt;&lt; @/filepath
</code></pre></div><p>It also supports <a href="#line-highlighting-in-code-blocks">line highlighting</a>:</p><div class="language-md"><pre><code>&lt;&lt;&lt; @/filepath{highlightLines}
</code></pre></div><p><strong>Input</strong></p><div class="language-md"><pre><code>&lt;&lt;&lt; @/snippets/snippet.js{2}
</code></pre></div><p><strong>Code file</strong></p><div class="language-js"><pre><code><span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// ..</span>
<span class="token punctuation">}</span>
</code></pre></div><p><strong>Output</strong></p><div class="language-js"><div class="highlight-lines"><br><div class="highlighted">\xA0</div><br><br></div><pre><code><span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// ..</span>
<span class="token punctuation">}</span>
</code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>The value of <code>@</code> corresponds to the source root. By default it&#39;s the VitePress project root, unless <code>srcDir</code> is configured.</p></div><p>You can also use a <a href="https://code.visualstudio.com/docs/editor/codebasics#_folding" target="_blank" rel="noopener noreferrer">VS Code region</a> to only include the corresponding part of the code file. You can provide a custom region name after a <code>#</code> following the filepath (<code>snippet</code> by default):</p><p><strong>Input</strong></p><div class="language-md"><pre><code>&lt;&lt;&lt; @/snippets/snippet-with-region.js{1}
</code></pre></div><p><strong>Code file</strong></p><div class="language-js"><pre><code><span class="token comment">// #region snippet</span>
<span class="token keyword">function</span> <span class="token function">foo</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// ..</span>
<span class="token punctuation">}</span>
<span class="token comment">// #endregion snippet</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> foo
</code></pre></div><p><strong>Output</strong></p><div class="language-js"><div class="highlight-lines"><div class="highlighted">\xA0</div><br><br></div><pre><code><span class="token keyword">function</span> <span class="token function">foo</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// ..</span>
<span class="token punctuation">}</span></code></pre></div><h2 id="advanced-configuration" tabindex="-1">Advanced Configuration <a class="header-anchor" href="#advanced-configuration" aria-hidden="true">#</a></h2><p>VitePress uses <a href="https://github.com/markdown-it/markdown-it" target="_blank" rel="noopener noreferrer">markdown-it</a> as the Markdown renderer. A lot of the extensions above are implemented via custom plugins. You can further customize the <code>markdown-it</code> instance using the <code>markdown</code> option in <code>.vitepress/config.js</code>:</p><div class="language-js"><pre><code><span class="token keyword">const</span> anchor <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">&#39;markdown-it-anchor&#39;</span><span class="token punctuation">)</span>
module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">markdown</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// options for markdown-it-anchor</span>
<span class="token comment">// https://github.com/valeriangalliat/markdown-it-anchor#permalinks</span>
<span class="token literal-property property">anchor</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">permalink</span><span class="token operator">:</span> anchor<span class="token punctuation">.</span>permalink<span class="token punctuation">.</span><span class="token function">headerLink</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token comment">// options for markdown-it-table-of-contents</span>
<span class="token literal-property property">toc</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">includeLevel</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token number">2</span><span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token function-variable function">config</span><span class="token operator">:</span> <span class="token punctuation">(</span><span class="token parameter">md</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
<span class="token comment">// use more markdown-it plugins!</span>
md<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span><span class="token function">require</span><span class="token punctuation">(</span><span class="token string">&#39;markdown-it-xxx&#39;</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div>`,104),c=[r];function d(u,g,h,k,m,f){return t(),e("div",null,c)}var y=a(p,[["render",d]]);export{v as __pageData,y as default};

1
assets/guide_markdown.md.6ff83e9e.lean.js
View File

@ -1 +0,0 @@
import{_ as a,c as e,o as t,a as o}from"./app.54944ef9.js";var n="/assets/line-numbers-mobile.f5ca96ee.gif",s="/assets/line-numbers-desktop.cc304762.png";const v='{"title":"Markdown Extensions","description":"","frontmatter":{"sidebarDepth":3},"headers":[{"level":2,"title":"Header Anchors","slug":"header-anchors"},{"level":2,"title":"Links","slug":"links"},{"level":3,"title":"Internal Links","slug":"internal-links"},{"level":3,"title":"Page Suffix","slug":"page-suffix"},{"level":3,"title":"External Links","slug":"external-links"},{"level":2,"title":"Frontmatter","slug":"frontmatter"},{"level":2,"title":"GitHub-Style Tables","slug":"github-style-tables"},{"level":2,"title":"Emoji \u{1F389}","slug":"emoji"},{"level":2,"title":"Table of Contents","slug":"table-of-contents"},{"level":2,"title":"Custom Containers","slug":"custom-containers"},{"level":3,"title":"Default Title","slug":"default-title"},{"level":3,"title":"Custom Title","slug":"custom-title"},{"level":2,"title":"Syntax Highlighting in Code Blocks","slug":"syntax-highlighting-in-code-blocks"},{"level":2,"title":"Line Highlighting in Code Blocks","slug":"line-highlighting-in-code-blocks"},{"level":2,"title":"Line Numbers","slug":"line-numbers"},{"level":2,"title":"Import Code Snippets","slug":"import-code-snippets"},{"level":2,"title":"Advanced Configuration","slug":"advanced-configuration"}],"relativePath":"guide/markdown.md","lastUpdated":1652768268000}',p={},i=n,l=s,r=o("",104),c=[r];function d(u,g,h,k,m,f){return t(),e("div",null,c)}var y=a(p,[["render",d]]);export{v as __pageData,y as default};

1
assets/guide_notifications.md.cda2998f.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"\u901A\u77E5","description":"","frontmatter":{},"headers":[],"relativePath":"guide/notifications.md"}',s={},n=e("h1",{id:"\u901A\u77E5",tabindex:"-1"},[r("\u901A\u77E5 "),e("a",{class:"header-anchor",href:"#\u901A\u77E5","aria-hidden":"true"},"#")],-1),c=[n];function i(d,_,f,h,p,l){return o(),a("div",null,c)}var x=t(s,[["render",i]]);export{m as __pageData,x as default};

1
assets/guide_notifications.md.cda2998f.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"\u901A\u77E5","description":"","frontmatter":{},"headers":[],"relativePath":"guide/notifications.md"}',s={},n=e("h1",{id:"\u901A\u77E5",tabindex:"-1"},[r("\u901A\u77E5 "),e("a",{class:"header-anchor",href:"#\u901A\u77E5","aria-hidden":"true"},"#")],-1),c=[n];function i(d,_,f,h,p,l){return o(),a("div",null,c)}var x=t(s,[["render",i]]);export{m as __pageData,x as default};

1
assets/guide_q1.md.9646973a.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98981","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md"}',s={},c=e("h1",{id:"\u95EE\u98981",tabindex:"-1"},[o("\u95EE\u98981 "),e("a",{class:"header-anchor",href:"#\u95EE\u98981","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q1.md.9646973a.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98981","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q1.md"}',s={},c=e("h1",{id:"\u95EE\u98981",tabindex:"-1"},[o("\u95EE\u98981 "),e("a",{class:"header-anchor",href:"#\u95EE\u98981","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q2.md.85a6bba5.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98982","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md"}',s={},c=e("h1",{id:"\u95EE\u98982",tabindex:"-1"},[o("\u95EE\u98982 "),e("a",{class:"header-anchor",href:"#\u95EE\u98982","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q2.md.85a6bba5.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98982","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q2.md"}',s={},c=e("h1",{id:"\u95EE\u98982",tabindex:"-1"},[o("\u95EE\u98982 "),e("a",{class:"header-anchor",href:"#\u95EE\u98982","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q3.md.923aa0b4.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98983","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md"}',s={},c=e("h1",{id:"\u95EE\u98983",tabindex:"-1"},[o("\u95EE\u98983 "),e("a",{class:"header-anchor",href:"#\u95EE\u98983","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q3.md.923aa0b4.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98983","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q3.md"}',s={},c=e("h1",{id:"\u95EE\u98983",tabindex:"-1"},[o("\u95EE\u98983 "),e("a",{class:"header-anchor",href:"#\u95EE\u98983","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q4.md.45e92b83.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98984","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q4.md"}',s={},c=e("h1",{id:"\u95EE\u98984",tabindex:"-1"},[o("\u95EE\u98984 "),e("a",{class:"header-anchor",href:"#\u95EE\u98984","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q4.md.45e92b83.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98984","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q4.md"}',s={},c=e("h1",{id:"\u95EE\u98984",tabindex:"-1"},[o("\u95EE\u98984 "),e("a",{class:"header-anchor",href:"#\u95EE\u98984","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q5.md.49c9a914.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98985","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q5.md"}',s={},c=e("h1",{id:"\u95EE\u98985",tabindex:"-1"},[o("\u95EE\u98985 "),e("a",{class:"header-anchor",href:"#\u95EE\u98985","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_q5.md.49c9a914.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as o}from"./app.61e847e1.js";const m='{"title":"\u95EE\u98985","description":"","frontmatter":{},"headers":[],"relativePath":"guide/q5.md"}',s={},c=e("h1",{id:"\u95EE\u98985",tabindex:"-1"},[o("\u95EE\u98985 "),e("a",{class:"header-anchor",href:"#\u95EE\u98985","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var x=t(s,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_servers.md.d6809f62.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as s}from"./app.61e847e1.js";const m='{"title":"\u670D\u52A1\u5668","description":"","frontmatter":{},"headers":[],"relativePath":"guide/servers.md"}',o={},c=e("h1",{id:"\u670D\u52A1\u5668",tabindex:"-1"},[s("\u670D\u52A1\u5668 "),e("a",{class:"header-anchor",href:"#\u670D\u52A1\u5668","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var v=t(o,[["render",n]]);export{m as __pageData,v as default};

1
assets/guide_servers.md.d6809f62.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as s}from"./app.61e847e1.js";const m='{"title":"\u670D\u52A1\u5668","description":"","frontmatter":{},"headers":[],"relativePath":"guide/servers.md"}',o={},c=e("h1",{id:"\u670D\u52A1\u5668",tabindex:"-1"},[s("\u670D\u52A1\u5668 "),e("a",{class:"header-anchor",href:"#\u670D\u52A1\u5668","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var v=t(o,[["render",n]]);export{m as __pageData,v as default};

1
assets/guide_services.md.765b29a2.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as s}from"./app.61e847e1.js";const m='{"title":"\u670D\u52A1","description":"","frontmatter":{},"headers":[],"relativePath":"guide/services.md"}',o={},c=e("h1",{id:"\u670D\u52A1",tabindex:"-1"},[s("\u670D\u52A1 "),e("a",{class:"header-anchor",href:"#\u670D\u52A1","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var v=t(o,[["render",n]]);export{m as __pageData,v as default};

1
assets/guide_services.md.765b29a2.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as r,b as e,d as s}from"./app.61e847e1.js";const m='{"title":"\u670D\u52A1","description":"","frontmatter":{},"headers":[],"relativePath":"guide/services.md"}',o={},c=e("h1",{id:"\u670D\u52A1",tabindex:"-1"},[s("\u670D\u52A1 "),e("a",{class:"header-anchor",href:"#\u670D\u52A1","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return r(),a("div",null,d)}var v=t(o,[["render",n]]);export{m as __pageData,v as default};

1
assets/guide_settings.md.10730c80.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as s,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"\u8BBE\u7F6E","description":"","frontmatter":{},"headers":[],"relativePath":"guide/settings.md"}',o={},n=e("h1",{id:"\u8BBE\u7F6E",tabindex:"-1"},[r("\u8BBE\u7F6E "),e("a",{class:"header-anchor",href:"#\u8BBE\u7F6E","aria-hidden":"true"},"#")],-1),c=[n];function d(i,_,h,p,l,f){return s(),a("div",null,c)}var x=t(o,[["render",d]]);export{m as __pageData,x as default};

1
assets/guide_settings.md.10730c80.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as s,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"\u8BBE\u7F6E","description":"","frontmatter":{},"headers":[],"relativePath":"guide/settings.md"}',o={},n=e("h1",{id:"\u8BBE\u7F6E",tabindex:"-1"},[r("\u8BBE\u7F6E "),e("a",{class:"header-anchor",href:"#\u8BBE\u7F6E","aria-hidden":"true"},"#")],-1),c=[n];function d(i,_,h,p,l,f){return s(),a("div",null,c)}var x=t(o,[["render",d]]);export{m as __pageData,x as default};

1
assets/guide_tasks.md.29cf7921.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as s,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"\u4EFB\u52A1","description":"","frontmatter":{},"headers":[],"relativePath":"guide/tasks.md"}',o={},c=e("h1",{id:"\u4EFB\u52A1",tabindex:"-1"},[r("\u4EFB\u52A1 "),e("a",{class:"header-anchor",href:"#\u4EFB\u52A1","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return s(),a("div",null,d)}var x=t(o,[["render",n]]);export{m as __pageData,x as default};

1
assets/guide_tasks.md.29cf7921.lean.js Normal file
View File

@ -0,0 +1 @@
import{_ as t,c as a,o as s,b as e,d as r}from"./app.61e847e1.js";const m='{"title":"\u4EFB\u52A1","description":"","frontmatter":{},"headers":[],"relativePath":"guide/tasks.md"}',o={},c=e("h1",{id:"\u4EFB\u52A1",tabindex:"-1"},[r("\u4EFB\u52A1 "),e("a",{class:"header-anchor",href:"#\u4EFB\u52A1","aria-hidden":"true"},"#")],-1),d=[c];function n(i,_,h,p,l,f){return s(),a("div",null,d)}var x=t(o,[["render",n]]);export{m as __pageData,x as default};

79
assets/guide_theming.md.b28ff51e.js
View File

@ -1,79 +0,0 @@
import{_ as n,c as s,o as a,a as e}from"./app.54944ef9.js";const h='{"title":"Theming","description":"","frontmatter":{},"headers":[{"level":2,"title":"Using a Custom Theme","slug":"using-a-custom-theme"},{"level":2,"title":"Extending the Default Theme","slug":"extending-the-default-theme"},{"level":3,"title":"Registering Global Components","slug":"registering-global-components"},{"level":3,"title":"Customizing CSS","slug":"customizing-css"},{"level":3,"title":"Layout Slots","slug":"layout-slots"}],"relativePath":"guide/theming.md","lastUpdated":1652768268000}',t={},o=e(`<h1 id="theming" tabindex="-1">Theming <a class="header-anchor" href="#theming" aria-hidden="true">#</a></h1><h2 id="using-a-custom-theme" tabindex="-1">Using a Custom Theme <a class="header-anchor" href="#using-a-custom-theme" aria-hidden="true">#</a></h2><p>You can enable a custom theme by adding the <code>.vitepress/theme/index.js</code> file (the &quot;theme entry file&quot;).</p><div class="language-bash"><pre><code><span class="token builtin class-name">.</span>
\u251C\u2500 docs
\u2502 \u251C\u2500 .vitepress
\u2502 \u2502 \u251C\u2500 theme
\u2502 \u2502 \u2502 \u2514\u2500 index.js
\u2502 \u2502 \u2514\u2500 config.js
\u2502 \u2514\u2500 index.md
\u2514\u2500 package.json
</code></pre></div><p>A VitePress custom theme is simply an object containing three properties and is defined as follows:</p><div class="language-ts"><pre><code><span class="token keyword">interface</span> <span class="token class-name">Theme</span> <span class="token punctuation">{</span>
Layout<span class="token operator">:</span> Component <span class="token comment">// Vue 3 component</span>
NotFound<span class="token operator">?</span><span class="token operator">:</span> Component
enhanceApp<span class="token operator">?</span><span class="token operator">:</span> <span class="token punctuation">(</span>ctx<span class="token operator">:</span> EnhanceAppContext<span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token keyword">void</span>
<span class="token punctuation">}</span>
<span class="token keyword">interface</span> <span class="token class-name">EnhanceAppContext</span> <span class="token punctuation">{</span>
app<span class="token operator">:</span> App <span class="token comment">// Vue 3 app instance</span>
router<span class="token operator">:</span> Router <span class="token comment">// VitePress router instance</span>
siteData<span class="token operator">:</span> Ref<span class="token operator">&lt;</span>SiteData<span class="token operator">&gt;</span>
<span class="token punctuation">}</span>
</code></pre></div><p>The theme entry file should export the theme as its default export:</p><div class="language-js"><pre><code><span class="token comment">// .vitepress/theme/index.js</span>
<span class="token keyword">import</span> Layout <span class="token keyword">from</span> <span class="token string">&#39;./Layout.vue&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
Layout<span class="token punctuation">,</span>
<span class="token function-variable function">NotFound</span><span class="token operator">:</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token string">&#39;custom 404&#39;</span><span class="token punctuation">,</span> <span class="token comment">// &lt;- this is a Vue 3 functional component</span>
<span class="token function">enhanceApp</span><span class="token punctuation">(</span><span class="token parameter"><span class="token punctuation">{</span> app<span class="token punctuation">,</span> router<span class="token punctuation">,</span> siteData <span class="token punctuation">}</span></span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// app is the Vue 3 app instance from \`createApp()\`. router is VitePress&#39;</span>
<span class="token comment">// custom router. \`siteData\` is a \`ref\` of current site-level metadata.</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p>...where the <code>Layout</code> component could look like this:</p><div class="language-vue"><pre><code><span class="token comment">&lt;!-- .vitepress/theme/Layout.vue --&gt;</span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>h1</span><span class="token punctuation">&gt;</span></span>Custom Layout!<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>h1</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>Content</span> <span class="token punctuation">/&gt;</span></span><span class="token comment">&lt;!-- this is where markdown content will be rendered --&gt;</span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p>The default export is the only contract for a custom theme. Inside your custom theme, it works just like a normal Vite + Vue 3 application. Do note the theme also needs to be <a href="./using-vue.html#browser-api-access-restrictions">SSR-compatible</a>.</p><p>To distribute a theme, simply export the object in your package entry. To consume an external theme, import and re-export it from the custom theme entry:</p><div class="language-js"><pre><code><span class="token comment">// .vitepress/theme/index.js</span>
<span class="token keyword">import</span> Theme <span class="token keyword">from</span> <span class="token string">&#39;awesome-vitepress-theme&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> Theme
</code></pre></div><h2 id="extending-the-default-theme" tabindex="-1">Extending the Default Theme <a class="header-anchor" href="#extending-the-default-theme" aria-hidden="true">#</a></h2><p>If you want to extend and customize the default theme, you can import it from <code>vitepress/theme</code> and augment it in a custom theme entry. Here are some examples of common customizations:</p><h3 id="registering-global-components" tabindex="-1">Registering Global Components <a class="header-anchor" href="#registering-global-components" aria-hidden="true">#</a></h3><div class="language-js"><pre><code><span class="token comment">// .vitepress/theme/index.js</span>
<span class="token keyword">import</span> DefaultTheme <span class="token keyword">from</span> <span class="token string">&#39;vitepress/theme&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token operator">...</span>DefaultTheme<span class="token punctuation">,</span>
<span class="token function">enhanceApp</span><span class="token punctuation">(</span><span class="token parameter"><span class="token punctuation">{</span> app <span class="token punctuation">}</span></span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// register global components</span>
app<span class="token punctuation">.</span><span class="token function">component</span><span class="token punctuation">(</span><span class="token string">&#39;MyGlobalComponent&#39;</span> <span class="token comment">/* ... */</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p>Since we are using Vite, you can also leverage Vite&#39;s <a href="https://vitejs.dev/guide/features.html#glob-import" target="_blank" rel="noopener noreferrer">glob import feature</a> to auto register a directory of components.</p><h3 id="customizing-css" tabindex="-1">Customizing CSS <a class="header-anchor" href="#customizing-css" aria-hidden="true">#</a></h3><p>The default theme CSS is customizable by overriding root level CSS variables:</p><div class="language-js"><pre><code><span class="token comment">// .vitepress/theme/index.js</span>
<span class="token keyword">import</span> DefaultTheme <span class="token keyword">from</span> <span class="token string">&#39;vitepress/theme&#39;</span>
<span class="token keyword">import</span> <span class="token string">&#39;./custom.css&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> DefaultTheme
</code></pre></div><div class="language-css"><pre><code><span class="token comment">/* .vitepress/theme/custom.css */</span>
<span class="token selector">:root</span> <span class="token punctuation">{</span>
<span class="token property">--c-brand</span><span class="token punctuation">:</span> #646cff<span class="token punctuation">;</span>
<span class="token property">--c-brand-light</span><span class="token punctuation">:</span> #747bff<span class="token punctuation">;</span>
<span class="token punctuation">}</span>
</code></pre></div><p>See <a href="https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css" target="_blank" rel="noopener noreferrer">default theme CSS variables</a> that can be overridden.</p><h3 id="layout-slots" tabindex="-1">Layout Slots <a class="header-anchor" href="#layout-slots" aria-hidden="true">#</a></h3><p>The default theme&#39;s <code>&lt;Layout/&gt;</code> component has a few slots that can be used to inject content at certain locations of the page. Here&#39;s an example of injecting a component into the top of the sidebar:</p><div class="language-js"><pre><code><span class="token comment">// .vitepress/theme/index.js</span>
<span class="token keyword">import</span> DefaultTheme <span class="token keyword">from</span> <span class="token string">&#39;vitepress/theme&#39;</span>
<span class="token keyword">import</span> MyLayout <span class="token keyword">from</span> <span class="token string">&#39;./MyLayout.vue&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token operator">...</span>DefaultTheme<span class="token punctuation">,</span>
<span class="token comment">// override the Layout with a wrapper component that injects the slots</span>
<span class="token literal-property property">Layout</span><span class="token operator">:</span> MyLayout
<span class="token punctuation">}</span>
</code></pre></div><div class="language-vue"><pre><code><span class="token comment">&lt;!--.vitepress/theme/MyLayout.vue--&gt;</span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">setup</span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">import</span> DefaultTheme <span class="token keyword">from</span> <span class="token string">&#39;vitepress/theme&#39;</span>
<span class="token keyword">const</span> <span class="token punctuation">{</span> Layout <span class="token punctuation">}</span> <span class="token operator">=</span> DefaultTheme
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>Layout</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span> <span class="token attr-name">#sidebar-top</span><span class="token punctuation">&gt;</span></span>My custom sidebar top content<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>Layout</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p>Full list of slots available in the default theme layout:</p><ul><li><code>navbar-search</code></li><li><code>sidebar-top</code></li><li><code>sidebar-bottom</code></li><li><code>page-top-ads</code></li><li><code>page-top</code></li><li><code>page-bottom</code></li><li><code>page-bottom-ads</code></li><li>Only when <code>home: true</code> is enabled via frontmatter: <ul><li><code>home-hero</code></li><li><code>home-features</code></li><li><code>home-footer</code></li></ul></li></ul>`,29),p=[o];function c(l,i,r,u,k,d){return a(),s("div",null,p)}var g=n(t,[["render",c]]);export{h as __pageData,g as default};

1
assets/guide_theming.md.b28ff51e.lean.js
View File

@ -1 +0,0 @@
import{_ as n,c as s,o as a,a as e}from"./app.54944ef9.js";const h='{"title":"Theming","description":"","frontmatter":{},"headers":[{"level":2,"title":"Using a Custom Theme","slug":"using-a-custom-theme"},{"level":2,"title":"Extending the Default Theme","slug":"extending-the-default-theme"},{"level":3,"title":"Registering Global Components","slug":"registering-global-components"},{"level":3,"title":"Customizing CSS","slug":"customizing-css"},{"level":3,"title":"Layout Slots","slug":"layout-slots"}],"relativePath":"guide/theming.md","lastUpdated":1652768268000}',t={},o=e("",29),p=[o];function c(l,i,r,u,k,d){return a(),s("div",null,p)}var g=n(t,[["render",c]]);export{h as __pageData,g as default};

84
assets/guide_using-vue.md.74e82a4f.js
View File

@ -1,84 +0,0 @@
import{_ as o,o as a,c as t,b as n,F as r,r as u,d,n as k,a as s,e as p,f as g,t as h}from"./app.54944ef9.js";const m={};function y(e,c){return a(),t("span",null,"\u26A1")}var f=o(m,[["render",y]]);const v="_example_t4bci_2";var _={example:v};const w={props:["slot-key"],components:{ComponentInHeader:f},mounted(){document.querySelector(`.${this.$style.example}`).textContent="This is rendered by inline script and styled by inline CSS"}},N='{"title":"Using Vue in Markdown","description":"","frontmatter":{"sidebarDepth":3},"headers":[{"level":2,"title":"Templating","slug":"templating"},{"level":3,"title":"Interpolation","slug":"interpolation"},{"level":3,"title":"Directives","slug":"directives"},{"level":3,"title":"Access to Site & Page Data","slug":"access-to-site-page-data"},{"level":2,"title":"Escaping","slug":"escaping"},{"level":2,"title":"Using Components","slug":"using-components"},{"level":3,"title":"Importing components in markdown","slug":"importing-components-in-markdown"},{"level":3,"title":"Registering global components in the theme","slug":"registering-global-components-in-the-theme"},{"level":3,"title":"Using Components In Headers","slug":"using-components-in-headers"},{"level":2,"title":"Using CSS Pre-processors","slug":"using-css-pre-processors"},{"level":2,"title":"Script & Style Hoisting","slug":"script-style-hoisting"},{"level":2,"title":"Built-In Components","slug":"built-in-components"},{"level":2,"title":"Browser API Access Restrictions","slug":"browser-api-access-restrictions"}],"relativePath":"guide/using-vue.md","lastUpdated":1652768268000}',b=s(`<h1 id="using-vue-in-markdown" tabindex="-1">Using Vue in Markdown <a class="header-anchor" href="#using-vue-in-markdown" aria-hidden="true">#</a></h1><p>In VitePress, each markdown file is compiled into HTML and then processed as a Vue Single-File Component. This means you can use any Vue features inside the markdown, including dynamic templating, using Vue components, or arbitrary in-page Vue component logic by adding a <code>&lt;script&gt;</code> tag.</p><p>It is also important to know that VitePress leverages Vue 3&#39;s compiler to automatically detect and optimize the purely static parts of the markdown. Static contents are optimized into single placeholder nodes and eliminated from the page&#39;s JavaScript payload. They are also skipped during client-side hydration. In short, you only pay for the dynamic parts on any given page.</p><h2 id="templating" tabindex="-1">Templating <a class="header-anchor" href="#templating" aria-hidden="true">#</a></h2><h3 id="interpolation" tabindex="-1">Interpolation <a class="header-anchor" href="#interpolation" aria-hidden="true">#</a></h3><p>Each Markdown file is first compiled into HTML and then passed on as a Vue component to the Vite process pipeline. This means you can use Vue-style interpolation in text:</p><p><strong>Input</strong></p><div class="language-md"><pre><code>{{ 1 + 1 }}
</code></pre></div><p><strong>Output</strong></p><div class="language-text"><pre><code>2</code></pre></div><h3 id="directives" tabindex="-1">Directives <a class="header-anchor" href="#directives" aria-hidden="true">#</a></h3><p>Directives also work:</p><p><strong>Input</strong></p><div class="language-md"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>span</span> <span class="token attr-name">v-for</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>i in 3<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span>{{ i }} <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>span</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p><strong>Output</strong></p>`,15),T={class:"language-text"},x=s(`<h3 id="access-to-site-page-data" tabindex="-1">Access to Site &amp; Page Data <a class="header-anchor" href="#access-to-site-page-data" aria-hidden="true">#</a></h3><p>You can use the <a href="./api.html#usedata"><code>useData</code> helper</a> in a <code>&lt;script&gt;</code> block and expose the data to the page.</p><p><strong>Input</strong></p><div class="language-md"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">setup</span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">import</span> <span class="token punctuation">{</span> useData <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&#39;vitepress&#39;</span>
<span class="token keyword">const</span> <span class="token punctuation">{</span> page <span class="token punctuation">}</span> <span class="token operator">=</span> <span class="token function">useData</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>pre</span><span class="token punctuation">&gt;</span></span>{{ page }}<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>pre</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p><strong>Output</strong></p><div class="language-json"><pre><code><span class="token punctuation">{</span>
<span class="token property">&quot;path&quot;</span><span class="token operator">:</span> <span class="token string">&quot;/using-vue.html&quot;</span><span class="token punctuation">,</span>
<span class="token property">&quot;title&quot;</span><span class="token operator">:</span> <span class="token string">&quot;Using Vue in Markdown&quot;</span><span class="token punctuation">,</span>
<span class="token property">&quot;frontmatter&quot;</span><span class="token operator">:</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="escaping" tabindex="-1">Escaping <a class="header-anchor" href="#escaping" aria-hidden="true">#</a></h2><p>By default, fenced code blocks are automatically wrapped with <code>v-pre</code>. To display raw mustaches or Vue-specific syntax inside inline code snippets or plain text, you need to wrap a paragraph with the <code>v-pre</code> custom container:</p><p><strong>Input</strong></p><div class="language-md"><pre><code>::: v-pre
<span class="token code-snippet code keyword">\`{{ This will be displayed as-is }}\`</span>
:::
</code></pre></div><p><strong>Output</strong></p><div><p><code>{{ This will be displayed as-is }}</code></p></div><h2 id="using-components" tabindex="-1">Using Components <a class="header-anchor" href="#using-components" aria-hidden="true">#</a></h2><p>When you need to have more flexibility, VitePress allows you to extend your authoring toolbox with your own Vue Components.</p><h3 id="importing-components-in-markdown" tabindex="-1">Importing components in markdown <a class="header-anchor" href="#importing-components-in-markdown" aria-hidden="true">#</a></h3><p>If your components are going to be used in only a few places, the recommended way to use them is to importing the components in the file where it is used.</p><div class="language-md"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">setup</span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">import</span> CustomComponent <span class="token keyword">from</span> <span class="token string">&#39;../components/CustomComponent.vue&#39;</span>
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token title important"><span class="token punctuation">#</span> Docs</span>
This is a .md using a custom component
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>CustomComponent</span> <span class="token punctuation">/&gt;</span></span>
<span class="token title important"><span class="token punctuation">##</span> More docs</span>
...
</code></pre></div><h3 id="registering-global-components-in-the-theme" tabindex="-1">Registering global components in the theme <a class="header-anchor" href="#registering-global-components-in-the-theme" aria-hidden="true">#</a></h3><p>If the components are going to be used across several pages in the docs, they can be registered globally in the theme (or as part of extending the default VitePress theme). Check out the <a href="./theming.html">Theming Guide</a> for more information.</p><p>In <code>.vitepress/theme/index.js</code>, the <code>enhanceApp</code> function receives the Vue <code>app</code> instance so you can <a href="https://vuejs.org/guide/components/registration.html" target="_blank" rel="noopener noreferrer">register components</a> as you would do in a regular Vue application.</p><div class="language-js"><pre><code><span class="token keyword">import</span> DefaultTheme <span class="token keyword">from</span> <span class="token string">&#39;vitepress/theme&#39;</span>
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token operator">...</span>DefaultTheme<span class="token punctuation">,</span>
<span class="token function">enhanceApp</span><span class="token punctuation">(</span><span class="token parameter"><span class="token punctuation">{</span> app <span class="token punctuation">}</span></span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
app<span class="token punctuation">.</span><span class="token function">component</span><span class="token punctuation">(</span><span class="token string">&#39;VueClickAwayExample&#39;</span><span class="token punctuation">,</span> VueClickAwayExample<span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p>Later in your markdown files, the component can be interleaved between the content</p><div class="language-md"><pre><code><span class="token title important"><span class="token punctuation">#</span> Vue Click Away</span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>VueClickAwayExample</span> <span class="token punctuation">/&gt;</span></span>
</code></pre></div><div class="warning custom-block"><p class="custom-block-title">IMPORTANT</p><p>Make sure a custom component\u2019s name either contains a hyphen or is in PascalCase. Otherwise, it will be treated as an inline element and wrapped inside a <code>&lt;p&gt;</code> tag, which will lead to hydration mismatch because <code>&lt;p&gt;</code> does not allow block elements to be placed inside it.</p></div>`,24),C={id:"using-components-in-headers",tabindex:"-1"},V=p("Using Components In Headers "),I=p(),S=n("a",{class:"header-anchor",href:"#using-components-in-headers","aria-hidden":"true"},"#",-1),A=s(`<p>You can use Vue components in the headers, but note the difference between the following syntaxes:</p><table><thead><tr><th>Markdown</th><th>Output HTML</th><th>Parsed Header</th></tr></thead><tbody><tr><td><pre><code> # text &lt;Tag/&gt; </code></pre></td><td><code>&lt;h1&gt;text &lt;Tag/&gt;&lt;/h1&gt;</code></td><td><code>text</code></td></tr><tr><td><pre><code> # text \`&lt;Tag/&gt;\` </code></pre></td><td><code>&lt;h1&gt;text &lt;code&gt;&amp;lt;Tag/&amp;gt;&lt;/code&gt;&lt;/h1&gt;</code></td><td><code>text &lt;Tag/&gt;</code></td></tr></tbody></table><p>The HTML wrapped by <code>&lt;code&gt;</code> will be displayed as-is; only the HTML that is <strong>not</strong> wrapped will be parsed by Vue.</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>The output HTML is accomplished by <a href="https://github.com/markdown-it/markdown-it" target="_blank" rel="noopener noreferrer">markdown-it</a>, while the parsed headers are handled by VitePress (and used for both the sidebar and document title).</p></div><h2 id="using-css-pre-processors" tabindex="-1">Using CSS Pre-processors <a class="header-anchor" href="#using-css-pre-processors" aria-hidden="true">#</a></h2><p>VitePress has <a href="https://vitejs.dev/guide/features.html#css-pre-processors" target="_blank" rel="noopener noreferrer">built-in support</a> for CSS pre-processors: <code>.scss</code>, <code>.sass</code>, <code>.less</code>, <code>.styl</code> and <code>.stylus</code> files. There is no need to install Vite-specific plugins for them, but the corresponding pre-processor itself must be installed:</p><div class="language-"><pre><code># .scss and .sass
npm install -D sass
# .less
npm install -D less
# .styl and .stylus
npm install -D stylus
</code></pre></div><p>Then you can use the following in Markdown and theme components:</p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>style</span> <span class="token attr-name">lang</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>sass<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span><span class="token style"><span class="token language-css">
.title
<span class="token property">font-size</span><span class="token punctuation">:</span> 20px
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>style</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><h2 id="script-style-hoisting" tabindex="-1">Script &amp; Style Hoisting <a class="header-anchor" href="#script-style-hoisting" aria-hidden="true">#</a></h2><p>Sometimes you may need to apply some JavaScript or CSS only to the current page. In those cases, you can directly write root-level <code>&lt;script&gt;</code> or <code>&lt;style&gt;</code> blocks in the Markdown file. These will be hoisted out of the compiled HTML and used as the <code>&lt;script&gt;</code> and <code>&lt;style&gt;</code> blocks for the resulting Vue single-file component:</p>`,11),P=s(`<h2 id="built-in-components" tabindex="-1">Built-In Components <a class="header-anchor" href="#built-in-components" aria-hidden="true">#</a></h2><p>VitePress provides Built-In Vue Components like <code>ClientOnly</code> and <code>OutboundLink</code>, check out the <a href="./global-component.html">Global Component Guide</a> for more information.</p><p><strong>Also see:</strong></p><ul><li><a href="#using-components-in-headers">Using Components In Headers</a></li></ul><h2 id="browser-api-access-restrictions" tabindex="-1">Browser API Access Restrictions <a class="header-anchor" href="#browser-api-access-restrictions" aria-hidden="true">#</a></h2><p>Because VitePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the <a href="https://vuejs.org/guide/scaling-up/ssr.html" target="_blank" rel="noopener noreferrer">universal code requirements</a>. In short, make sure to only access Browser / DOM APIs in <code>beforeMount</code> or <code>mounted</code> hooks.</p><p>If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the built-in <code>&lt;ClientOnly&gt;</code> component:</p><div class="language-md"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>ClientOnly</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>NonSSRFriendlyComponent</span><span class="token punctuation">/&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>ClientOnly</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p>Note this does not fix components or libraries that access Browser APIs <strong>on import</strong>. To use code that assumes a browser environment on import, you need to dynamically import them in proper lifecycle hooks:</p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token function">mounted</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">import</span><span class="token punctuation">(</span><span class="token string">&#39;./lib-that-access-window-on-import&#39;</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token punctuation">(</span><span class="token parameter">module</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
<span class="token comment">// use code</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p>If your module <code>export default</code> a Vue component, you can register it dynamically:</p><div class="language-vue"><pre><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>component</span> <span class="token attr-name">v-if</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>dynamicComponent<span class="token punctuation">&quot;</span></span> <span class="token attr-name">:is</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>dynamicComponent<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>component</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>template</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
<span class="token function">data</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">return</span> <span class="token punctuation">{</span>
<span class="token literal-property property">dynamicComponent</span><span class="token operator">:</span> <span class="token keyword">null</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token function">mounted</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">import</span><span class="token punctuation">(</span><span class="token string">&#39;./lib-that-access-window-on-import&#39;</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token punctuation">(</span><span class="token parameter">module</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
<span class="token keyword">this</span><span class="token punctuation">.</span>dynamicComponent <span class="token operator">=</span> module<span class="token punctuation">.</span>default
<span class="token punctuation">}</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><p><strong>Also see:</strong></p><ul><li><a href="https://vuejs.org/guide/essentials/component-basics.html#dynamic-components" target="_blank" rel="noopener noreferrer">Vue.js &gt; Dynamic Components</a></li></ul>`,14);function q(e,c,M,H,j,O){const i=g("ComponentInHeader");return a(),t("div",null,[b,n("div",T,[n("pre",null,[n("code",null,[(a(),t(r,null,u(3,l=>n("span",null,h(l)+" ",1)),64))])])]),x,n("h3",C,[V,d(i),I,S]),A,n("p",{class:k(["demo",e.$style.example])},null,2),P])}const D={$style:_};var E=o(w,[["render",q],["__cssModules",D]]);export{N as __pageData,E as default};

1
assets/guide_using-vue.md.74e82a4f.lean.js
View File

@ -1 +0,0 @@
import{_ as o,o as a,c as t,b as n,F as r,r as u,d,n as k,a as s,e as p,f as g,t as h}from"./app.54944ef9.js";const m={};function y(e,c){return a(),t("span",null,"\u26A1")}var f=o(m,[["render",y]]);const v="_example_t4bci_2";var _={example:v};const w={props:["slot-key"],components:{ComponentInHeader:f},mounted(){document.querySelector(`.${this.$style.example}`).textContent="This is rendered by inline script and styled by inline CSS"}},N='{"title":"Using Vue in Markdown","description":"","frontmatter":{"sidebarDepth":3},"headers":[{"level":2,"title":"Templating","slug":"templating"},{"level":3,"title":"Interpolation","slug":"interpolation"},{"level":3,"title":"Directives","slug":"directives"},{"level":3,"title":"Access to Site & Page Data","slug":"access-to-site-page-data"},{"level":2,"title":"Escaping","slug":"escaping"},{"level":2,"title":"Using Components","slug":"using-components"},{"level":3,"title":"Importing components in markdown","slug":"importing-components-in-markdown"},{"level":3,"title":"Registering global components in the theme","slug":"registering-global-components-in-the-theme"},{"level":3,"title":"Using Components In Headers","slug":"using-components-in-headers"},{"level":2,"title":"Using CSS Pre-processors","slug":"using-css-pre-processors"},{"level":2,"title":"Script & Style Hoisting","slug":"script-style-hoisting"},{"level":2,"title":"Built-In Components","slug":"built-in-components"},{"level":2,"title":"Browser API Access Restrictions","slug":"browser-api-access-restrictions"}],"relativePath":"guide/using-vue.md","lastUpdated":1652768268000}',b=s("",15),T={class:"language-text"},x=s("",24),C={id:"using-components-in-headers",tabindex:"-1"},V=p("Using Components In Headers "),I=p(),S=n("a",{class:"header-anchor",href:"#using-components-in-headers","aria-hidden":"true"},"#",-1),A=s("",11),P=s("",14);function q(e,c,M,H,j,O){const i=g("ComponentInHeader");return a(),t("div",null,[b,n("div",T,[n("pre",null,[n("code",null,[(a(),t(r,null,u(3,l=>n("span",null,h(l)+" ",1)),64))])])]),x,n("h3",C,[V,d(i),I,S]),A,n("p",{class:k(["demo",e.$style.example])},null,2),P])}const D={$style:_};var E=o(w,[["render",q],["__cssModules",D]]);export{N as __pageData,E as default};

1
assets/index.md.9a001cbe.js
View File

File diff suppressed because one or more lines are too long

1
assets/index.md.9a001cbe.lean.js
View File

@ -1 +0,0 @@
import{_ as e,c as t,o as s,a as i}from"./app.54944ef9.js";const v='{"title":"What is VitePress?","description":"","frontmatter":{"sidebarDepth":2},"headers":[{"level":2,"title":"Motivation","slug":"motivation"},{"level":2,"title":"Improvements Over VuePress v1","slug":"improvements-over-vuepress-v1"},{"level":3,"title":"It Uses Vue 3","slug":"it-uses-vue-3"},{"level":3,"title":"It Uses Vite Under The Hood","slug":"it-uses-vite-under-the-hood"},{"level":3,"title":"Lighter Page Weight","slug":"lighter-page-weight"},{"level":2,"title":"Other Differences","slug":"other-differences"},{"level":2,"title":"Will This Become The Next VuePress in The Future?","slug":"will-this-become-the-next-vuepress-in-the-future"}],"relativePath":"index.md","lastUpdated":1652768268000}',a={},r=i("",23),o=[r];function n(l,h,u,d,p,c){return s(),t("div",null,o)}var f=e(a,[["render",n]]);export{v as __pageData,f as default};

1
assets/index.md.c8bd2718.js Normal file
View File

@ -0,0 +1 @@
import{_ as e,c as t,o as a}from"./app.61e847e1.js";const p='{"title":"Home","description":"","frontmatter":{"home":true,"heroImage":"https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg","heroText":"\u54EA\u5412\u76D1\u63A7","tagline":"\u8F7B\u91CF\u7684\u81EA\u6258\u7BA1\u76D1\u63A7\u3001\u8FD0\u7EF4\u5DE5\u5177","actionText":"\u5F00\u59CB\u4F7F\u7528 \u2192","actionLink":"/guide/dashboard","features":[{"title":"\u7279\u60271","details":"\u7279\u60271\u7279\u60271\u7279\u60271"},{"title":"\u7279\u60272","details":"\u7279\u60272\u7279\u60272\u7279\u60272"},{"title":"\u7279\u60273","details":"\u7279\u60273\u7279\u60273\u7279\u60273"}],"footer":"Licence | Copyright \xA9 2022-present Nezhahq"},"headers":[],"relativePath":"index.md"}',r={};function o(i,n,s,c,d,h){return a(),t("div")}var m=e(r,[["render",o]]);export{p as __pageData,m as default};

Some files were not shown because too many files have changed in this diff Show More