This plugin will add a back to top button to your site. The button will be displayed in the bottom right corner of the page when scrolling down. By clicking the button, the page will scroll to the top.
This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-back-to-top@next
+import { backToTopPlugin } from '@vuepress/plugin-back-to-top'
+
+export default {
+ plugins: [backToTopPlugin()],
+}
+Options
threshold
- Type:
number - Default:
100 - Details: Scroll threshold distance to display back to top button (in pixels)
progress
- Type:
boolean - Default:
true - Details: Whether display progress bar around icon
Styles
You can customize the style of the back to top button via CSS variables:
:root {
+ --back-to-top-z-index: 5;
+ --back-to-top-icon: url("back-to-top.svg");
+ --back-to-top-bg-color: #fff;
+ --back-to-top-color: #3eaf7c;
+ --back-to-top-color-hover: #71cda3;
+ --back-to-top-shadow: rgb(0 0 0 / 20%);
+}
+该插件会给你的站点添加一个 返回顶部 按钮。当页面向下滚动时，该按钮会显示在页面的右下角，点击它就会滚动到页面顶部。
该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-back-to-top@next
+import { backToTopPlugin } from '@vuepress/plugin-back-to-top'
+
+export default {
+ plugins: [backToTopPlugin()],
+}
+选项
threshold
- 类型：
数字 - 默认值：
100 - 详情：显示返回顶部按钮的滚动阈值距离（以像素为单位）
progress
- 类型：
布尔值 - 默认值：
true - 详情：是否在图标周围显示进度条
样式
你可以通过 CSS 变量来自定义 返回顶部 按钮的样式：
:root {
+ --back-to-top-z-index: 5;
+ --back-to-top-icon: url("back-to-top.svg");
+ --back-to-top-bg-color: #fff;
+ --back-to-top-color: #3eaf7c;
+ --back-to-top-color-hover: #71cda3;
+ --back-to-top-shadow: rgb(0 0 0 / 20%);
+}
+使用方法
npm i -D @vuepress/plugin-baidu-analytics@next
+import { baiduAnalyticsPlugin } from '@vuepress/plugin-baidu-analytics'
+
+export default {
+ plugins: [
+ baiduAnalyticsPlugin({
+ // 配置项
+ }),
+ ],
+}
+上报事件
`,4),m=s("code",null,"hmt",-1),b=s("code",null,"window",-1),D={href:"https://tongji.baidu.com/holmes/Analytics/%E6%8A%80%E6%9C%AF%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97/JS%20API/JS%20API%20%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C",target:"_blank",rel:"noopener noreferrer"},v=s("h2",{id:"选项",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#选项"},[s("span",null,"选项")])],-1),y=s("h3",{id:"id",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#id"},[s("span",null,"id")])],-1),_=s("ul",null,[s("li",null,[n("类型： "),s("code",null,"string")]),s("li",null,[n("详情： 百度统计的 ID ，即 "),s("code",null,"hm.js"),n(" URL 中的查询参数。")])],-1);function g(E,C){const i=l("NpmBadge"),e=l("ExternalLinkIcon");return o(),c("div",null,[p,a(i,{package:"@vuepress/plugin-baidu-analytics"}),s("p",null,[n("将 "),s("a",u,[n("百度统计"),a(e)]),n(" 集成到 VuePress 中。")]),h,s("p",null,[n("在使用该插件之后，一个全局的 "),m,n(" 数组会被挂载到 "),b,n(" 对象上，你可以使用它进行 "),s("a",D,[n("自定义事件的上报"),a(e)]),n(" 。")]),v,y,_])}const k=t(d,[["render",g],["__file","baidu-analytics.html.vue"]]),x=JSON.parse('{"path":"/zh/plugins/baidu-analytics.html","title":"baidu-analytics","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[{"level":3,"title":"上报事件","slug":"上报事件","link":"#上报事件","children":[]}]},{"level":2,"title":"选项","slug":"选项","link":"#选项","children":[{"level":3,"title":"id","slug":"id","link":"#id","children":[]}]}],"git":{"updatedTime":1707328107000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"zh/plugins/baidu-analytics.md"}');export{k as comp,x as data}; diff --git a/assets/baidu-analytics.html-DXDJfEQP.js b/assets/baidu-analytics.html-DXDJfEQP.js new file mode 100644 index 0000000000..df37ae9391 --- /dev/null +++ b/assets/baidu-analytics.html-DXDJfEQP.js @@ -0,0 +1,11 @@ +import{_ as o,r as l,o as r,c,a as e,b as s,d as n,e as i}from"./app-BcH8wZQx.js";const p={},d=s("h1",{id:"baidu-analytics",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#baidu-analytics"},[s("span",null,"baidu-analytics")])],-1),u={href:"https://tongji.baidu.com/",target:"_blank",rel:"noopener noreferrer"},h=i(`Usage
npm i -D @vuepress/plugin-baidu-analytics@next
+import { baiduAnalyticsPlugin } from '@vuepress/plugin-baidu-analytics'
+
+export default {
+ plugins: [
+ baiduAnalyticsPlugin({
+ // options
+ }),
+ ],
+}
+Reporting Events
`,4),m=s("code",null,"hmt",-1),v=s("code",null,"window",-1),b={href:"https://tongji.baidu.com/holmes/Analytics/%E6%8A%80%E6%9C%AF%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97/JS%20API/JS%20API%20%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C",target:"_blank",rel:"noopener noreferrer"},g=i('Options
id
Type:
stringDetails: The ID of Baidu Analytics, which is the query of
hm.jsURL.
打包器相关
打包器函数用于在主题和插件中追加或修改打包器选项。
所有函数都应在 extendsBundlerOptions 生命周期挂钩中调用。
提示
我们在示例中省略了它。 实际代码应该是这样的：
// 导入你需要的函数
+import { addCustomElement } from '@vuepress/helper'
+
+export const yourPlugin = {
+ // ...
+ extendsBundlerOptions: (bundlerOptions, app) => {
+ // 在此添加它们
+ addCustomElement(bundlerOptions, app, 'my-custom-element')
+ },
+}
+通用方法
getBundlerName
获取当前打包器的名称。
export const getBundlerName: (app: App) => string
+示例
// @vuepress/bundler-vite
+getBundleName(app) === 'vite' // true
+// @vuepress/bundler-webpack
+getBundleName(app) === 'webpack' // true
+addCustomElement
将自定义元素声明添加到当前的打包器。
interface CustomElementCommonOptions {
+ app: App;
+ config: unknown;
+}
+/**
+ * Add tags as customElement
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param customElements tags recognized as custom element
+ */
+export const addCustomElement = (
+ bundlerOptions: unknown,
+ app: App,
+ customElement: string[] | string | RegExp
+) => void;
+示例
import { addCustomElement } from '@vuepress/helper'
+
+addCustomElement(bundlerConfig, app, 'my-custom-element')
+addCustomElement(bundlerOptions, app, [
+ 'custom-element1',
+ 'custom-element2',
+ // all tags start with \`math-\`
+ /^math-/,
+])
+customizeDevServer
为开发服务器中的特定路径提供内容。
export interface DevServerOptions {
+ /**
+ * Path to be responded
+ */
+ path: string;
+ /**
+ * Respond function
+ */
+ response: (request?: IncomingMessage) => Promise<string | Buffer>;
+
+ /**
+ * error msg
+ */
+ errMsg?: string;
+}
+
+/**
+ * Handle specific path when running VuePress Dev Server
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param path Path to be responded
+ * @param response respond function
+ * @param errMsg error msg
+ */
+export const customizeDevServer: (
+ bundlerOptions: unknown,
+ app: App,
+ {
+ errMsg:"The server encountered an error",
+ response: responseHandler,
+ path,
+ }: CustomServerOptions
+) => void;
+示例
import { useCustomDevServer } from '@vuepress/helper'
+
+// handle \`/api/\` path
+useCustomDevServer(bundlerOptions, app, {
+ path: '/api/',
+ response: async () => getData(),
+ errMsg: 'Unexpected api error',
+})
+Vite 相关
addViteOptimizeDepsInclude
向 Vite
optimizeDeps.include列表中添加模块提示
如果一个包满足下列条件之一，你应该考虑将它添加至此。
- 为 CJS 格式
- 包的依赖包含 CJS 包
- 包通过
import()动态导入
addViteOptimizeDepsExclude
向 Vite
optimizeDeps.exclude列表中添加模块如果一个包和它的依赖都是纯 ESM 包，你应该考虑将它添加至此。
addViteSsrExternal
向 Vite
ssr.external列表中添加模块如果一个包是纯 ESM 包，且未使用别名 (alias) 或定义变量 (define)，你应该考虑将它添加至此。
addViteSsrNoExternal
向 Vite
ssr.noExternal列表中添加模块如果一个包内使用了别名 (alias) 或定义变量 (define)，你必须将它添加至此。
/** + * Add modules to Vite \`optimizeDeps.include\` list + */ +export const addViteOptimizeDepsInclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite \`optimizeDeps.exclude\` list + */ +export const addViteOptimizeDepsExclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite \`ssr.external\` list + */ +export const addViteSsrExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite \`ssr.noExternal\` list + */ +export const addViteSsrNoExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void +示例
import { + addViteOptimizeDepsInclude, + addViteOptimizeDepsExclude, + addViteSsrExternal, + addViteSsrNoExternal, +} from '@vuepress/helper' + +addViteOptimizeDepsInclude(bundlerOptions, app, ['vue', 'vue-router']) +addViteOptimizeDepsExclude(bundlerOptions, app, 'packageA') +addViteSsrNoExternal(bundlerOptions, app, ['vue', 'vue-router']) +addViteSsrExternal(bundlerOptions, app, 'packageA') +addViteConfig
A function for you to add vite config
export const addViteConfig: ( + bundlerOptions: unknown, + app: App, + config: Record<string, unknown>, +) => void +Example
import { addViteConfig } from '@vuepress/helper' + +addViteConfig(bundlerOptions, app, { + build: { + charset: 'utf8', + }, +}) +mergeViteConfig
无需导入 vite 即可合并 vite 配置的功能
export const mergeViteConfig: ( + defaults: Record<string, any>, + overrides: Record<string, any>, +) => Record<string, any> +注意
你不应将 vite 作为依赖，因为你的的用户可能选择其他打包器！
示例
import { mergeViteConfig } from "@vuepress/helper"; + +config.viteOptions mergeViteConfig(config.viteOptions, { + build: { + charset: "utf8", + }, +}); +
Webpack 相关
chainWebpack
链式修改 webpack 配置.
export const chainWebpack: ( + { app, config }: WebpackCommonOptions, + chainWebpack: ( + config: WebpackChainConfig, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +示例
import { chainWebpack } from '@vuepress/helper' + +chainWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +configWebpack
配置 Webpack
export const configWebpack: ( + bundlerOptions: unknown, + app: App, + configureWebpack: ( + config: WebpackConfiguration, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +实例
import { configWebpack } from '@vuepress/helper' + +configWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +
Bundler Related
Bundler function is for appending or modifying bundler options in theme and plugins.
All functions should be called in extendsBundlerOptions lifecycle hook.
TIP
We are omitting that in examples. The actual code should be like this:
// import functions you need
+import { addCustomElement } from '@vuepress/helper'
+
+export const yourPlugin = {
+ // ...
+ extendsBundlerOptions: (bundlerOptions, app) => {
+ // add them here
+ addCustomElement(bundlerOptions, app, 'my-custom-element')
+ },
+}
+Common methods
getBundlerName
Get current bundler name.
export const getBundlerName: (app: App) => string
+Example
// @vuepress/bundler-vite
+getBundleName(app) === 'vite' // true
+// @vuepress/bundler-webpack
+getBundleName(app) === 'webpack' // true
+addCustomElement
Add a custom element declaration to the current bundler.
/**
+ * Add tags as customElement
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param customElements tags recognized as custom element
+ */
+export const addCustomElement = (
+ bundlerOptions: unknown,
+ app: App,
+ customElement: string[] | string | RegExp
+) => void;
+Example
import { addCustomElement } from '@vuepress/helper'
+
+addCustomElement(bundlerConfig, app, 'my-custom-element')
+addCustomElement(bundlerOptions, app, [
+ 'custom-element1',
+ 'custom-element2',
+ // all tags start with \`math-\`
+ /^math-/,
+])
+customizeDevServer
Provides contents for specific path in dev server.
export interface DevServerOptions {
+ /**
+ * Path to be responded
+ */
+ path: string;
+ /**
+ * Respond function
+ */
+ response: (request?: IncomingMessage) => Promise<string | Buffer>;
+
+ /**
+ * error msg
+ */
+ errMsg?: string;
+}
+
+/**
+ * Handle specific path when running VuePress Dev Server
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param path Path to be responded
+ * @param response respond function
+ * @param errMsg error msg
+ */
+export const customizeDevServer: (
+ bundlerOptions: unknown,
+ app: App,
+ {
+ errMsg:"The server encountered an error",
+ response: responseHandler,
+ path,
+ }: CustomServerOptions
+) => void;
+Example
import { useCustomDevServer } from '@vuepress/helper'
+
+// handle \`/api/\` path
+useCustomDevServer(bundlerOptions, app, {
+ path: '/api/',
+ response: async () => getData(),
+ errMsg: 'Unexpected api error',
+})
+Vite Related
addViteOptimizeDepsInclude
Add modules to Vite
optimizeDeps.includelistTIP
If a package meets one of the following conditions, you should consider adding it here.
- It's in CJS format
- It's dependencies include CJS package
- It's dynamically imported via
import()
addViteOptimizeDepsExclude
Add modules to Vite
optimizeDeps.excludelistIf a package and its dependencies are all pure ESM packages, you should consider adding it here.
addViteSsrExternal
Add modules to Vite
ssr.externallistIf a package is a pure ESM package and does not use aliases or define variables, you should consider adding it here.
addViteSsrNoExternal
Add modules to Vite
ssr.noExternallistIf an alias or define is used within a package, you must add it here.
/** + * Add modules to Vite \`optimizeDeps.include\` list + */ +export const addViteOptimizeDepsInclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite \`optimizeDeps.exclude\` list + */ +export const addViteOptimizeDepsExclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite \`ssr.external\` list + */ +export const addViteSsrExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite \`ssr.noExternal\` list + */ +export const addViteSsrNoExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void +Examples
import { + addViteOptimizeDepsInclude, + addViteOptimizeDepsExclude, + addViteSsrExternal, + addViteSsrNoExternal, +} from '@vuepress/helper' + +addViteOptimizeDepsInclude(bundlerOptions, app, ['vue', 'vue-router']) +addViteOptimizeDepsExclude(bundlerOptions, app, 'packageA') +addViteSsrNoExternal(bundlerOptions, app, ['vue', 'vue-router']) +addViteSsrExternal(bundlerOptions, app, 'packageA') +addViteConfig
A function for you to add vite config
export const addViteConfig: ( + bundlerOptions: unknown, + app: App, + config: Record<string, unknown>, +) => void +Example
import { addViteConfig } from '@vuepress/helper' + +addViteConfig(bundlerOptions, app, { + build: { + charset: 'utf8', + }, +}) +mergeViteConfig
A function for you to merge vite config.
WARNING
Your users may choose to use other bundler so it's pretty bad to declare vite as deps!
export const mergeViteConfig: ( + defaults: Record<string, any>, + overrides: Record<string, any>, +) => Record<string, any> +Example
import { mergeViteConfig } from '@vuepress/helper' + +config.viteOptions = mergeViteConfig(config.viteOptions, { + build: { + charset: 'utf8', + }, +}) +
Webpack Related
chainWebpack
Chain webpack config.
export const chainWebpack: ( + bundlerOptions: unknown, + app: App, + chainWebpack: ( + config: WebpackChainConfig, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +Example
import { chainWebpack } from '@vuepress/helper' + +chainWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +configWebpack
Config Webpack
export const configWebpack: ( + bundlerOptions: unknown, + app: App, + configureWebpack: ( + config: WebpackConfiguration, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +Example
import { configWebpack } from '@vuepress/helper' + +configWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +
The plugin can automatically generate catalog pages and provide catalog components.
Usage
npm i -D @vuepress/plugin-catalog@next
+import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ plugins: [
+ catalogPlugin({
+ // Your options
+ }),
+ ],
+}
+First, you should set catalog info in routeMeta:
import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ extendsPage: (page) => {
+ // set catalog info in routeMeta
+ page.routeMeta = {
+ // catalog title
+ title: page.title,
+ // ... other information
+ }
+ },
+}
+import { defineCatalogInfoGetter } from '@vuepress/plugin-catalog/client'
+
+export default {
+ setup: () => {
+ defineCatalogInfoGetter((meta) =>
+ meta.title ? { title: meta.title } : null,
+ )
+ },
+}
+Catalog info should contains:
title: catalog titleorder: catalog order (optional)content: catalog content component (optional)
Sorting with order
The plugin will sort pages by order in the following way:
// order positive numbers from small to large
+Project with order 1
+Project with order 2
+...
+Project with order 10
+...
+// Project without order
+Project without order
+Project without order
+...
+// order negative numbers from small to large
+Project with order -10
+// ...
+Project with order -2
+Project with order -1
+Options
`,5),C={id:"level",tabindex:"-1"},h={class:"header-anchor",href:"#level"},b=s("ul",null,[s("li",null,[n("Type: "),s("code",null,"1 | 2 | 3")]),s("li",null,[n("Default: "),s("code",null,"3")]),s("li",null,"Details: Max depth of catalog items.")],-1),f={id:"index",tabindex:"-1"},E={class:"header-anchor",href:"#index"},x=e(`- Type:
boolean - Default:
false - Details: Whether show index for catalog
frontmatter
Type:
(path: string) => Record<string, any>Required: No
Details: Frontmatter getter for the generated page.
Example:
import { catalogPlugin } from '@vuepress/plugin-catalog' + +export default { + plugins: [ + catalogPlugin({ + frontmatter: (path) => ({ + // frontmatter you want + // you may customize title, author. time, etc. + }), + }), + ], +} +
exclude
Type:
(RegExp | string)[]Default:
[]Details:
Catalog page path to be excluded during generation.
"/foo/"means only exclude catalog page generation at/foo/folder./^\\/foo\\//means exclude catalog page generation at/foo/folder and its subfolders.
404 pages will be automatically excluded.
component
- Type:
string - Required: No
- Details: Component name to use as catalog.
locales
Type:
CatalogPluginLocaleConfiginterface CatalogPluginLocaleData { + /** + * Catalog title + */ + title: string + + /** + * Empty hint + */ + empty: string +} + +interface CatalogPluginLocaleConfig { + [localePath: string]: CatalogPluginLocaleData +} +Required: No
Details: Locales config for catalog component.
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Client options
defineCatalogInfoGetter
interface CatalogInfo {
+ /** Catalog title */
+ title: string
+ /** Catalog order */
+ order?: number
+ /** Catalog content */
+ content?: Component
+}
+
+type CatalogInfoGetter = (meta: Record<string, unknown>) => CatalogInfo | null
+
+const defineCatalogInfoGetter: (options: CatalogInfoGetter) => void
+Customize how to extract catalog info from meta.
Components
Catalog
Details:
The plugin will globally register a
<Catalog />component by default (unless you set thecomponentoption).You can use
<Catalog />in the theme layout or directly in the Markdown file.The component supports four props:
level: Change the display depth (maximum support 3 levels), default is3.base: Display catalog of the specified folder, default is the current folder directory.index: Add an index number to the directory item, default is no number.hideHeading: Hide the component title, default is to display theCatalogtitle.
Styles
You can customize the style of catalog via CSS variables:
:root {
+ --catalog-bg-color: #fff;
+ --catalog-bg-secondary-color: #f8f8f8;
+ --catalog-border-color: #e5e5e5;
+ --catalog-active-color: #3eaf7c;
+ --catalog-hover-color: #71cda3;
+}
+此插件可以自动生成目录页面，也提供目录组件。
使用方法
npm i -D @vuepress/plugin-catalog@next
+import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ plugins: [
+ catalogPlugin({
+ // 你的选项
+ }),
+ ],
+}
+首先，你应该在路由元信息中设置目录信息:
import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ extendsPage: (page) => {
+ // 在 routeMeta 中设置目录信息
+ page.routeMeta = {
+ // 目录标题
+ title: page.title,
+ // ... 其他信息
+ }
+ },
+}
+import { defineCatalogInfoGetter } from '@vuepress/plugin-catalog/client'
+
+export default {
+ setup: () => {
+ defineCatalogInfoGetter((meta) =>
+ meta.title ? { title: meta.title } : null,
+ )
+ },
+}
+目录信息应包含:
title: 目录标题order: 目录顺序 (可选)content: 目录内容组件 (可选)
通过 order 排序
插件将按以下方式通过 order 对页面进行排序:
// 从小到大依次排列正数
+order 1 的项目
+order 2 的项目
+...
+order 10 的项目
+...
+// 无 order 的项目
+无 order 的项目
+无 order 的项目
+...
+// 从小到大依次排列负数
+order -10 的项目
+// ...
+order -2 的项目
+order -1 的项目
+选项
`,5),C={id:"level",tabindex:"-1"},m={class:"header-anchor",href:"#level"},b=s("ul",null,[s("li",null,[n("类型："),s("code",null,"1 | 2 | 3")]),s("li",null,[n("默认值："),s("code",null,"3")]),s("li",null,"详情：目录项级别的最大深度。")],-1),h={id:"index",tabindex:"-1"},E={class:"header-anchor",href:"#index"},f=e(`- 类型：
boolean - 默认值：
false - 详情：目录是否显示索引
frontmatter
类型：
(path: string) => Record<string, any>详情：生成页面的 Frontmatter 获取器。
示例：
import { catalogPlugin } from '@vuepress/plugin-catalog' + +export default { + plugins: [ + catalogPlugin({ + frontmatter: (path) => ({ + // 你想要的 frontmatter + // 你可以自定义标题、作者、时间等 + }), + }), + ], +} +
exclude
类型：
(RegExp | string)[]默认值：
[]详情：
生成中需要排除的目录页路径。
"/foo/"意味着仅排除/foo/文件夹的目录页生成。/^\\/foo\\//意味着排除/foo/文件夹及其子文件夹的目录页生成。
404 页面会被自动排除。
component
- 类型：
string - 详情：用作目录的组件名称。
locales
类型：
CatalogPluginLocaleConfiginterface CatalogPluginLocaleData { + /** + * 目录标题 + */ + title: string + + /** + * 空目录提示 + */ + empty: string +} + +interface CatalogPluginLocaleConfig { + [localePath: string]: CatalogPluginLocaleData +} +必填: 否
详情：目录组件国际化配置。
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
客户端选项
defineCatalogInfoGetter
interface CatalogInfo {
+ /** 目录标题 */
+ title: string
+ /** 目录顺序 */
+ order?: number
+ /** 目录内容 */
+ content?: Component
+}
+
+type CatalogInfoGetter = (meta: Record<string, unknown>) => CatalogInfo | null
+
+const defineCatalogInfoGetter: (options: CatalogInfoGetter) => void
+自定义如何从 meta 中提取目录信息。
组件
Catalog
详情：
该插件默认会全局注册一个
<Catalog />组件（除非你设置了component选项）。你可以在主题布局中或直接在 Markdown 文件中使用
<Catalog />。组件支持四个属性：
level：更改显示层次深度（最大仅支持 3 层），默认为3。base：显示指定文件夹的目录，默认显示当前文件夹目录。index：为目录项添加索引号，默认无标号。hideHeading：隐藏组件标题，默认会显示目录标题。
样式
你可以通过 CSS 变量来自定义目录样式：
:root {
+ --catalog-bg-color: #fff;
+ --catalog-bg-secondary-color: #f8f8f8;
+ --catalog-border-color: #e5e5e5;
+ --catalog-active-color: #3eaf7c;
+ --catalog-hover-color: #71cda3;
+}
+频道设置
channel 插件选项用于配置 feed 的频道。
channel.title
- 类型：
string - 默认值：
SiteConfig.title
频道的标题
channel.link
- 类型：
string - 默认值：部署的网址 (通过
options.hostname和context.base生成)
频道地址
channel.description
- 类型：
string - 默认值：
SiteConfig.description
频道描述信息
channel.language
- 类型：
string - 默认值:
siteConfig.locales['/'].locales- 如果上述未提供，回退到
"en-US"
频道使用的语言
channel.copyright
- 类型：
string - 默认值:
- 尝试读取 channel 选项中的
author.name生成Copyright by $author
- 尝试读取 channel 选项中的
- 建议自行设置: 是
频道版权信息
channel.pubDate
- 类型：
string(需是合法的 Date ISOString) - 默认值：每次插件构建时刻
- 建议自行设置: 是
频道内容的发布时间
channel.lastUpdated
- 类型：
string(需是合法的 Date ISOString) - 默认值：每次插件构建时刻
频道内容的上次更新时间
channel.ttl
- 类型：
number - 建议自行设置: 是
内容有效时间，即获取后保持缓存而不进行新获取的时间
channel.image
- 类型：
string - 建议自行设置: 是
这是一个会在频道中使用的图片，建议设置正方形图片、尺寸最好不小于 512×512。
channel.icon
- 类型：
string - 建议自行设置: 是
一个代表频道的图标，建议设置正方形图片、尺寸最好不小于 128×128，背景色透明。
channel.author
- 类型：
FeedAuthor - 建议自行设置: 是
频道的作者。
FeedAuthor 格式
interface FeedAuthor {
+ /** 作者姓名 */
+ name: string
+ /** 作者电子邮箱 */
+ email?: string
+ /** 作者网站 */
+ url?: string
+ /**
+ * 作者头像地址
+ *
+ * 正方形，最好不小于 128×128，透明背景
+ */
+ avatar?: string
+}
+channel.hub
- 类型：
string
Websub 的链接。Websub 需要服务器后端，与 VuePress 主旨不符，如无特殊需要忽略即可。
`,39),d={class:"custom-container tip"},p=n("p",{class:"custom-container-title"},"WebSub",-1),u={href:"https://w3c.github.io/websub/#subscription-migration",target:"_blank",rel:"noopener noreferrer"};function g(b,m){const l=s("ExternalLinkIcon");return i(),c("div",null,[r,n("div",d,[p,n("p",null,[e("有关信息，详见 "),n("a",u,[e("Websub"),t(l)]),e("。")])])])}const y=a(h,[["render",g],["__file","channel.html.vue"]]),f=JSON.parse('{"path":"/zh/plugins/feed/channel.html","title":"频道设置","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"channel.title","slug":"channel-title","link":"#channel-title","children":[]},{"level":2,"title":"channel.link","slug":"channel-link","link":"#channel-link","children":[]},{"level":2,"title":"channel.description","slug":"channel-description","link":"#channel-description","children":[]},{"level":2,"title":"channel.language","slug":"channel-language","link":"#channel-language","children":[]},{"level":2,"title":"channel.copyright","slug":"channel-copyright","link":"#channel-copyright","children":[]},{"level":2,"title":"channel.pubDate","slug":"channel-pubdate","link":"#channel-pubdate","children":[]},{"level":2,"title":"channel.lastUpdated","slug":"channel-lastupdated","link":"#channel-lastupdated","children":[]},{"level":2,"title":"channel.ttl","slug":"channel-ttl","link":"#channel-ttl","children":[]},{"level":2,"title":"channel.image","slug":"channel-image","link":"#channel-image","children":[]},{"level":2,"title":"channel.icon","slug":"channel-icon","link":"#channel-icon","children":[]},{"level":2,"title":"channel.author","slug":"channel-author","link":"#channel-author","children":[]},{"level":2,"title":"channel.hub","slug":"channel-hub","link":"#channel-hub","children":[]}],"git":{"updatedTime":1706801200000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":3}]},"filePathRelative":"zh/plugins/feed/channel.md"}');export{y as comp,f as data}; diff --git a/assets/channel.html-fAiQXm7A.js b/assets/channel.html-fAiQXm7A.js new file mode 100644 index 0000000000..91b1429d50 --- /dev/null +++ b/assets/channel.html-fAiQXm7A.js @@ -0,0 +1,15 @@ +import{_ as s,r as i,o as t,c,b as e,d as n,a as o,e as a}from"./app-BcH8wZQx.js";const h={},r=a('Channel Config
The channel plugin option is used to config the feed channel.
channel.title
- Type:
string - Default:
SiteConfig.title
Channel title
channel.link
- Type:
string - Default: Deployment link (generated by
options.hostnameandcontext.base)
Channel address
channel.description
- Type:
string - Default:
SiteConfig.description
Channel description
channel.language
Type:
stringDefault:
siteConfig.locales['/'].lang- If the above is not provided, fall back to
"en-US"
The language of the channel
channel.copyright
Type:
stringDefault:
- Try to read the
author.namein channel options, and fall back toCopyright by $author
- Try to read the
Recommended to set manually: Yes
Channel copyright information
channel.pubDate
- Type:
string(must be a valid Date ISOString) - Default: time when the plugin is called each time
- Recommended to set manually: Yes
Publish date of the Channel
channel.lastUpdated
- Type:
string(must be a valid Date ISOString) - Default: time when the plugin is called each time
Last update time of channel content
channel.ttl
- Type:
number - Recommended to set manually: Yes
The effective time of the content. It's the time to keep the cache after request without making new requests.
channel.image
- Type:
string - Recommended to set manually: Yes
A picture presenting the channel. A square picture with a size not smaller than 512×512 is recommended.
channel.icon
- Type:
string - Recommended to set manually: Yes
An icon representing a channel, a square picture, with not less than 128×128 in size, and transparent background color is recommended.
channel.author
- Type:
FeedAuthor - Recommended to set manually: Yes
The author of the channel.
',35),p={class:"custom-container details"},d=a(`interface FeedAuthor {
+ /** Author name */
+ name: string
+ /** Author's email */
+ email?: string
+ /** Author's site */
+ url?: string
+ /**
+ * Author's avatar address
+ *
+ * Square, preferably not less than 128×128 with transparent background
+ */
+ avatar?: string
+}
+channel.hub
- Type:
string
Link to Websub. Websub requires a server backend, which is inconsistent with VuePress, so ignore it if there is no special need.
`,5),u={class:"custom-container tip"},g=e("p",{class:"custom-container-title"},"WebSub",-1),m={href:"https://w3c.github.io/websub/#subscription-migration",target:"_blank",rel:"noopener noreferrer"};function b(y,f){const l=i("ExternalLinkIcon");return t(),c("div",null,[r,e("details",p,[d,e("div",u,[g,e("p",null,[n("For details, see "),e("a",m,[n("Websub"),o(l)]),n(".")])])])])}const D=s(h,[["render",b],["__file","channel.html.vue"]]),k=JSON.parse('{"path":"/plugins/feed/channel.html","title":"Channel Config","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"channel.title","slug":"channel-title","link":"#channel-title","children":[]},{"level":2,"title":"channel.link","slug":"channel-link","link":"#channel-link","children":[]},{"level":2,"title":"channel.description","slug":"channel-description","link":"#channel-description","children":[]},{"level":2,"title":"channel.language","slug":"channel-language","link":"#channel-language","children":[]},{"level":2,"title":"channel.copyright","slug":"channel-copyright","link":"#channel-copyright","children":[]},{"level":2,"title":"channel.pubDate","slug":"channel-pubdate","link":"#channel-pubdate","children":[]},{"level":2,"title":"channel.lastUpdated","slug":"channel-lastupdated","link":"#channel-lastupdated","children":[]},{"level":2,"title":"channel.ttl","slug":"channel-ttl","link":"#channel-ttl","children":[]},{"level":2,"title":"channel.image","slug":"channel-image","link":"#channel-image","children":[]},{"level":2,"title":"channel.icon","slug":"channel-icon","link":"#channel-icon","children":[]},{"level":2,"title":"channel.author","slug":"channel-author","link":"#channel-author","children":[]}],"git":{"updatedTime":1706762763000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":2}]},"filePathRelative":"plugins/feed/channel.md"}');export{D as comp,k as data}; diff --git a/assets/client.html-BrrqRtXD.js b/assets/client.html-BrrqRtXD.js new file mode 100644 index 0000000000..71a8a4898a --- /dev/null +++ b/assets/client.html-BrrqRtXD.js @@ -0,0 +1,22 @@ +import{_ as s,o as a,c as n,e as l}from"./app-BcH8wZQx.js";const e={},o=l(`Client Related
Composables APIs
hasGlobalComponent
Check whether a component is registered globally.
TIP
- Local import of the component does not affect the result.
- When calling outside
setupscope, you need to pass theappinstance as the second parameter.
export const hasGlobalComponent: (name: string, app?: App) => boolean
+Example
// if you globally register \`<my-component>\`
+hasGlobalComponent('MyComponent') // true
+hasGlobalComponent('my-component') // true
+
+hasGlobalComponent('MyComponent2') // false
+useLocaleConfig
Get current locale config from locales settings.
export const useLocaleConfig: <T extends LocaleData>(
+ localesConfig: RequiredLocaleConfig<T>,
+) => ComputedRef<T>
+Example
const localesCOnfig = {
+ '/': 'Title',
+ '/zh/': '标题',
+}
+
+const locale = useLocaleConfig(localesConfig)
+
+// under \`/page\`
+locale.value // 'Title'
+
+// under \`/zh/page\`
+locale.value // '标题'
+客户端相关
可组合 API
hasGlobalComponent
检查组件是否已全局注册。
提示
- 组件的局部导入不影响结果。
- 当在
setup之外调用时，你需要将app实例作为第二个参数传递。
export const hasGlobalComponent: (name: string, app?: App) => boolean
+示例
// 如果你全局注册了 \`<my-component>\`
+hasGlobalComponent('MyComponent') // true
+hasGlobalComponent('my-component') // true
+
+hasGlobalComponent('MyComponent2') // false
+useLocaleConfig
从语言环境设置中获取当前语言环境配置。
export const useLocaleConfig: <T extends LocaleData>(
+ localesConfig: RequiredLocaleConfig<T>,
+) => ComputedRef<T>
+示例
const localesCOnfig = {
+ '/': 'Title',
+ '/zh/': '标题',
+}
+
+const locale = useLocaleConfig(localesConfig)
+
+// under \`/page\`
+locale.value // 'Title'
+
+// under \`/zh/page\`
+locale.value // '标题'
+Props:
- type
- 类型：
'tip' | 'warning' | 'danger' - 默认值：
'tip'
- 类型：
- text
- 类型：
string - 默认值：
''
- 类型：
- vertical
- 类型：
'top' | 'middle' | 'bottom' | undefined - 默认值：
undefined
- 类型：
- type
示例：
输入
- VuePress - <Badge type="tip" text="v2" vertical="top" />
+- VuePress - <Badge type="warning" text="v2" vertical="middle" />
+- VuePress - <Badge type="danger" text="v2" vertical="bottom" />
+输出
`,4),b=p(`CodeGroup
详情：
CodeGroupItem 组件的 Wrapper 。
CodeGroupItem
Props:
- title
- 类型：
string - 是否必需：
true
- 类型：
- active
- 类型：
boolean - 默认值：
false
- 类型：
- title
详情：
该组件必须放置在 CodeGroup 组件的内部。
可以通过
activeProp 来设置初始激活的元素。如果不设置，默认激活第一个元素。示例：
输入
<CodeGroup>
+ <CodeGroupItem title="pnpm">
+
+\`\`\`bash:no-line-numbers
+pnpm install
+\`\`\`
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="yarn">
+
+\`\`\`bash:no-line-numbers
+yarn install
+\`\`\`
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="npm" active>
+
+\`\`\`bash:no-line-numbers
+npm install
+\`\`\`
+
+ </CodeGroupItem>
+</CodeGroup>
+输出
`,7),E=s("div",{class:"language-bash","data-ext":"sh","data-title":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"pnpm"),s("span",{style:{color:"#CE9178"}}," install")]),n(` +`),s("span",{class:"line"})])])],-1),_=s("div",{class:"language-bash","data-ext":"sh","data-title":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"yarn"),s("span",{style:{color:"#CE9178"}}," install")]),n(` +`),s("span",{class:"line"})])])],-1),k=s("div",{class:"language-bash","data-ext":"sh","data-title":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"npm"),s("span",{style:{color:"#CE9178"}}," install")]),n(` +`),s("span",{class:"line"})])])],-1),f={class:"custom-container warning"},x=s("p",{class:"custom-container-title"},"注意",-1),q=s("p",null,[n("你必须在 "),s("code",null,"Props:
- type
- Type:
'tip' | 'warning' | 'danger' - Default:
'tip'
- Type:
- text
- Type:
string - Default:
''
- Type:
- vertical
- Type:
'top' | 'middle' | 'bottom' | undefined - Default:
undefined
- Type:
- type
Example:
Input
- VuePress - <Badge type="tip" text="v2" vertical="top" />
+- VuePress - <Badge type="warning" text="v2" vertical="middle" />
+- VuePress - <Badge type="danger" text="v2" vertical="bottom" />
+Output
`,4),g=p(`CodeGroup
Details:
Wrapper of the CodeGroupItem components.
CodeGroupItem
Props:
- title
- Type:
string - Required:
true
- Type:
- active
- Type:
boolean - Default:
false
- Type:
- title
Details:
This component must be placed inside a CodeGroup component.
Use the
activeprop to set the initial active item, or the first item will be activated by default.Example:
Input
<CodeGroup>
+ <CodeGroupItem title="pnpm">
+
+\`\`\`bash:no-line-numbers
+pnpm install
+\`\`\`
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="yarn">
+
+\`\`\`bash:no-line-numbers
+yarn install
+\`\`\`
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="npm" active>
+
+\`\`\`bash:no-line-numbers
+npm install
+\`\`\`
+
+ </CodeGroupItem>
+</CodeGroup>
+Output
`,7),_=s("div",{class:"language-bash","data-ext":"sh","data-title":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"pnpm"),s("span",{style:{color:"#CE9178"}}," install")]),n(` +`),s("span",{class:"line"})])])],-1),E=s("div",{class:"language-bash","data-ext":"sh","data-title":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"yarn"),s("span",{style:{color:"#CE9178"}}," install")]),n(` +`),s("span",{class:"line"})])])],-1),f=s("div",{class:"language-bash","data-ext":"sh","data-title":"sh"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#DCDCAA"}},"npm"),s("span",{style:{color:"#CE9178"}}," install")]),n(` +`),s("span",{class:"line"})])])],-1),k={class:"custom-container warning"},x=s("p",{class:"custom-container-title"},"WARNING",-1),q=s("p",null,[n("You must add an empty line between the starting tag of "),s("code",null,"Config
hostname
Type:
stringRequired: Yes
Details:
Deploy hostname.
author
Type:
Authortype AuthorName = string + +interface AuthorInfo { + /** + * Author name + */ + name: string + + /** + * Author website + */ + url?: string + + /** + * Author email + */ + email?: string +} + +type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[] +Required: No
Details:
Default author.
autoDescription
Type:
booleanDefault:
trueDetails:
Whether generate description automatically
canonical
Type:
string | ((page: Page) => string | null)Details:
Canonical link
fallBackImage
Type:
stringDetails:
Fallback Image link when no image are found
restrictions
Type:
stringDetails:
The age rating of the content, the format is
[int]+, such as"13+".
twitterID
Type:
stringDetails:
Fill in your twitter username.
isArticle
Type:
(page: Page) => booleanDetails:
Use this option to judge whether the page is an article.
ogp
Type:
function ogp( + /** OGP info inferred by plugin */ + ogp: SeoContent, + /** Page Object */ + page: Page, + /** VuePress App */ + app: App, +): SeoContent +Required: No
Details:
Custom OPG Generator.
You can use this options to edit OGP tags.
jsonLd
Type:
function jsonLd( + /** JSON-LD Object inferred by plugin */ + jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema, + /** Page Object */ + page: Page, + /** VuePress App */ + app: App, +): ArticleSchema | BlogPostingSchema | WebPageSchema +Required: No
Details:
Custom JSON-LD Generator.
You can use this options to edit JSON-LD properties.
customHead
Type:
function customHead( + /** Head tag config */ + head: HeadConfig[], + /** Page Object */ + page: Page, + /** VuePress App */ + app: App, +): void +Required: No
Details:
You can use this options to edit tags injected to
<head>.
配置
选项
showInstall
类型：
boolean默认值：
false详情：
是否在 Service Worker 首次成功注册时显示 PWA 安装按钮
manifest
',5),d=l('类型：ManifestOption
详情：
填充一个将被解析为 manifest.webmanifest 的对象。
提示
如果未设置某些选项，它们会回退到插件预设值。
- name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - short_name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - description:
siteConfig.description||siteConfig.locales['/'].description||"A site built with vuepress" - lang:
siteConfig.locales['/'].lang||"en-US" - start_url:
context.base - scope:
context.base - display:
"standalone" - theme_color:
"#46bd87" - background_color:
"#ffffff" - orientation:
"portrait-primary" - prefer_related_applications:
false
favicon
类型：
string详情：
favicon.ico地址，填入绝对路径。注意
我们建议你为你的站点生成 favicon。
themeColor
- 类型：
string - 默认值：
"#46bd87" - 详情：PWA 的主题色。
cacheHTML
- 类型：
boolean - 默认值：
false - 详情：是否缓存主页和 404 错误页之外的 HTML 文件
cacheImage
- 类型：
boolean - 默认值：
false - 详情：是否缓存图片。
maxSize
类型：
number默认值：
2048详情：
允许缓存的最大大小 (以 KB 为单位)
注意
此选项具有最高优先级，任何超过此值的文件都会被排除。
所以你如果生成了很大的 HTML 或 JS 文件，请考虑调高此值，否则你的 PWA 可能无法在离线模式下正常运行。
maxImageSize
类型：
number默认值：
1024详情：
图片允许缓存的最大大小 (以 KB 为单位)
该选项不能大于 maxSize 选项
update
类型：
"disabled" | "available" | "hint" | "force"默认值：
"available"详情：
发现新内容时的控制逻辑。
"disabled": 即使有新的 service worker 也不做任何事情，新的 service work 开始等待后，会在用户下次访问时接管页面，让用户获得新内容。"available": 仅当新的 service worker 可用时才显示更新弹出窗口"hint": 显示更新内容可用提示，并允许用户立即刷新。当新的 SW 成功注册后，将转为更新内容就绪弹窗。当你希望用户立即查看新文档时，这很有帮助。
提示
如果用户在新 SW 就绪前选择刷新，当前的 Service Worker 将被注销，并且请求将开始向 Web 发出。新的 service worker 将开始安装并在安装后接管页面。
"force": 立即注销当前 Service Worker 然后刷新以获取新内容警告
虽然这可以确保用户访问的是最新内容，但这可能会影响访问体验。
提示
文档的更新方式由以前的版本控制，因此当前选项仅影响此版本的下一次更新。
apple
更高支持苹果的特殊设置，忽略它们是安全的。
apple.icon
- 类型：
string - 详情：填入苹果使用的图标地址，推荐 152×152 大小
apple.statusBarColor
- 类型：
"black" | "white" - 默认值：
"black" - 详情：Safari 状态栏颜色
apple.maskIcon
- 类型：
string - 详情：Safari 图标
msTile
针对微软磁贴的特殊设置，忽略它们是安全的。
msTile.image
- 类型：
string - 详情：磁贴图标
msTile.color
- 类型：
string - 默认值：
themeColor - 详情：磁贴颜色。
foundComponent
- 类型：
string - 默认值：
"PwaFoundPopup" - 详情：自定义的提示弹窗组件路径。
readyComponent
- 类型：
string - 默认值：
"PwaReadyPopup" - 详情：自定义的更新弹窗组件路径。
appendBase
- 类型：
boolean - 默认值：
false - 详情：是否为选项中所有绝对链接添加 base。
generateSwConfig
',35),m=s("p",null,"详情：",-1),C=s("code",null,"workbox-build",-1),h={href:"https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build#.generateSW",target:"_blank",rel:"noopener noreferrer"},b=l(`locales
类型：
PwaPluginLocaleConfiginterface PwaPluginLocaleData { + /** + * 安装按钮文字 + */ + install: string + + /** + * iOS 安装文字 + */ + iOSInstall: string + + /** + * 取消按钮文字 + */ + cancel: string + + /** + * 关闭按钮文字 + */ + close: string + + /** + * 上一张图片文字 + */ + prevImage: string + + /** + * 下一张图片文字 + */ + nextImage: string + + /** + * 安装解释 + */ + explain: string + + /** + * 描述标签文字 + */ + desc: string + + /** + * 特性标签文字 + */ + feature: string + + /** + * 更新内容提示文字 + */ + hint: string + + /** + * 更新内容可用文字 + */ + update: string +} + +interface PwaPluginLocaleConfig { + [localePath: string]: PwaPluginLocaleData +} +详情：
PWA 插件的国际化配置。
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
组合式 API
usePwaEvent
`,5),g=s("p",null,"详情：",-1),f=s("p",null,"返回此插件的事件派发器。",-1),E={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},k=s("li",null,[s("p",null,"示例：")],-1),A=l(`import { usePwaEvent } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+ event.on('ready', (registration) => {
+ console.log('Service worker is active.')
+ })
+ },
+}
+工具函数
forceUpdate
详情：
当发现新内容时强制刷新页面。
示例：
import { forceUpdate } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ forceUpdate()
+ })
+ },
+}
+registerSW
详情：
手动注册 Service Worker。
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| serviceWorkerPath | string | Service worker 的路径 |
| hooks | object | Service worker 的钩子 |
| showStatus | boolean | 在控制台输出状态日志 |
interface Hooks {
+ registrationOptions?: RegistrationOptions
+ ready?: (registration: ServiceWorkerRegistration) => void
+ registered?: (registration: ServiceWorkerRegistration) => void
+ cached?: (registration: ServiceWorkerRegistration) => void
+ updated?: (registration: ServiceWorkerRegistration) => void
+ updatefound?: (registration: ServiceWorkerRegistration) => void
+ offline?: () => void
+ error?: (error: Error) => void
+}
+- 示例：
import { registerSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ registerSW('/service-worker.js', {
+ ready(registration) {
+ console.log('Service worker is active.')
+ },
+ })
+ })
+ },
+}
+skipWaiting
详情：
激活等待中的 Service Worker。
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| registration | ServiceWorkerRegistration | 想要激活的 Service Worker 的注册 |
- 示例：
import { usePwaEvent, skipWaiting } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+
+ event.on('updated', (registration) => {
+ console.log('The waiting service worker is available.')
+ // activate the waiting service worker
+ skipWaiting(registration)
+ })
+ },
+}
+unregisterSW
详情：
手动注销 Service Worker。
示例：
import { unregisterSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ unregisterSW()
+ })
+ },
+}
+样式
你可以通过 CSS 变量来自定义样式：
:root {
+ --pwa-z-index: 10;
+ --pwa-color: #2c3e50;
+ --pwa-bg-color: #ffffff;
+ --pwa-border-color: #3eaf7c;
+ --pwa-shadow-color: rgb(0 0 0 / 15%);
+ --pwa-btn-text-color: #ffffff;
+ --pwa-btn-bg-color: #3eaf7c;
+ --pwa-btn-hover-bg-color: #4abf8a;
+ --pwa-content-color: #333;
+ --pwa-content-light-color: #666;
+}
+配置
插件选项
getInfo
',3),D=s("li",null,[s("p",null,[n("类型: "),s("code",null,"(page: Page) => Recordslugify
- 类型:
(name: string) => string - 默认值:
(name) => name.replace(/ _/g, '-').replace(/[:?*|\\\\/<>]/g, "").toLowerCase() - 详情：Slugify 函数，用于转换 key 在路由中注册的形式。
excerpt
- 类型:
boolean - 默认值:
true - 详情：是否生成摘要。
excerptSeparator
- 类型:
string - 默认值:
<!-- more --> - 详情：摘要分隔符。
excerptLength
',7),w=s("li",null,[s("p",null,[n("类型: "),s("code",null,"number")])],-1),z=s("li",null,[s("p",null,[n("默认值: "),s("code",null,"300")])],-1),L=s("p",null,"参考：",-1),I=s("li",null,[s("p",null,"详情："),s("p",null,"自动生成的摘要的长度。"),s("div",{class:"custom-container tip"},[s("p",{class:"custom-container-title"},"提示"),s("p",null,[n("摘要的长度会尽可能的接近这个值。如果设置为 "),s("code",null,"0"),n("，意味着不自动生成摘要。")])])],-1),N=s("h3",{id:"excerptfilter",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#excerptfilter"},[s("span",null,"excerptFilter")])],-1),S=s("li",null,[s("p",null,[n("类型: "),s("code",null,"(page: Page) => boolean")])],-1),M=s("li",null,[s("p",null,[n("默认值: "),s("code",null,"filter"),n(" 选项")])],-1),O=s("p",null,"参考：",-1),q=s("li",null,[s("p",null,"详情： 页面过滤器，此函数用于鉴别插件是否需要生成摘要。"),s("div",{class:"custom-container tip"},[s("p",{class:"custom-container-title"},"提示"),s("p",null,[n("你可以使用此函数来跳过你不需要生成摘要的页面。例如：如果用户在 frontmatter 中设置了 "),s("code",null,"excerpt"),n(" 或 "),s("code",null,"description"),n("，你可能希望直接使用它们。")])])],-1),V=s("h3",{id:"iscustomelement",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#iscustomelement"},[s("span",null,"isCustomElement")])],-1),H=s("li",null,[s("p",null,[n("类型: "),s("code",null,"(tagName: string) => boolean")])],-1),J=s("li",null,[s("p",null,[n("默认值: "),s("code",null,"() => false")])],-1),j=s("p",null,"参考：",-1),G=s("li",null,[s("p",null,"详情： 被认为是自定义元素的标签。"),s("p",null,"用于判断一个标签是否是自定义元素，因为在摘要中，所有的未知标签都会被移除。")],-1),K=p(`metaScope
类型:
string默认值:
"_blog"详情： 注入文章信息至路由元数据时使用的键名。
提示
设置为空字符串会直接注入路由元数据 (而不是一个键下)。
hotReload
类型:
boolean默认值: 是否使用
--debug标记详情： 是否在开发服务器中启用实时热重载。
致主题开发者
默认情况下它是禁用的，因为它确实会对具有很多分类和类别的站点产生性能影响，并且在编辑 Markdown 时会减慢热重载的速度。
如果用户正在添加或组织类别或标签，你可以告诉他们启用此功能，其余的时间最好禁用它。
此外，你可以尝试检测用户项目中的页面数并决定是否启用它。
博客分类配置
博客分类配置应为一个数组，每一项控制一个分类规则。
interface BlogCategoryOptions {
+ /**
+ * 唯一的分类名称
+ */
+ key: string
+
+ /**
+ * 从页面中获取分类的函数
+ */
+ getter: (page: Page) => string[]
+
+ /**
+ * 页面排序器
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * 待注册的页面路径图案
+ *
+ * @description \`:key\` 将会被替换为原 key 的 slugify 结果
+ *
+ * @default \`/:key/\`
+ */
+ path?: string | false
+
+ /**
+ * 页面布局组件名称
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Front Matter 配置
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+
+ /**
+ * 待注册的项目页面路径图案或自定义函数
+ *
+ * @description 当填入字符串的时候, \`:key\` 和 \`:name\` 会被自动替换为原始的 key、name 的 slugify 结果。
+ *
+ * @default \`/:key/:name/\`
+ */
+ itemPath?: string | ((name: string) => string) | false
+
+ /**
+ * 项目页面布局组件名称
+ *
+ * @default 'Layout'
+ */
+ itemLayout?: string
+
+ /**
+ * 项目 Front Matter 配置
+ */
+ itemFrontmatter?: (name: string, localePath: string) => Record<string, string>
+}
+博客类型配置
博客类型配置应为一个数组，每一项控制一个类型规则。
interface BlogTypeOptions {
+ /**
+ * 唯一的类型名称
+ */
+ key: string
+
+ /**
+ * 一个过滤函数来决定页面是否满足此类型
+ */
+ filter: (page: Page) => boolean
+
+ /**
+ * 页面排序器
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * 待注册的页面路径
+ *
+ * @default '/:key/'
+ */
+ path?: string | false
+
+ /**
+ * 页面布局组件名称
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Front Matter 配置
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+}
+可组合式 API
你可以从 @vuepress/plugin-blog/client 导入下列 API:
博客分类
const useBlogCategory: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogCategoryData<T>> +参数
key为需要获取的键名。如果未传入 key，会尝试使用与当前路径匹配的 key。博客类型
const useBlogType: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogTypeData<T>> +参数
key为需要获取的键名。如果未传入 key，会尝试使用与当前路径匹配的 key。
详细的返回值如下:
interface Article<T extends Record<string, unknown> = Record<string, unknown>> {
+ /** 文章路径 */
+ path: string
+ /** 文章信息 */
+ info: T
+}
+
+interface BlogCategoryData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** 分类路径 */
+ path: string
+
+ /**
+ * 仅当当前路径和某个子项目匹配时可用
+ */
+ currentItems?: Article<T>[]
+
+ /** 分类映射 */
+ map: {
+ /** 当前分类下全局唯一的 key */
+ [key: string]: {
+ /** 对应键值的分类路径 */
+ path: string
+ /** 对应键值的项目 */
+ items: Article<T>[]
+ }
+ }
+}
+
+interface BlogTypeData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** 类别路径 */
+ path: string
+
+ /** 当前类别下的项目 */
+ items: Article<T>[]
+}
+配置
基础配置
hostname
类型：
string详情：
部署的域名，例如
https://example.com
locales
',5),D=s("li",null,[s("p",null,[l("类型： "),s("code",null,"{ [path: string]: PartialLocale 配置
该章节内的配置项可以作为一般配置使用，也可以使用在 locales 内。
colorMode
',3),f=s("li",null,[s("p",null,[l("类型： "),s("code",null,"'auto' | 'light' | 'dark'")])],-1),k=s("li",null,[s("p",null,[l("默认值： "),s("code",null,"'auto'")])],-1),x=s("p",null,"详情：",-1),F=s("p",null,"默认颜色模式。",-1),A=s("code",null,"'auto'",-1),L={href:"https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme",target:"_blank",rel:"noopener noreferrer"},R=s("li",null,[s("p",null,"参考："),s("ul",null,[s("li",null,[s("a",{href:"#colormodeswitch"},"默认主题 > 配置 > colorModeSwitch")])])],-1),w=s("h3",{id:"colormodeswitch",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#colormodeswitch"},[s("span",null,"colorModeSwitch")])],-1),S=e("类型： boolean
默认值： true
详情：
是否启用切换颜色模式的功能。
如果设置为 true ，将会在导航栏展示一个切换颜色模式的按钮。
home
类型：
string默认值：
/详情：
首页的路径。
它将被用于：
- 导航栏中 Logo 的链接
- 404 页面的 返回首页 链接
navbar
类型：
false | (NavbarItem | NavbarGroup | string)[]默认值：
[]详情：
导航栏配置。
设置为
false可以禁用导航栏。为了配置导航栏元素，你可以将其设置为 导航栏数组 ，其中的每个元素是
NavbarItem对象、NavbarGroup对象、或者字符串：NavbarItem对象应该有一个text字段和一个link字段，还有一个可选的activeMatch字段。NavbarGroup对象应该有一个text字段和一个children字段。children字段同样是一个 导航栏数组 。- 字符串应为目标页面文件的路径。它将会被转换为
NavbarItem对象，将页面标题作为text，将页面路由路径作为link。
示例 1：
export default {
+ theme: defaultTheme({
+ navbar: [
+ // NavbarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ },
+ // NavbarGroup
+ {
+ text: 'Group',
+ children: ['/group/foo.md', '/group/bar.md'],
+ },
+ // 字符串 - 页面文件路径
+ '/bar/README.md',
+ ],
+ }),
+}
+- 示例 2：
export default {
+ theme: defaultTheme({
+ navbar: [
+ // 嵌套 Group - 最大深度为 2
+ {
+ text: 'Group',
+ children: [
+ {
+ text: 'SubGroup',
+ children: ['/group/sub/foo.md', '/group/sub/bar.md'],
+ },
+ ],
+ },
+ // 控制元素何时被激活
+ {
+ text: 'Group 2',
+ children: [
+ {
+ text: 'Always active',
+ link: '/',
+ // 该元素将一直处于激活状态
+ activeMatch: '/',
+ },
+ {
+ text: 'Active on /foo/',
+ link: '/not-foo/',
+ // 该元素在当前路由路径是 /foo/ 开头时激活
+ // 支持正则表达式
+ activeMatch: '^/foo/',
+ },
+ ],
+ },
+ ],
+ }),
+}
+logo
类型：
null | string详情：
Logo 图片的 URL。
Logo 图片将会显示在导航栏的左端。
设置为
null可以禁用 Logo 。示例：
export default {
+ theme: defaultTheme({
+ // Public 文件路径
+ logo: '/images/hero.png',
+ // URL
+ logo: 'https://vuejs.org/images/logo.png',
+ }),
+}
+logoDark
类型：
null | string详情：
在夜间模式中使用的 Logo 图片的 URL。
如果你想在夜间模式中使用不同的 Logo 图片，就可以使用该配置项。
设置为
null可以在夜间模式下禁用 Logo 。忽略该配置项将会在夜间模式中使用 logo 配置。参考：
logoAlt
类型：
null | string详情：
指定 Logo 图片的替代文字。
当未指定时，将默认与站点标题相同。
repo
类型：
string详情：
项目仓库的 URL。
它将被用作 仓库链接 的链接。仓库链接 将会显示为导航栏的最后一个元素。
export default {
+ theme: defaultTheme({
+ // 如果你按照 \`organization/repository\` 的格式设置它
+ // 我们会将它作为一个 GitHub 仓库
+ repo: 'vuejs/vuepress',
+ // 你也可以直接将它设置为一个 URL
+ repo: 'https://gitlab.com/foo/bar',
+ }),
+}
+sidebar
`,8),I=s("li",null,[s("p",null,[l("类型： "),s("code",null,"false | 'auto' | SidebarConfigArray | SidebarConfigObject")])],-1),P=s("li",null,[s("p",null,[l("默认值： "),s("code",null,"'auto'")])],-1),T=s("p",null,"详情：",-1),U=s("p",null,"侧边栏配置。",-1),j=e("设置为 false 可以禁用侧边栏。
如果你设置为 'auto'，侧边栏会根据页面标题自动生成。
为了手动配置侧边栏元素，你可以将其设置为 侧边栏数组 ，其中的每个元素是一个 SidebarItem 对象或者一个字符串：
SidebarItem对象应该有一个text字段，有一个可选的link字段、一个可选的children字段和一个可选的collapsible字段。children字段同样是一个 侧边栏数组 。collapsible字段来控制它是否可折叠。- 字符串应为目标页面文件的路径。它将会被转换为
SidebarItem对象，将页面标题作为text，将页面路由路径作为link，并根据页面小标题自动生成children。
如果你想在不同子路径中使用不同的侧边栏，你可以将该配置项设置为 侧边栏对象 ：
- Key 为路径前缀。
- Value 为 侧边栏数组 或
"heading"以自动为相应路径生成基于标题的侧边栏。
export default {
+ theme: defaultTheme({
+ // 侧边栏数组
+ // 所有页面会使用相同的侧边栏
+ sidebar: [
+ // SidebarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ children: [
+ // SidebarItem
+ {
+ text: 'github',
+ link: 'https://github.com',
+ children: [],
+ },
+ // 字符串 - 页面文件路径
+ '/foo/bar.md',
+ ],
+ },
+ // 字符串 - 页面文件路径
+ '/bar/README.md',
+ ],
+ }),
+}
+- 示例 2：
export default {
+ theme: defaultTheme({
+ // 侧边栏对象
+ // 不同子路径下的页面会使用不同的侧边栏
+ sidebar: {
+ '/guide/': [
+ {
+ text: 'Guide',
+ children: ['/guide/introduction.md', '/guide/getting-started.md'],
+ },
+ ],
+ '/reference/': 'heading',
+ },
+ }),
+}
+- 示例 3：
export default {
+ theme: defaultTheme({
+ // 可折叠的侧边栏
+ sidebar: {
+ '/reference/': [
+ {
+ text: 'VuePress Reference',
+ collapsible: true,
+ children: ['/reference/cli.md', '/reference/config.md'],
+ },
+ {
+ text: 'Bundlers Reference',
+ collapsible: true,
+ children: [
+ '/reference/bundler/vite.md',
+ '/reference/bundler/webpack.md',
+ ],
+ },
+ ],
+ },
+ }),
+}
+sidebarDepth
`,6),q=s("li",null,[s("p",null,[l("类型： "),s("code",null,"number")])],-1),O=s("li",null,[s("p",null,[l("默认值： "),s("code",null,"2")])],-1),J=e("详情：
设置根据页面标题自动生成的侧边栏的最大深度。
- 设为
0来禁用所有级别的页面标题。 - 设为
1来包含<h2>标题。 - 设为
2来包含<h2>和<h3>标题。 - ...
editLinkPattern
类型：
string详情：
编辑此页 链接的 Pattern 。
它将会用于生成 编辑此页 的链接。
如果你不设置该选项，则会根据 docsRepo 配置项来推断 Pattern 。但是如果你的文档仓库没有托管在常用的平台上，比如 GitHub 、 GitLab 、 Bitbucket 、 Gitee 等，那么你必须设置该选项才能使 编辑此页 链接正常工作。
用法：
Pattern 描述 :repo文档仓库 URL ，即 docsRepo :branch文档仓库分支 ，即 docsBranch :path页面源文件的路径，即 docsDir 拼接上页面文件的相对路径 示例：
export default {
+ theme: defaultTheme({
+ docsRepo: 'https://gitlab.com/owner/name',
+ docsBranch: 'master',
+ docsDir: 'docs',
+ editLinkPattern: ':repo/-/edit/:branch/:path',
+ }),
+}
+则会生成类似于 'https://gitlab.com/owner/name/-/edit/master/docs/path/to/file.md' 的链接。
docsRepo
类型：
string详情：
文档源文件的仓库 URL 。
它将会用于生成 编辑此页 的链接。
如果你不设置该选项，则默认会使用 repo 配置项。但是如果你的文档源文件是在一个不同的仓库内，你就需要设置该配置项了。
docsBranch
类型：
string默认值：
'main'详情：
文档源文件的仓库分支。
它将会用于生成 编辑此页 的链接。
docsDir
类型：
string默认值：
''详情：
文档源文件存放在仓库中的目录名。
它将会用于生成 编辑此页 的链接。
lastUpdated
`,11),ls=s("li",null,[s("p",null,[l("类型： "),s("code",null,"boolean")])],-1),ns=s("li",null,[s("p",null,[l("默认值： "),s("code",null,"true")])],-1),es=s("p",null,"详情：",-1),as=s("p",null,[l("是否启用 "),s("em",null,"最近更新时间戳"),l(" 。")],-1),os=s("code",null,"false",-1),ps=s("h3",{id:"contributors",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#contributors"},[s("span",null,"contributors")])],-1),is=s("li",null,[s("p",null,[l("类型： "),s("code",null,"boolean")])],-1),cs=s("li",null,[s("p",null,[l("默认值： "),s("code",null,"true")])],-1),ts=s("p",null,"详情：",-1),rs=s("p",null,[l("是否启用 "),s("em",null,"贡献者列表"),l(" 。")],-1),ds=s("code",null,"false",-1);function us(Ds,vs){const p=i("ExternalLinkIcon"),a=i("RouteLink");return t(),r("div",null,[u,s("ul",null,[D,v,s("li",null,[h,m,b,s("p",null,[l("该配置项仅能在默认主题内生效，注意不要和 "),s("a",y,[l("站点配置"),n(p)]),l(" 中的 "),C,l(" 混淆。")])]),s("li",null,[g,s("ul",null,[s("li",null,[s("a",_,[l("指南 > 多语言支持"),n(p)])])])])]),E,s("ul",null,[f,k,s("li",null,[x,F,s("p",null,[l("如果设置为 "),A,l(" ，则会根据 "),s("a",L,[l("prefers-color-scheme"),n(p)]),l(" 自动设置初始颜色模式。")])]),R]),w,s("ul",null,[S,s("li",null,[z,s("ul",null,[N,s("li",null,[n(a,{to:"/zh/themes/default/locale.html#togglecolormode"},{default:o(()=>[l("默认主题 > 语言配置 > toggleColorMode")]),_:1})])])])]),G,s("ul",null,[s("li",null,[l("参考： "),s("ul",null,[s("li",null,[s("a",M,[l("指南 > 静态资源 > Public 文件"),n(p)])])])])]),B,s("ul",null,[I,P,s("li",null,[T,U,s("p",null,[l("你可以通过页面的 "),n(a,{to:"/zh/themes/default/frontmatter.html#sidebar"},{default:o(()=>[l("sidebar")]),_:1}),l(" frontmatter 来覆盖这个全局配置。")]),j]),V]),H,s("ul",null,[q,O,s("li",null,[J,s("p",null,[l("最大值取决于你通过 "),s("a",K,[l("markdown.headers.level"),n(p)]),l(" 提取了哪些级别的标题。")]),W,s("p",null,[l("你可以通过页面的 "),n(a,{to:"/zh/themes/default/frontmatter.html#sidebardepth"},{default:o(()=>[l("sidebarDepth")]),_:1}),l(" frontmatter 来覆盖这个全局配置。")])])]),Q,s("ul",null,[X,Y,s("li",null,[Z,$,s("p",null,[l("你可以通过页面的 "),n(a,{to:"/zh/themes/default/frontmatter.html#editlink"},{default:o(()=>[l("editLink")]),_:1}),l(" frontmatter 来覆盖这个全局配置。")])])]),ss,s("ul",null,[ls,ns,s("li",null,[es,as,s("p",null,[l("你可以通过页面的 "),n(a,{to:"/zh/themes/default/frontmatter.html#lastupdated"},{default:o(()=>[l("lastUpdated")]),_:1}),l(" frontmatter 来覆盖这个全局配置。要注意的是，如果你已经将该选项设为了 "),os,l(" ，那么这个功能会被完全禁用，并且无法在 locales 或页面 frontmatter 中启用。")])])]),ps,s("ul",null,[is,cs,s("li",null,[ts,rs,s("p",null,[l("你可以通过页面的 "),n(a,{to:"/zh/themes/default/frontmatter.html#contributors"},{default:o(()=>[l("contributors")]),_:1}),l(" frontmatter 来覆盖这个全局配置。要注意的是，如果你已经将该选项设为了 "),ds,l(" ，那么这个功能会被完全禁用，并且无法在 locales 或页面 frontmatter 中启用。")])])])])}const ms=c(d,[["render",us],["__file","config.html.vue"]]),bs=JSON.parse('{"path":"/zh/themes/default/config.html","title":"配置","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"基础配置","slug":"基础配置","link":"#基础配置","children":[{"level":3,"title":"hostname","slug":"hostname","link":"#hostname","children":[]},{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"Locale 配置","slug":"locale-配置","link":"#locale-配置","children":[{"level":3,"title":"colorMode","slug":"colormode","link":"#colormode","children":[]},{"level":3,"title":"colorModeSwitch","slug":"colormodeswitch","link":"#colormodeswitch","children":[]},{"level":3,"title":"home","slug":"home","link":"#home","children":[]},{"level":3,"title":"navbar","slug":"navbar","link":"#navbar","children":[]},{"level":3,"title":"logo","slug":"logo","link":"#logo","children":[]},{"level":3,"title":"logoDark","slug":"logodark","link":"#logodark","children":[]},{"level":3,"title":"logoAlt","slug":"logoalt","link":"#logoalt","children":[]},{"level":3,"title":"repo","slug":"repo","link":"#repo","children":[]},{"level":3,"title":"sidebar","slug":"sidebar","link":"#sidebar","children":[]},{"level":3,"title":"sidebarDepth","slug":"sidebardepth","link":"#sidebardepth","children":[]},{"level":3,"title":"editLink","slug":"editlink","link":"#editlink","children":[]},{"level":3,"title":"editLinkPattern","slug":"editlinkpattern","link":"#editlinkpattern","children":[]},{"level":3,"title":"docsRepo","slug":"docsrepo","link":"#docsrepo","children":[]},{"level":3,"title":"docsBranch","slug":"docsbranch","link":"#docsbranch","children":[]},{"level":3,"title":"docsDir","slug":"docsdir","link":"#docsdir","children":[]},{"level":3,"title":"lastUpdated","slug":"lastupdated","link":"#lastupdated","children":[]},{"level":3,"title":"contributors","slug":"contributors","link":"#contributors","children":[]}]}],"git":{"updatedTime":1706734148000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":7}]},"filePathRelative":"zh/themes/default/config.md"}');export{ms as comp,bs as data}; diff --git a/assets/config.html-CnRZcVx6.js b/assets/config.html-CnRZcVx6.js new file mode 100644 index 0000000000..8c5098aebd --- /dev/null +++ b/assets/config.html-CnRZcVx6.js @@ -0,0 +1,143 @@ +import{_ as o,r as t,o as i,c,b as s,a as e,w as a,d as n,e as p}from"./app-BcH8wZQx.js";const r={},d=p('Config
Plugin Options
getInfo
',3),u=s("li",null,[s("p",null,[n("Type: "),s("code",null,"(page: Page) => RecordmetaScope
Type:
stringDefault:
"_blog"Details:
Key used when injecting info to route meta.
TIP
Setting to an empty key will inject to route meta directly instead of a field.
hotReload
Type:
booleanDefault: Whether using
--debugflagDetails:
Whether enable hotReload in devServer.
To theme developers
It's disabled by default because it does have performance impact in sites with a lot of categories and types. And it can slow down hotReload speed when editing Markdown.
If users are adding or organizing your categories or tags, you may tell them to enable this, for the rest it's better to keep it disabled.
Also, you can try to detect number of pages in users project and decide whether to enable it.
Blog Category Config
Blog category config should be an array, while each item is controlling a "category" rule.
interface BlogCategoryOptions {
+ /**
+ * Unique category name
+ */
+ key: string
+
+ /**
+ * Function getting category from page
+ */
+ getter: (page: Page) => string[]
+
+ /**
+ * A custom function to sort the pages
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * Path pattern of page to be registered
+ *
+ * @description \`:key\` will be replaced by the "slugify" result of the original key
+ *
+ * @default \`/:key/\`
+ */
+ path?: string
+
+ /**
+ * Page layout name
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Frontmatter
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+
+ /**
+ * Item page path pattern or custom function to be registered
+ *
+ * @description When filling in a string, \`:key\` and \`:name\` will be replaced by the "slugify" result of the original key and name
+ *
+ * @default \`/:key/:name/\`
+ */
+ itemPath?: string | ((name: string) => string)
+
+ /**
+ * Item page layout name
+ *
+ * @default 'Layout'
+ */
+ itemLayout?: string
+
+ /**
+ * Items Frontmatter
+ */
+ itemFrontmatter?: (name: string, localePath: string) => Record<string, string>
+}
+Blog Type Config
Blog type config should be an array, while each item is controlling a "type" rule.
interface BlogTypeOptions {
+ /**
+ * Unique type name
+ */
+ key: string
+
+ /**
+ * A filter function to determine whether a page should be the type
+ */
+ filter: (page: Page) => boolean
+
+ /**
+ * A custom function to sort the pages
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * Page path to be registered
+ *
+ * @default '/:key/'
+ */
+ path?: string
+
+ /**
+ * Layout name
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Frontmatter
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+}
+Composition API
You can import the following API from @vuepress/plugin-blog/client.
Blog category
const useBlogCategory: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogCategoryData<T>> +Argument
keyshould be the category unique key.If no key is passed, the plugin will try to use the key in current path.
Blog category
const useBlogType: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogTypeData<T>> +Argument
keyshould be the type unique key.If no key is passed, the plugin will try to use the key in current path.
Returning values are:
interface Article<T extends Record<string, unknown> = Record<string, unknown>> {
+ /** Article path */
+ path: string
+ /** Article info */
+ info: T
+}
+
+interface BlogCategoryData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** Category path */
+ path: string
+
+ /**
+ * Only available when current route matches an item path
+ */
+ currentItems?: Article<T>[]
+
+ /** Category map */
+ map: {
+ /** Unique key under current category */
+ [key: string]: {
+ /** Category path of the key */
+ path: string
+ /** Category items of the key */
+ items: Article<T>[]
+ }
+ }
+}
+
+interface BlogTypeData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** Type path */
+ path: string
+
+ /** Items under current type */
+ items: Article<T>[]
+}
+Config
Basic Config
hostname
Type:
stringDetails:
Hostname to be deployed, e.g.:
https://example.com
locales
',5),h=s("li",null,[s("p",null,[e("Type: "),s("code",null,"{ [path: string]: PartialLocale Config
Config of this section can be used as normal config, and can also be used in the locales option.
colorMode
',3),E=s("li",null,[s("p",null,[e("Type: "),s("code",null,"'auto' | 'light' | 'dark'")])],-1),_=s("li",null,[s("p",null,[e("Default: "),s("code",null,"'auto'")])],-1),k=s("p",null,"Details:",-1),x=s("p",null,"Default color mode.",-1),w=s("code",null,"'auto'",-1),A={href:"https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme",target:"_blank",rel:"noopener noreferrer"},F=s("li",null,[s("p",null,"Also see:"),s("ul",null,[s("li",null,[s("a",{href:"#colormodeswitch"},"Default Theme > Config > colorModeSwitch")])])],-1),T=s("h3",{id:"colormodeswitch",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#colormodeswitch"},[s("span",null,"colorModeSwitch")])],-1),S=n("Type: boolean
Default: true
Details:
Enable color mode switching or not.
If set to true, a button to switch color mode will be displayed in the navbar.
home
Type:
stringDefault:
/Details:
Specify the path of the homepage.
This will be used for:
- the logo link of the navbar
- the back to home link of the 404 page
navbar
Type:
false | (NavbarItem | NavbarGroup | string)[]Default:
[]Details:
Configuration of navbar.
Set to
falseto disable navbar.To configure the navbar items, you can set it to a navbar array, each item of which could be a
NavbarItemobject, aNavbarGroupobject, or a string:- A
NavbarItemobject should have atextfield and alinkfield, could have an optionalactiveMatchfield. - A
NavbarGroupobject should have atextfield and achildrenfield. Thechildrenfield should be a navbar array, too. - A string should be the path to the target page file. It will be converted to a
NavbarItemobject, using the page title astext, and the page route path aslink.
- A
Example 1:
export default {
+ theme: defaultTheme({
+ navbar: [
+ // NavbarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ },
+ // NavbarGroup
+ {
+ text: 'Group',
+ children: ['/group/foo.md', '/group/bar.md'],
+ },
+ // string - page file path
+ '/bar/README.md',
+ ],
+ }),
+}
+- Example 2:
export default {
+ theme: defaultTheme({
+ navbar: [
+ // nested group - max depth is 2
+ {
+ text: 'Group',
+ children: [
+ {
+ text: 'SubGroup',
+ children: ['/group/sub/foo.md', '/group/sub/bar.md'],
+ },
+ ],
+ },
+ // control when should the item be active
+ {
+ text: 'Group 2',
+ children: [
+ {
+ text: 'Always active',
+ link: '/',
+ // this item will always be active
+ activeMatch: '/',
+ },
+ {
+ text: 'Active on /foo/',
+ link: '/not-foo/',
+ // this item will be active when current route path starts with /foo/
+ // regular expression is supported
+ activeMatch: '^/foo/',
+ },
+ ],
+ },
+ ],
+ }),
+}
+logo
Type:
null | stringDetails:
Specify the url of logo image.
The logo image will be displayed at the left end of the navbar.
Set to
nullto disable logo.Example:
export default {
+ theme: defaultTheme({
+ // public file path
+ logo: '/hero.png',
+ // url
+ logo: 'https://vuejs.org/images/logo.png',
+ }),
+}
+logoDark
Type:
null | stringDetails:
Specify the url of logo image to be used in dark mode.
You can make use of this option if you want to use different logo config in dark mode.
Set to
nullto disable logo in dark mode. Omit this option to use logo in dark mode.Also see:
logoAlt
Type:
null | stringDetails:
Specify the alt text of the logo image.
If not specified, defaults to be the same as the site title.
repo
Type:
stringDetails:
Specify the repository url of your project.
This will be used as the link of the repository link, which will be displayed as the last item of the navbar.
export default {
+ theme: defaultTheme({
+ // If you set it in the form of \`organization/repository\`
+ // we will take it as a GitHub repo
+ repo: 'vuejs/vuepress',
+ // You can also set it to a URL directly
+ repo: 'https://gitlab.com/foo/bar',
+ }),
+}
+sidebar
`,8),M=s("li",null,[s("p",null,[e("Type: "),s("code",null,"false | 'auto' | SidebarConfigArray | SidebarConfigObject")])],-1),B=s("li",null,[s("p",null,[e("Default: "),s("code",null,"'auto'")])],-1),R=s("p",null,"Details:",-1),P=s("p",null,"Configuration of sidebar.",-1),U=n("Set to false to disable sidebar.
If you set it to 'auto', the sidebar will be automatically generated from the page headers.
To configure the sidebar items manually, you can set this option to a sidebar array, each item of which could be a SidebarItem object or a string:
- A
SidebarItemobject should have atextfield, could have an optionallinkfield, an optionalchildrenfield and an optionalcollapsiblefield. Thechildrenfield should be a sidebar array. Thecollapsiblefield controls whether the item is collapsible. - A string should be the path to the target page file. It will be converted to a
SidebarItemobject, whosetextis the page title,linkis the page route path, andchildrenis automatically generated from the page headers.
If you want to set different sidebar for different sub paths, you can set this option to a sidebar object:
- The key should be the path prefix.
- The value should be a sidebar array or set to
'heading'to automatically generate the sidebar from the page headers for just the corresponding path.
export default {
+ theme: defaultTheme({
+ // sidebar array
+ // all pages will use the same sidebar
+ sidebar: [
+ // SidebarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ children: [
+ // SidebarItem
+ {
+ text: 'github',
+ link: 'https://github.com',
+ children: [],
+ },
+ // string - page file path
+ '/foo/bar.md',
+ ],
+ },
+ // string - page file path
+ '/bar/README.md',
+ ],
+ }),
+}
+- Example 2:
export default {
+ theme: defaultTheme({
+ // sidebar object
+ // pages under different sub paths will use different sidebar
+ sidebar: {
+ '/guide/': [
+ {
+ text: 'Guide',
+ children: ['/guide/introduction.md', '/guide/getting-started.md'],
+ },
+ ],
+ '/reference/': 'heading',
+ },
+ }),
+}
+- Example 3:
export default {
+ theme: defaultTheme({
+ // collapsible sidebar
+ sidebar: {
+ '/reference/': [
+ {
+ text: 'VuePress Reference',
+ collapsible: true,
+ children: ['/reference/cli.md', '/reference/config.md'],
+ },
+ {
+ text: 'Bundlers Reference',
+ collapsible: true,
+ children: [
+ '/reference/bundler/vite.md',
+ '/reference/bundler/webpack.md',
+ ],
+ },
+ ],
+ },
+ }),
+}
+sidebarDepth
`,6),H=s("li",null,[s("p",null,[e("Type: "),s("code",null,"number")])],-1),O=s("li",null,[s("p",null,[e("Default: "),s("code",null,"2")])],-1),z=n("Details:
Set the maximum depth of the sidebar children which are automatically generated from the page headers.
- Set to
0to disable all levels of headers. - Set to
1to include<h2>headers. - Set to
2to include<h2>and<h3>headers. - ...
editLinkPattern
Type:
stringDetails:
Specify the pattern of the edit this page link.
This will be used for generating the edit this page link.
If you don't set this option, the pattern will be inferred from the docsRepo option. But if your documentation repository is not hosted on a common platform, for example, GitHub, GitLab, Bitbucket, Gitee, etc., you have to set this option explicitly to make the edit this page link work.
Usage:
Pattern Description :repoThe docs repo url, i.e. docsRepo :branchThe docs repo branch, i.e. docsBranch :pathThe path of the page source file, i.e. docsDir joins the relative path of the page file Example:
export default {
+ theme: defaultTheme({
+ docsRepo: 'https://gitlab.com/owner/name',
+ docsBranch: 'master',
+ docsDir: 'docs',
+ editLinkPattern: ':repo/-/edit/:branch/:path',
+ }),
+}
+The generated link will look like 'https://gitlab.com/owner/name/-/edit/master/docs/path/to/file.md'.
docsRepo
Type:
stringDetails:
Specify the repository url of your documentation source files.
This will be used for generating the edit this page link.
If you don't set this option, it will use the repo option by default. But if your documentation source files are in a different repository, you will need to set this option.
docsBranch
Type:
stringDefault:
'main'Details:
Specify the repository branch of your documentation source files.
This will be used for generating the edit this page link.
docsDir
Type:
stringDefault:
''Details:
Specify the directory of your documentation source files in the repository.
This will be used for generating the edit this page link.
lastUpdated
`,11),ss=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),es=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),ls=s("p",null,"Details:",-1),ns=s("p",null,[e("Enable the "),s("em",null,"last updated timestamp"),e(" or not.")],-1),as=s("code",null,"false",-1),os=s("h3",{id:"contributors",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#contributors"},[s("span",null,"contributors")])],-1),is=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),ts=s("li",null,[s("p",null,[e("Default: "),s("code",null,"true")])],-1),ps=s("p",null,"Details:",-1),cs=s("p",null,[e("Enable the "),s("em",null,"contributors list"),e(" or not.")],-1),rs=s("code",null,"false",-1);function ds(us,hs){const a=t("RouteLink"),i=t("ExternalLinkIcon");return c(),r("div",null,[u,s("ul",null,[h,D,s("li",null,[v,m,b,s("p",null,[e("This option will only take effect in default theme, so don't confuse with "),y,e(" in "),l(a,{to:"/themes/default/config.html#locales"},{default:o(()=>[e("Site Config")]),_:1}),e(".")])]),s("li",null,[f,s("ul",null,[s("li",null,[s("a",g,[e("Guide > I18n"),l(i)])])])])]),C,s("ul",null,[E,_,s("li",null,[k,x,s("p",null,[e("If set to "),w,e(", the initial color mode will be automatically set according to "),s("a",A,[e("prefers-color-scheme"),l(i)]),e(".")])]),F]),T,s("ul",null,[S,s("li",null,[I,s("ul",null,[j,s("li",null,[l(a,{to:"/themes/default/locale.html#togglecolormode"},{default:o(()=>[e("Default Theme > Locale Config > toggleColorMode")]),_:1})])])])]),L,s("ul",null,[s("li",null,[e("Also see: "),s("ul",null,[s("li",null,[s("a",N,[e("Guide > Assets > Public Files"),l(i)])])])])]),G,s("ul",null,[M,B,s("li",null,[R,P,s("p",null,[e("You can override this global option via "),l(a,{to:"/themes/default/frontmatter.html#sidebar"},{default:o(()=>[e("sidebar")]),_:1}),e(" frontmatter in your pages.")]),U]),Y]),V,s("ul",null,[H,O,s("li",null,[z,s("p",null,[e("The max value depends on which levels of headers you have extracted via "),s("a",J,[e("markdown.headers.level"),l(i)]),e(".")]),W,s("p",null,[e("You can override this global option via "),l(a,{to:"/themes/default/frontmatter.html#sidebardepth"},{default:o(()=>[e("sidebarDepth")]),_:1}),e(" frontmatter in your pages.")])])]),q,s("ul",null,[K,Q,s("li",null,[X,Z,s("p",null,[e("You can override this global option via "),l(a,{to:"/themes/default/frontmatter.html#editlink"},{default:o(()=>[e("editLink")]),_:1}),e(" frontmatter in your pages.")])])]),$,s("ul",null,[ss,es,s("li",null,[ls,ns,s("p",null,[e("You can override this global option via "),l(a,{to:"/themes/default/frontmatter.html#lastupdated"},{default:o(()=>[e("lastUpdated")]),_:1}),e(" frontmatter in your pages. Notice that if you have already set this option to "),as,e(", this feature will be disabled totally and could not be enabled in locales nor page frontmatter.")])])]),os,s("ul",null,[is,ts,s("li",null,[ps,cs,s("p",null,[e("You can override this global option via "),l(a,{to:"/themes/default/frontmatter.html#contributors"},{default:o(()=>[e("contributors")]),_:1}),e(" frontmatter in your pages. Notice that if you have already set this option to "),rs,e(", this feature will be disabled totally and could not be enabled in locales nor page frontmatter.")])])])])}const vs=p(d,[["render",ds],["__file","config.html.vue"]]),ms=JSON.parse('{"path":"/themes/default/config.html","title":"Config","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"Basic Config","slug":"basic-config","link":"#basic-config","children":[{"level":3,"title":"hostname","slug":"hostname","link":"#hostname","children":[]},{"level":3,"title":"locales","slug":"locales","link":"#locales","children":[]}]},{"level":2,"title":"Locale Config","slug":"locale-config","link":"#locale-config","children":[{"level":3,"title":"colorMode","slug":"colormode","link":"#colormode","children":[]},{"level":3,"title":"colorModeSwitch","slug":"colormodeswitch","link":"#colormodeswitch","children":[]},{"level":3,"title":"home","slug":"home","link":"#home","children":[]},{"level":3,"title":"navbar","slug":"navbar","link":"#navbar","children":[]},{"level":3,"title":"logo","slug":"logo","link":"#logo","children":[]},{"level":3,"title":"logoDark","slug":"logodark","link":"#logodark","children":[]},{"level":3,"title":"logoAlt","slug":"logoalt","link":"#logoalt","children":[]},{"level":3,"title":"repo","slug":"repo","link":"#repo","children":[]},{"level":3,"title":"sidebar","slug":"sidebar","link":"#sidebar","children":[]},{"level":3,"title":"sidebarDepth","slug":"sidebardepth","link":"#sidebardepth","children":[]},{"level":3,"title":"editLink","slug":"editlink","link":"#editlink","children":[]},{"level":3,"title":"editLinkPattern","slug":"editlinkpattern","link":"#editlinkpattern","children":[]},{"level":3,"title":"docsRepo","slug":"docsrepo","link":"#docsrepo","children":[]},{"level":3,"title":"docsBranch","slug":"docsbranch","link":"#docsbranch","children":[]},{"level":3,"title":"docsDir","slug":"docsdir","link":"#docsdir","children":[]},{"level":3,"title":"lastUpdated","slug":"lastupdated","link":"#lastupdated","children":[]},{"level":3,"title":"contributors","slug":"contributors","link":"#contributors","children":[]}]}],"git":{"updatedTime":1706734148000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":7}]},"filePathRelative":"themes/default/config.md"}');export{vs as comp,ms as data}; diff --git a/assets/config.html-DkR_CUc4.js b/assets/config.html-DkR_CUc4.js new file mode 100644 index 0000000000..e39cea48a4 --- /dev/null +++ b/assets/config.html-DkR_CUc4.js @@ -0,0 +1,45 @@ +import{_ as s,o as n,c as a,e as l}from"./app-BcH8wZQx.js";const e={},p=l(`选项
hostname
类型：
string必填：是
详情：
部署域名
author
类型：
Authortype AuthorName = string + +interface AuthorInfo { + /** + * 作者姓名 + */ + name: string + + /** + * 作者网站 + */ + url?: string + + /** + * 作者 Email + */ + email?: string +} + +type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[] +详情：
默认作者
autoDescription
类型：
boolean默认值：
true详情：
是否自动生成描述
canonical
类型：
string | ((page: Page) => string | null)详情：
首选链接
fallBackImage
类型：
string详情：
当找不到图片时的回退图片链接
restrictions
类型：
string详情：
内容的年龄分级，格式为
[int]+，如"13+"
twitterID
类型：
string详情：
你的 twitter 用户名
isArticle
类型：
(page: Page) => boolean详情：
你可以使用此选项判断一个页面是否是文章。
ogp
类型：
function ogp( + /** 插件推断的 OGP 信息 */ + ogp: SeoContent, + /** 页面对象 */ + page: Page, + /** VuePress App */ + app: App, +): SeoContent +详情：
自定义 OGP 生成器
你可以使用此选项来注入新的或覆盖掉默认生成的 OGP 标签。
jsonLd
类型：
function jsonLd( + /** 由插件推断出的 JSON-LD 对象 */ + jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema, + /** 页面对象 */ + page: Page, + /** VuePress App */ + app: App, +): ArticleSchema | BlogPostingSchema | WebPageSchema +详情：
自定义 JSON-LD 生成器
你可以使用此选项来注入新的或覆盖掉默认生成的 JSON-LD 标签。
customHead
类型：
function customHead( + /** head 标签配置 */ + head: HeadConfig[], + /** 页面对象 */ + page: Page, + /** VuePress App */ + app: App, +): void +详情：
你可以使用此选项来直接注入任意格式的标签到
<head>。
Plugin Config
hostname
- Type:
string - Required: Yes
The domain name of the deployment site.
atom
- Type:
boolean - Default:
false
Whether to output Atom syntax files.
json
- Type:
boolean - Default:
false
Whether output JSON syntax files.
rss
- Type:
boolean - Default:
false
Whether to output RSS syntax files.
image
- Type:
string
A large image/icon of the feed, probably used as banner.
icon
- Type:
string
A small icon of the feed, probably used as favicon.
count
- Type:
number - Default:
100
Set the maximum number of items in the feed. After all pages are sorted, the first count items will be intercepted.
If your site has a lot of articles, you may consider this option to reduce feed file size.
preservedElements
- Type:
(RegExp | string)[] | (tagName: string) => boolean
Custom element or component which should be preserved in feed.
By default, all unknown tags will be removed.
filter
Type:
(page: Page)=> booleanDefault:
;({ frontmatter, filePathRelative }: Page): boolean => + !( + frontmatter.home || + !filePathRelative || + frontmatter.article === false || + frontmatter.feed === false + ) +
A custom filter function, used to filter feed items.
sorter
Type:
(pageA: Page, pageB: Page)=> numberDefault:
// dateSorter is from @vuepress/helper +;(pageA: Page, pageB: Page): number => + dateSorter( + pageA.data.git?.createdTime + ? new Date(pageA.data.git?.createdTime) + : pageA.frontmatter.date, + pageB.data.git?.createdTime + ? new Date(pageB.data.git?.createdTime) + : pageB.frontmatter.date, + ) +
Custom sorter function for feed items.
The default sorting behavior is by file adding time coming from git (needs @vuepress/plugin-git).
TIP
You should enable @vuepress/plugin-git to get the newest created pages as feed items. Otherwise, the feed items will be sorted by the default order of pages in VuePress.
channel
channel option is used to config Feed Channels.
devServer
- Type:
boolean - Default:
false
Whether enabled in devServer.
TIP
For performance reasons, we do not provide hot reload. Reboot your devServer to sync your changes.
devHostname
- Type:
string - Default:
"http://localhost:${port}"
Hostname to use in devServer
atomOutputFilename
- Type:
string - Default:
"atom.xml"
Atom syntax output filename, relative to dest folder.
atomXslTemplate
- Type:
string - Default: Content of
@vuepress/plugin-feed/templates/atom.xsl
Atom xsl template file content.
atomXslFilename
- Type:
string - Default:
"atom.xsl"
Atom xsl filename, relative to dest folder.
jsonOutputFilename
- Type:
string - Default:
"feed.json"
JSON syntax output filename, relative to dest folder.
rssOutputFilename
- Type:
string - Default:
"rss.xml"
RSS syntax output filename, relative to dest folder.
rssXslTemplate
- Type:
string - Default: Content of
@vuepress/plugin-feed/templates/rss.xsl
RSS xsl template file content.
rssXslFilename
- Type:
string - Default:
"rss.xsl"
RSS syntax xsl filename, relative to dest folder.
getter
',29),h=e("div",{class:"custom-container tip"},[e("p",{class:"custom-container-title"},"The plugin has a built-in getter, only set this if you want full control of feed generation.")],-1),D=e("h2",{id:"locales",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#locales"},[e("span",null,"locales")])],-1),m=e("ul",null,[e("li",null,[s("Type: "),e("code",null,"Record配置
hostname
类型：
string必填：是
详情：
当前网站部署到的域名，插件需要此选项才能工作。
extraUrls
类型：
string[]详情：
需要额外包含的网址。
如果你有一些不包含在 VuePress 路由中的链接 (如: 存放在 public 文件夹下的页面或其他插件或工具直接生成的页面)，你可能需要设置此项。
示例：
['/about.html', '/api/']
excludePaths
类型：
string[]默认值：
['/404.html']详情：
不需要收录的页面路径，请以绝对路径开头。
默认情况下 VuePress 自动生成的所有路径 (除 404 页) 都会被添加进 Sitemap。
devServer
类型：
boolean默认值：
false详情：
是否在开发服务器中启用
提示
由于性能原因，我们不提供热更新。重启开发服务器以同步你的变更。
devHostname
类型：
string默认值：
"http://localhost:${port}"详情：
开发服务器使用的主机名
sitemapFilename
类型：
string默认值：
"sitemap.xml"详情：
输出的文件名，相对于输出目录。
sitemapXSLFilename
类型：
string默认值：
"sitemap.xsl"详情：
输出的 xsl 文件名，相对于输出目录。
sitemapXSLTemplate
类型：
string默认值：
"@vuepress-plugin/sitemap/templates/sitemap.xsl"详情：
用作模板的 XSL 文件内容
changefreq
',19),h=e("li",null,[e("p",null,[l("类型："),e("code",null,'"always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"')])],-1),m=e("li",null,[e("p",null,[l("默认值："),e("code",null,'"daily"')])],-1),u=e("p",null,"详情：",-1),f=i('priority
类型：
number默认值：
0.5详情：
页面优先级，范围
0至1。
modifyTimeGetter
类型：
(page: Page, app: App) => string详情：
最后修改事件的获得器，需要返回一个 ISO 字符形式的时间，默认会自动通过 Git 插件生成。
Config
hostname
Type:
stringRequired: Yes
Details:
The domain name where the current site is deployed, the plugin needs this option to work.
extraUrls
Type:
string[]Details:
Extra link to be included.
If you have some links not including in VuePress Router (normally in public directory or generated by other tools directly), you may need this option.
Example:
['/about.html', '/api/']
excludePaths
Type:
string[]Default:
['/404.html']Details:
Urls excluding from sitemap, starting with absolute path.
By default, all the urls generated by VuePress (excluding 404 page) will be added into sitemap.
devServer
Type:
booleanDefault:
falseDetails:
Whether enabled in devServer.
TIP
For performance reasons, we do not provide hot reload. Reboot your devServer to sync your changes.
devHostname
Type:
stringDefault:
"http://localhost:${port}"Details:
Hostname to use in devServer
sitemapFilename
Type:
stringDefault value:
"sitemap.xml"Details:
The output filename, relative to output directory.
sitemapXSLFilename
Type:
stringDefault value:
"sitemap.xsl"Details:
Output xsl filename, relative to dest folder.
sitemapXSLTemplate
Type:
stringDefault value:
"@vuepress/plugin-sitemap/templates/sitemap.xsl"Details:
XSL content used as template.
changefreq
',19),h=e("li",null,[e("p",null,[l("Type: "),e("code",null,'"always" | "hourly" | "daily" | "weekly" |"monthly" | "yearly" | "never"')])],-1),u=e("li",null,[e("p",null,[l("Default value: "),e("code",null,'"daily"')])],-1),m=e("p",null,"Details:",-1),f=t('priority
Type:
numberDefault:
0.5Details:
Page priority, from
0to1.
modifyTimeGetter
Type:
(page: Page, app: App) => stringDetails:
Last modify time getter. By default, the plugin will use the timestamp generated by git plugin.
插件配置
hostname
- 类型：
string - 必填：是
部署网站的域名。
atom
- 类型：
boolean - 默认值：
false
是否启用 Atom 格式输出。
json
- 类型：
boolean - 默认值：
false
是否启用 JSON 格式输出。
rss
- 类型：
boolean - 默认值：
false
是否启用 RSS 格式输出。
image
- 类型：
string
一个大的图片，用作 feed 展示。
icon
- 类型：
string
一个小的图标，显示在订阅列表中。
count
- 类型：
number - 默认值：
100
设置 feed 的最大项目数量。在所有页面排序好后，插件会截取前 count 个项目。
如果你的站点文章很多，你应该考虑设置这个选项以减少 feed 文件大小。
preservedElements
- 类型：
(RegExp | string)[] | (tagName：string) => boolean
应在 Feed 中保留的自定义元素或组件。
默认情况下，所有未知标签均会被移除。
filter
类型：
(page: Page)=> boolean默认值：
;({ frontmatter, filePathRelative }: Page): boolean => + !( + frontmatter.home || + !filePathRelative || + frontmatter.article === false || + frontmatter.feed === false + ) +
自定义的过滤函数，用于过滤哪些项目在 feed 中显示。
sorter
类型：
(pageA: Page, pageB: Page)=> number默认值：
// dateSorter 来源于 @vuepress/helper +;(pageA, pageB): number => + dateSorter( + pageA.data.git?.createdTime + ? new Date(pageA.data.git?.createdTime) + : pageA.frontmatter.date, + pageB.data.git?.createdTime + ? new Date(pageB.data.git?.createdTime) + : pageB.frontmatter.date, + ) +
Feed 项目的排序器。
默认的排序行为是通过 Git 的文件添加日期 (需要 @vuepress/plugin-git)。
提示
你应该启用 @vuepress/plugin-git 来获取最新创建的页面作为 feed 项目。否则，feed 项目将按照 VuePress 中页面的默认顺序排序。
channel
channel 选项用于配置 Feed 频道。
devServer
- 类型：
boolean - 默认值：
false
是否在开发服务器中启用
提示
由于性能原因，我们不提供热更新。重启开发服务器以同步你的变更。
devHostname
- 类型：
string - 默认值：
"http://localhost:${port}"
开发服务器使用的主机名
atomOutputFilename
- 类型：
string - 默认值：
"atom.xml"
Atom 格式输出路径，相对于输出路径。
atomXslTemplate
- 类型：
string - 默认值：
@vuepress/plugin-feed/templates/atom.xsl的内容
Atom xsl 模板文件没人陪美国
atomXslFilename
- 类型：
string - 默认值：
"atom.xsl"
Atom xsl 输出路径，相对于输出路径。
jsonOutputFilename
- 类型：
string - 默认值：
"feed.json"
JSON 格式输出路径，相对于输出路径。
rssOutputFilename
- 类型：
string - 默认值：
"rss.xml"
RSS 格式输出路径，相对于输出路径。
rssXslTemplate
- 类型：
string - 默认值：
@vuepress/plugin-feed/templates/rss.xsl的内容
RSS xsl 模板文件内容。
rssXslFilename
- 类型：
string - 默认值：
"rss.xsl"
RSS xsl 输出路径，相对于输出路径。
getter
',29),u=e("div",{class:"custom-container tip"},[e("p",{class:"custom-container-title"},"此插件内置了生成器，只有当你想完全控制 feed 生成时才需要设置此选项。")],-1),h=e("h2",{id:"locales",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#locales"},[e("span",null,"locales")])],-1),m=e("ul",null,[e("li",null,[s("类型："),e("code",null,"RecordConfig
Options
showInstall
- Type:
boolean - Default:
false - Details: Whether display install button when Service Worker is first registered successfully.
manifest
',5),d=e('Type: AppManifest
Details:
You can fill with an object which will be parsed to manifest.webmanifest.
TIP
Some options have their fallback if you don't set them.
- name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - short_name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - description:
siteConfig.description||siteConfig.locales['/'].description||"A site built with vuepress" - lang:
siteConfig.locales['/'].lang||"en-US" - start_url:
context.base - scope:
context.base - display:
"standalone" - theme_color:
"#46bd87" - background_color:
"#ffffff" - orientation:
"portrait-primary" - prefer_related_applications:
false
favicon
Type:
stringDetails:
Link of favicon.ico.
WARNING
We recommend you to set favicon for your site.
themeColor
Type:
stringDefault:
"#46bd87"Details:
Theme Color of the pwa.
cacheHTML
Type:
booleanDefault:
falseDetails:
Whether cache HTML files besides home page and 404 page.
cacheImage
Type:
booleanDefault:
falseDetails:
Whether cache pictures
maxSize
Type:
numberDefault:
2048Details:
Max size allowed to be cached, with KB unit
WARNING
This option has the highest priority, and any files exceeding this value will be excluded.
So if you generate very large HTML or JS files, please consider increasing this value, otherwise your PWA may not work normally in offline mode.
maxImageSize
Type:
numberDefault:
1024Details: Max picture size allowed to be cached, with KB unit
The value must not be greater than maxSize option
update
Type:
"disabled" | "available" | "hint" | "force"Default:
"available"Details: Control logic when new content is found.
"disabled": Do nothing even when new service worker is available. After new service work succeeds installing and starts waiting, it will control page and provide new content in next visit."available": Only display update popup when the new service worker is available"hint": Display a hint to let user choose to refresh immediatelyThis is helpful when you want users to see new docs immediately.
TIP
If users choose to refresh, the current service worker will be unregister, and request will start coming to web. Later the new service worker will start installing and control current page after installed.
"force": unregister current service worker immediately then refresh to get new contentDANGER
Although this ensures users are viewing the latest content, it may affect viewing experiences.
TIP
How docs are updated is controlled by a previous version, so the current option only effect next update from this version.
apple
Special settings for better supporting Safari, ignoring these options are safe.
apple.icon
- Type:
string - Details: Icon link used by Safari.
apple.statusBarColor
- Type:
"black" | "white" - Default:
"black" - Details: Status bar color for Safari
apple.maskIcon
- Type:
string - Details: Safari mask icon
msTile
Special settings for Microsoft tiles, ignoring these options are safe.
msTile.image
- Type:
string - Details: Tile image
msTile.color
- Type:
string - Default value:
themeColor - Details: Tile color
foundComponent
- Type:
string - Default:
"PwaFoundPopup" - Details: Path of custom hint popup component.
readyComponent
- Type:
string - Default:
"PwaReadyPopup" - Details: Path of custom update popup component.
appendBase
- Type:
boolean - Default:
false - Details: Whether append base to all absolute links in options.
generateSwConfig
',35),h=s("p",null,"Details:",-1),m=s("code",null,"workbox-build",-1),C={href:"https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build#.generateSW",target:"_blank",rel:"noopener noreferrer"},g=e(`locales
Type:
PwaPluginLocaleConfiginterface PwaPluginLocaleData { + /** + * Install button text + */ + install: string + + /** + * iOS install hint text + */ + iOSInstall: string + + /** + * Cancel button text + */ + cancel: string + + /** + * Close button text + */ + close: string + + /** + * Previous image text + */ + prevImage: string + + /** + * Next image text + */ + nextImage: string + + /** + * Install explain text + */ + explain: string + + /** + * Description label text + */ + desc: string + + /** + * Feature label text + */ + feature: string + + /** + * Update hint text + */ + hint: string + + /** + * Update available text + */ + update: string +} + +interface PwaPluginLocaleConfig { + [localePath: string]: PwaPluginLocaleData +} +Details: Locales config for pwa plugin.
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Composition API
usePwaEvent
`,5),b=s("p",null,"Details:",-1),f=s("p",null,"Returns the event emitter of this plugin.",-1),E={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},w=s("li",null,[s("p",null,"Example:")],-1),k=e(`import { usePwaEvent } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+ event.on('ready', (registration) => {
+ console.log('Service worker is active.')
+ })
+ },
+}
+Utilities
forceUpdate
Details:
Force update the page when an update is found.
Example:
import { forceUpdate } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ forceUpdate()
+ })
+ },
+}
+registerSW
Details:
Register service worker manually.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| serviceWorkerPath | string | Path of the service worker |
| hooks | object | Hooks of service worker |
| showStatus | boolean | Log service worker status in console |
interface Hooks {
+ registrationOptions?: RegistrationOptions
+ ready?: (registration: ServiceWorkerRegistration) => void
+ registered?: (registration: ServiceWorkerRegistration) => void
+ cached?: (registration: ServiceWorkerRegistration) => void
+ updated?: (registration: ServiceWorkerRegistration) => void
+ updatefound?: (registration: ServiceWorkerRegistration) => void
+ offline?: () => void
+ error?: (error: Error) => void
+}
+- Example:
import { registerSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ registerSW('/service-worker.js', {
+ ready(registration) {
+ console.log('Service worker is active.')
+ },
+ })
+ })
+ },
+}
+skipWaiting
Details:
Activate the waiting service worker.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| registration | ServiceWorkerRegistration | The registration of the service worker you want activate |
- Example:
import { usePwaEvent, skipWaiting } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+
+ event.on('updated', (registration) => {
+ console.log('The waiting service worker is available.')
+ // activate the waiting service worker
+ skipWaiting(registration)
+ })
+ },
+}
+unregisterSW
Details:
Unregister service worker manually.
Example:
import { unregisterSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ unregisterSW()
+ })
+ },
+}
+Styles
You can customize the style via CSS variables:
:root {
+ --pwa-z-index: 10;
+ --pwa-color: #2c3e50;
+ --pwa-bg-color: #ffffff;
+ --pwa-border-color: #3eaf7c;
+ --pwa-shadow-color: rgb(0 0 0 / 15%);
+ --pwa-btn-text-color: #ffffff;
+ --pwa-btn-bg-color: #3eaf7c;
+ --pwa-btn-hover-bg-color: #4abf8a;
+ --pwa-content-color: #333;
+ --pwa-content-light-color: #666;
+}
+使用方法
npm i -D @vuepress/plugin-container@next
+import { containerPlugin } from '@vuepress/plugin-container'
+
+export default {
+ plugins: [
+ containerPlugin({
+ // 配置项
+ }),
+ ],
+}
+容器语法
::: <type> [info]
+[content]
+:::
+type是必需的，应通过 type 配置项来指定。info是可选的，其默认值可以通过 locales 的defaultInfo配置项来指定。content可是任何合法的 Markdown 内容。
提示
该插件可以被多次使用，以便支持不同类型的容器。
配置项
type
`,9),m=s("li",null,[s("p",null,[n("类型： "),s("code",null,"string")])],-1),b=s("p",null,"详情：",-1),C=s("p",null,"容器的类型。",-1),E={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},f=s("code",null,"name",-1),g=o(`locales
类型：
Record<string, { defaultInfo: string }>详情：
容器在不同 locales 下的默认
info。如果没有指定该配置项，默认
info会使用大写的 type 。示例：
export default {
+ plugins: [
+ containerPlugin({
+ type: 'tip',
+ locales: {
+ '/': {
+ defaultInfo: 'TIP',
+ },
+ '/zh/': {
+ defaultInfo: '提示',
+ },
+ },
+ }),
+ ],
+}
+before
类型：
(info: string) => string默认值：
(info: string): string =>
+ \`<div class="custom-container \${type}">\${info ? \`<p class="custom-container-title">\${info}</p>\` : ''}\\n\`
+after
类型：
(info: string) => string默认值：
(): string => '</div>\\n'
+render
- 类型：
type MarkdownItContainerRenderFunction = (
+ tokens: Token[],
+ index: number,
+ options: any,
+ env: MarkdownEnv,
+ self: Renderer,
+) => string
+Usage
npm i -D @vuepress/plugin-container@next
+import { containerPlugin } from '@vuepress/plugin-container'
+
+export default {
+ plugins: [
+ containerPlugin({
+ // options
+ }),
+ ],
+}
+Container Syntax
::: <type> [info]
+[content]
+:::
+- The
typeis required and should be specified via type option. - The
infois optional, and the default value can be specified viadefaultInfoin locales option. - The
contentcan be any valid markdown content.
TIP
This plugin can be used multiple times to support different types of containers.
Options
type
`,9),v=n("li",null,[n("p",null,[s("Type: "),n("code",null,"string")])],-1),f=n("p",null,"Details:",-1),b=n("p",null,"The type of the container.",-1),C=n("code",null,"name",-1),g={href:"https://github.com/markdown-it/markdown-it-container#api",target:"_blank",rel:"noopener noreferrer"},k=o(`locales
Type:
Record<string, { defaultInfo: string }>Details:
The default
infoof the container in different locales.If this option is not specified, the default
infowill fallback to the uppercase of the type option.Example:
export default {
+ plugins: [
+ containerPlugin({
+ type: 'tip',
+ locales: {
+ '/': {
+ defaultInfo: 'TIP',
+ },
+ '/zh/': {
+ defaultInfo: '提示',
+ },
+ },
+ }),
+ ],
+}
+before
Type:
(info: string) => stringDefault:
(info: string): string =>
+ \`<div class="custom-container \${type}">\${info ? \`<p class="custom-container-title">\${info}</p>\` : ''}\\n\`
+Details:
A function to render the starting tag of the container.
The first param is the
infopart of container syntax.This option will not take effect if you don't specify the after option.
after
Type:
(info: string) => stringDefault:
(): string => '</div>\\n'
+Details:
A function to render the ending tag of the container.
The first param is the
infopart of container syntax.This option will not take effect if you don't specify the before option.
render
- Type:
type MarkdownItContainerRenderFunction = (
+ tokens: Token[],
+ index: number,
+ options: any,
+ env: MarkdownEnv,
+ self: Renderer,
+) => string
+This plugin will automatically add a copy button to the top right corner of each code block on PC devices.
The default selector matches @vuepress/theme-default, so you might need to change it when integrating your own theme.
Usage
npm i -D @vuepress/plugin-copy-code@next
+import { copyCodePlugin } from '@vuepress/plugin-copy-code'
+
+export default {
+ plugins: [
+ copyCodePlugin({
+ // options
+ }),
+ ],
+}
+Options
selector
Type:
string | string[]Default:
'.theme-default-content div[class*="language-"] pre'Details:
Code block selector
showInMobile
Type:
booleanDefault:
falseDetails:
Whether to display copy button on the mobile device
duration
Type:
numberDefault:
2000Details:
Hint display time, setting it to
0will disable the hint.
delay
Type:
numberDefault:
800Details:
The delay of registering copy code buttons, in ms.
If the theme you are using has a switching animation, it is recommended to configure this option to
Switch animation duration + 200.
locales
Type:
CopyCodePluginLocaleConfiginterface CopyCodePluginLocaleData { + /** + * Copy text + */ + copy: string + + /** + * Copied text + */ + copied: string +} + +interface CopyCodePluginLocaleConfig { + [localePath: string]: CopyCodePluginLocaleData +} +Required: No
Details:
Locales config for copy code plugin.
Example:
import { copyCodePlugin } from '@vuepress/plugin-copy-code' + +export default { + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + copyCodePlugin({ + locales: { + '/': { + // Override copy button label text + copy: 'Copy Codes from code block', + }, + + '/xx/': { + // Complete locale config for \`mm-NN\` language here + }, + }, + }), + ], +} +
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Styles
You can customize the icon of the copy button via CSS variables:
:root {
+ --code-copy-icon: url("copy-button.svg");
+ --code-copied-icon: url("copied-button.svg");
+ --copy-code-color: #9e9e9e;
+ --copy-code-hover: rgb(0 0 0 / 50%);
+}
+此插件会自动在 PC 设备上为每个代码块右上角添加复制按钮。
默认选择器匹配 @vuepress/theme-default，所以在你自己的主题中集成时可能需要调整它。
使用
npm i -D @vuepress/plugin-copy-code@next
+import { copyCodePlugin } from '@vuepress/plugin-copy-code'
+
+export default {
+ plugins: [
+ copyCodePlugin({
+ // options
+ }),
+ ],
+}
+选项
selector
类型：
string | string[]默认值：
'.theme-default-content div[class*="language-"] pre'详情:
代码块选择器
showInMobile
类型：
boolean默认值：
false详情:
是否展示在移动端
duration
类型：
number默认值：
2000详情:
提示消息显示时间，设置为
0会禁用提示。
delay
类型：
number默认值：
800详情:
注册复制按钮的延时，单位 ms。
如果你使用的主题有切换动画，建议配置此选项为
切换动画时长 + 200
locales
类型：
CopyCodePluginLocaleConfiginterface CopyCodePluginLocaleData { + /** + * 复制文字 + */ + copy: string + + /** + * 已复制文字 + */ + copied: string +} + +interface CopyCodePluginLocaleConfig { + [localePath: string]: CopyCodePluginLocaleData +} +必填：否
详情:
复制按钮插件的国际化配置。
示例：
import { copyCodePlugin } from '@vuepress/plugin-copy-code' + +export default { + locales: { + '/': { + // 这是一个支持的语言 + lang: 'zh-CN', + }, + '/xx/': { + // 这是一个没有收到插件支持的语言 + lang: 'mm-NN', + }, + }, + + plugins: [ + copyCodePlugin({ + locales: { + '/': { + // 覆盖复制按钮标签文字 + copy: '复制此段代码', + }, + + '/xx/': { + // 在这里完整设置 \`mm-NN\` 的多语言配置 + }, + }, + }), + ], +} +
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
样式
你可以通过 CSS 变量来自定义复制按钮的样式：
:root {
+ --code-copy-icon: url("copy-button.svg");
+ --code-copied-icon: url("copied-button.svg");
+ --copy-code-color: #9e9e9e;
+ --copy-code-hover: rgb(0 0 0 / 50%);
+}
+此插件可以在访问者从你的站点复制内容时，自动追加版权信息，也可以禁止站点的复制或者选择。
使用
npm i -D @vuepress/plugin-copyright@next
+import { copyrightPlugin } from '@vuepress/plugin-copyright'
+
+export default {
+ plugins: [
+ copyrightPlugin({
+ // options
+ }),
+ ],
+}
+启用版权信息
此插件默认全局禁用。你可以:
- 在特定页面的 frontmatter 中设置
copy: true手动开启。 - 在插件选项中设置
global: true让其全局生效，并在页面的 frontmatter 中设置copy: false禁用它。
处于不打扰用户的考虑，默认配置下仅当复制长度超过 100 时才会追加版权信息。如果你希望改变这个触发值，你可以插件选项中设置 triggerLength，或在页面 frontmatter 单独设置 copy.triggerLength。
你可以通过插件的 author 和 license 选项设置全局作者和协议信息。
如果文档的不同部分拥有不同的作者和协议，你可以通过 authorGetter 和 licenseGetter 传入一个使用当前页面对象作为参数的函数 (page: Page) => string 并通过它返回相应信息。
插件会默认通过模板从作者、协议和页面链接生成版权信息，并在复制时追加。如果你认为这不够灵活，你可以设置 copyrightGetter 返回一个完全由你自定义的版权信息，或返回 null 以使用默认模板。
禁用复制和选择
如果你希望禁止用户复制较长内容，你可以在插件选项中设置 maxLength 控制这个临界值，或在页面 frontmatter 单独设置 copy.maxLength。
- 如果你不希望用户复制你的整个站点或特定页面文字，你可以在插件选项中设置
disableCopy或在页面 frontmatter 中设置copy.disableCopy来禁用复制，后者具有更高优先级。 - 如果你不希望用户选择你的整个站点或特定页面文字，你可以在插件选项中设置
disableSelection或在页面 frontmatter 中设置copy.disableSelection来禁用文字选择。此选项具有更高优先级
选项
author
- 类型：
string - 详情：默认作者信息
license
- 类型：
string - 详情：默认协议信息
authorGetter
- 类型：
(page: Page) => string | null - 详情：作者信息获取器
licenseGetter
- 类型：
(page: Page) => string | null - 详情：协议信息获取器
copyrightGetter
- 类型：
(page: Page) => string | null - 详情：协议信息获取器
triggerLength
- 类型：
number - 默认值：
100 - 详情：触发附加版权的最小内容长度
maxLength
- 类型：
number - 默认值：
0 - 详情：允许复制的最大内容长度，
0意味着无限制。
global
- 类型：
boolean - 默认值：
false - 详情：是否全局启用
disableCopy
- 类型：
boolean - 默认值：
false - 详情：禁用复制
disableSelection
- 类型：
boolean - 默认值：
false - 详情：禁用选择
canonical
类型：
string详情：
首选部署位置。
例子
如果你在 https://myblog.com 和 https://blog.com/username/ 下部署相同的内容，你可能希望选择一个站点作为首选链接。
- 如果你倾向于使用第一个，你应该将
canonical设置为https://myblog.com - 如果你倾向于使用第二个，你应该将
canonical设置为https://blog.com/username/
这样，在另一个站点触发的版权信息也会指向你的首选站点。
locales
类型：
CopyrightPluginLocaleConfiginterface CopyrightPluginLocaleData { + /** + * 作者文字 + * + * @description \`:author\` 将会被作者替换 + */ + author: string + + /** + * 协议文字 + * + * @description \`:license\` 会被当前协议替换 + */ + license: string + + /** + * 链接文字 + * + * @description \`:link\` 会替换为当前页面链接 + */ + link: string +} + +interface CopyrightPluginLocaleConfig { + [localePath: string]: CopyrightPluginLocaleData +} +详情：版权插件的国际化配置。
示例：
import { copyrightPlugin } from '@vuepress/plugin-copyright' + +export default { + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + copyrightPlugin({ + locales: { + '/': { + // Override link text + link: 'Original posted at :link', + }, + + '/xx/': { + // Complete locale config for \`mm-NN\` language here + }, + }, + }), + ], +} +
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
Frontmatter
copy.triggerLength
- 类型：
number - 默认值：
100 - 详情： 触发附加版权的最小内容长度
copy.maxLength
- 类型：
number - 默认值：
0 - 详情： 允许复制的最大内容长度，
0意味着无限制。
copy.disableCopy
- 类型：
boolean - 默认值：
false - 详情：禁用复制
copy.disableSelection
- 类型：
boolean - 默认值：
false - 详情：禁用选择
This plugin can automatically append copyright information when visitors copy content from your site, and can also prohibit site copying or selection.
Usage
npm i -D @vuepress/plugin-copyright@next
+import { copyrightPlugin } from '@vuepress/plugin-copyright'
+
+export default {
+ plugins: [
+ copyrightPlugin({
+ // options
+ }),
+ ],
+}
+Enabling Copyright
This plugin is disabled globally by default, you can:
- Manually enable it by setting
copy: truein page frontmatter - Set
global: truein plugin options to enable it globally, and setcopy: falsein page frontmatter to disable it.
To avoid disturbing visitors, copyright information will be appended only when the copied content length is greater than 100. Set triggerLength in plugin options if you want to change this threshold, or via copy.triggerLength in page frontmatter.
You can set default author and license information via author and license in plugin options.
If your site have different authors and license in different pages, you can set authorGetter and licenseGetter with function (page: Page) => string that takes the current page object as parameter and returns the corresponding information.
The plugin will generate copyright information from author, license, and page link via template by default, and append it when copying. If you think that this is not flexible enough, you can set copyrightGetter option to return a completely customized information with Page object or return null to use the default template.
Disable Copy and Selection
If you want to prevent users copying long content, you can set maxLength in plugin options to customize this limit, or via copy.maxLength in page frontmatter.
- If you don't want users to copy your entire site or specific page text, you can set
disableCopyin plugin options orcopy.disableCopyin page frontmatter, the latter has higher priority. - If you don't want users to select your entire site or specific page text, you can set
disableSelectionin plugin options orcopy.disableSelectionin page frontmatter. This option has higher priority.
Options
author
- Type:
string - Details: Default author Information
license
- Type:
string - Details: Default license Information
authorGetter
- Type:
(page: Page) => string | null - Details: Author getter
licenseGetter
- Type:
(page: Page) => string | null - Details: License getter
copyrightGetter
- Type:
(page: Page) => string | null - Details: Copyright getter
triggerLength
- Type:
number - Default:
100 - Details: Min content length triggering copyright append
maxLength
- Type:
number - Default:
0 - Details: Max content length which allows to copy,
0means no limit.
global
- Type:
boolean - Default:
false - Details: Whether enable globally.
disableCopy
- Type:
boolean - Default:
false - Details: Disable copy
disableSelection
- Type:
boolean - Default:
false - Details: Disable selection
canonical
- Type:
string - Details: Canonical deploy location.
Example
If you are deploying same content under https://myblog.com and https://blog.com/username/, you may want to prefer one site as reference link.
- If you prefer the first one, you should set
canonicaltohttps://myblog.com - If you prefer the second one, you should set
canonicaltohttps://blog.com/username/
So copyright message triggered on another site also points to your preferred site.
locales
Type:
CopyrightPluginLocaleConfiginterface CopyrightPluginLocaleData { + /** + * Author text + * + * @description \`:author\` will be replaced by author + */ + author: string + + /** + * License text + * + * @description \`:license\` will be replaced by current license + */ + license: string + + /** + * Link text + * + * @description \`:link\` will be replaced by current page link + */ + link: string +} + +interface CopyrightPluginLocaleConfig { + [localePath: string]: CopyrightPluginLocaleData +} +Details: Locale config for copyright plugin.
Example:
import { copyrightPlugin } from '@vuepress/plugin-copyright' + +export default { + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + copyrightPlugin({ + locales: { + '/': { + // Override link text + link: 'Original posted at :link', + }, + + '/xx/': { + // Complete locale config for \`mm-NN\` language here + }, + }, + }), + ], +} +
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Frontmatter
copy.triggerLength
- Type:
number - Default:
100 - Details: Min content length triggering copyright append
copy.maxLength
- Type:
number - Default:
0 - Details: Max content length which allows to copy,
0means no limit.
copy.disableCopy
- Type:
boolean - Default:
false - Details: Disable copy
copy.disableSelection
- Type:
boolean - Default:
false - Details: Disable selection
TIP
Default theme will add DocSearch to the navbar once you configure this plugin correctly.
This plugin may not be used directly in other themes, so you'd better refer to the documentation of your theme for more details.
Usage
npm i -D @vuepress/plugin-docsearch@next
+import { docsearchPlugin } from '@vuepress/plugin-docsearch'
+
+export default {
+ plugins: [
+ docsearchPlugin({
+ // options
+ }),
+ ],
+}
+Get Search Index
`,5),v={href:"https://docsearch.algolia.com/apply/",target:"_blank",rel:"noopener noreferrer"},C=s("a",{href:"#apikey"},"apiKey",-1),b=s("a",{href:"#indexname"},"indexName",-1),m={href:"https://docsearch.algolia.com/docs/run-your-own/",target:"_blank",rel:"noopener noreferrer"},E=s("a",{href:"#appId"},"appId",-1),g=s("a",{href:"#apikey"},"apiKey",-1),_=s("a",{href:"#indexname"},"indexName",-1),A=e(`Official crawler config
new Crawler({
+ appId: 'YOUR_APP_ID',
+ apiKey: 'YOUR_API_KEY',
+ rateLimit: 8,
+ startUrls: [
+ // These are urls which algolia start to craw
+ // If your site is divided in to mutiple parts,
+ // you may want to set mutiple entry links
+ 'https://YOUR_WEBSITE_URL/',
+ ],
+ sitemaps: [
+ // if you are using sitemap plugins (e.g.: @vuepress-plugin/sitemap), you may provide one
+ 'https://YOUR_WEBSITE_URL/sitemap.xml',
+ ],
+ ignoreCanonicalTo: false,
+ exclusionPatterns: [
+ // You can use this to stop algolia crawing some paths
+ ],
+ discoveryPatterns: [
+ // These are urls which algolia looking for,
+ 'https://YOUR_WEBSITE_URL/**',
+ ],
+ // Crawler schedule, set it according to your docs update frequency
+ schedule: 'at 02:00 every 1 day',
+ actions: [
+ // you may have mutiple actions, especially when you are deploying mutiple docs under one domain
+ {
+ // name the index with name you like
+ indexName: 'YOUR_INDEX_NAME',
+ // paths where the index take effect
+ pathsToMatch: ['https://YOUR_WEBSITE_URL/**'],
+ // controls how algolia extracts records from your site
+ recordExtractor: ({ $, helpers }) => {
+ // options for @vuepress/theme-default
+ return helpers.docsearch({
+ recordProps: {
+ lvl0: {
+ selectors: '.sidebar-heading.active',
+ defaultValue: 'Documentation',
+ },
+ lvl1: '.theme-default-content h1',
+ lvl2: '.theme-default-content h2',
+ lvl3: '.theme-default-content h3',
+ lvl4: '.theme-default-content h4',
+ lvl5: '.theme-default-content h5',
+ lvl6: '.theme-default-content h6',
+ content: '.theme-default-content p, .theme-default-content li',
+ },
+ indexHeadings: true,
+ })
+ },
+ },
+ ],
+ initialIndexSettings: {
+ // controls how index are initialized
+ // only has effects before index are initialize
+ // you may need to delete your index and recraw after modification
+ YOUR_INDEX_NAME: {
+ attributesForFaceting: ['type', 'lang'],
+ attributesToRetrieve: ['hierarchy', 'content', 'anchor', 'url'],
+ attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'],
+ attributesToSnippet: ['content:10'],
+ camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'],
+ searchableAttributes: [
+ 'unordered(hierarchy_radio_camel.lvl0)',
+ 'unordered(hierarchy_radio.lvl0)',
+ 'unordered(hierarchy_radio_camel.lvl1)',
+ 'unordered(hierarchy_radio.lvl1)',
+ 'unordered(hierarchy_radio_camel.lvl2)',
+ 'unordered(hierarchy_radio.lvl2)',
+ 'unordered(hierarchy_radio_camel.lvl3)',
+ 'unordered(hierarchy_radio.lvl3)',
+ 'unordered(hierarchy_radio_camel.lvl4)',
+ 'unordered(hierarchy_radio.lvl4)',
+ 'unordered(hierarchy_radio_camel.lvl5)',
+ 'unordered(hierarchy_radio.lvl5)',
+ 'unordered(hierarchy_radio_camel.lvl6)',
+ 'unordered(hierarchy_radio.lvl6)',
+ 'unordered(hierarchy_camel.lvl0)',
+ 'unordered(hierarchy.lvl0)',
+ 'unordered(hierarchy_camel.lvl1)',
+ 'unordered(hierarchy.lvl1)',
+ 'unordered(hierarchy_camel.lvl2)',
+ 'unordered(hierarchy.lvl2)',
+ 'unordered(hierarchy_camel.lvl3)',
+ 'unordered(hierarchy.lvl3)',
+ 'unordered(hierarchy_camel.lvl4)',
+ 'unordered(hierarchy.lvl4)',
+ 'unordered(hierarchy_camel.lvl5)',
+ 'unordered(hierarchy.lvl5)',
+ 'unordered(hierarchy_camel.lvl6)',
+ 'unordered(hierarchy.lvl6)',
+ 'content',
+ ],
+ distinct: true,
+ attributeForDistinct: 'url',
+ customRanking: [
+ 'desc(weight.pageRank)',
+ 'desc(weight.level)',
+ 'asc(weight.position)',
+ ],
+ ranking: [
+ 'words',
+ 'filters',
+ 'typo',
+ 'attribute',
+ 'proximity',
+ 'exact',
+ 'custom',
+ ],
+ highlightPreTag: '<span class="algolia-docsearch-suggestion--highlight">',
+ highlightPostTag: '</span>',
+ minWordSizefor1Typo: 3,
+ minWordSizefor2Typos: 7,
+ allowTyposOnNumericTokens: false,
+ minProximity: 1,
+ ignorePlurals: true,
+ advancedSyntax: true,
+ attributeCriteriaComputedByMinProximity: true,
+ removeWordsIfNoResults: 'allOptional',
+ },
+ },
+})
+The above recordProps is the configuration used for the default theme. You can modify them according to the theme you are using.
Notice that the initialIndexSettings.YOUR_INDEX_NAME.attributesForFaceting fields must include 'lang' to make this plugin work properly.
locales
Type:
Record<string, DocsearchPluginOptions>Details:
Options of this plugin in different locales.
All other options of this plugin are acceptable in locale config.
Example:
export default {
+ plugins: [
+ docsearchPlugin({
+ appId: '<APP_ID>',
+ apiKey: '<API_KEY>',
+ indexName: '<INDEX_NAME>',
+ locales: {
+ '/': {
+ placeholder: 'Search Documentation',
+ translations: {
+ button: {
+ buttonText: 'Search Documentation',
+ },
+ },
+ },
+ '/zh/': {
+ placeholder: '搜索文档',
+ translations: {
+ button: {
+ buttonText: '搜索文档',
+ },
+ },
+ },
+ },
+ }),
+ ],
+}
+injectStyles
Type:
booleanDefault:
trueDetails:
Whether to inject the default styles of DocSearch or not.
If you think the default styles of DocSearch is not compatible with your site, you can try to override the default styles, or set this option to
falseto totally exclude the default styles.When this option is disabled, you need to import your own styles for DocSearch. Also notice that all styles customization in Styles section would be unavailable.
Styles
',3),ks={href:"https://docsearch.algolia.com/docs/styling",target:"_blank",rel:"noopener noreferrer"},ws=e(`:root {
+ --docsearch-primary-color: rgb(84, 104, 255);
+ --docsearch-text-color: rgb(28, 30, 33);
+ --docsearch-spacing: 12px;
+ --docsearch-icon-stroke-width: 1.4;
+ --docsearch-highlight-color: var(--docsearch-primary-color);
+ --docsearch-muted-color: rgb(150, 159, 175);
+ --docsearch-container-background: rgba(101, 108, 133, 0.8);
+ --docsearch-logo-color: rgba(84, 104, 255);
+
+ /* modal */
+ --docsearch-modal-width: 560px;
+ --docsearch-modal-height: 600px;
+ --docsearch-modal-background: rgb(245, 246, 247);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 rgba(255, 255, 255, 0.5), 0 3px
+ 8px 0 rgba(85, 90, 100, 1);
+
+ /* searchbox */
+ --docsearch-searchbox-height: 56px;
+ --docsearch-searchbox-background: rgb(235, 237, 240);
+ --docsearch-searchbox-focus-background: #fff;
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--docsearch-primary-color);
+
+ /* hit */
+ --docsearch-hit-height: 56px;
+ --docsearch-hit-color: rgb(68, 73, 80);
+ --docsearch-hit-active-color: #fff;
+ --docsearch-hit-background: #fff;
+ --docsearch-hit-shadow: 0 1px 3px 0 rgb(212, 217, 225);
+
+ /* key */
+ --docsearch-key-gradient: linear-gradient(
+ -225deg,
+ rgb(213, 219, 228) 0%,
+ rgb(248, 248, 248) 100%
+ );
+ --docsearch-key-shadow: inset 0 -2px 0 0 rgb(205, 205, 230), inset 0 0 1px 1px
+ #fff, 0 1px 2px 1px rgba(30, 35, 90, 0.4);
+
+ /* footer */
+ --docsearch-footer-height: 44px;
+ --docsearch-footer-background: #fff;
+ --docsearch-footer-shadow: 0 -1px 0 0 rgb(224, 227, 232), 0 -3px 6px 0 rgba(69, 98, 155, 0.12);
+}
+Components
Docsearch
Details:
This plugin will register a
<Docsearch />component globally, and you can use it without any props.Put this component to where you want to place the docsearch button. For example, default theme puts this component to the end of the navbar.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
提示
当你正确配置该插件后，默认主题会把 DocSearch 按钮添加到导航栏。
该插件不一定能在其他主题中直接使用，因此你应参考主题本身的文档来获取更多信息。
使用方法
npm i -D @vuepress/plugin-docsearch@next
+import { docsearchPlugin } from '@vuepress/plugin-docsearch'
+
+export default {
+ plugins: [
+ docsearchPlugin({
+ // 配置项
+ }),
+ ],
+}
+获取搜索索引
`,5),v={href:"https://docsearch.algolia.com/apply/",target:"_blank",rel:"noopener noreferrer"},C=s("a",{href:"#apikey"},"apiKey",-1),b=s("a",{href:"#indexname"},"indexName",-1),m={href:"https://docsearch.algolia.com/docs/run-your-own/",target:"_blank",rel:"noopener noreferrer"},E=s("a",{href:"#appId"},"appId",-1),_=s("a",{href:"#apikey"},"apiKey",-1),g=s("a",{href:"#indexname"},"indexName",-1),A=e(`官方爬虫配置示例
new Crawler({
+ appId: 'YOUR_APP_ID',
+ apiKey: 'YOUR_API_KEY',
+ rateLimit: 8,
+ startUrls: [
+ // 这是 Algolia 开始抓取网站的初始地址
+ // 如果你的网站被分为数个独立部分，你可能需要在此设置多个入口链接
+ 'https://YOUR_WEBSITE_URL/',
+ ],
+ sitemaps: [
+ // 如果你在使用 Sitemap 插件 (如: @vuepress-plugin/sitemap)，你可以提供 Sitemap 链接
+ 'https://YOUR_WEBSITE_URL/sitemap.xml',
+ ],
+ ignoreCanonicalTo: false,
+ exclusionPatterns: [
+ // 你可以通过它阻止 Algolia 抓取某些 URL
+ ],
+ discoveryPatterns: [
+ // 这是 Algolia 抓取 URL 的范围
+ 'https://YOUR_WEBSITE_URL/**',
+ ],
+ // 爬虫执行的计划时间，可根据文档更新频率设置
+ schedule: 'at 02:00 every 1 day',
+ actions: [
+ // 你可以拥有多个 action，特别是你在一个域名下部署多个文档时
+ {
+ // 使用适当的名称为索引命名
+ indexName: 'YOUR_INDEX_NAME',
+ // 索引生效的路径
+ pathsToMatch: ['https://YOUR_WEBSITE_URL/**'],
+ // 控制 Algolia 如何抓取你的站点
+ recordExtractor: ({ $, helpers }) => {
+ // @vuepress/theme-default 的选项
+ return helpers.docsearch({
+ recordProps: {
+ lvl0: {
+ selectors: '.sidebar-heading.active',
+ defaultValue: 'Documentation',
+ },
+ lvl1: '.theme-default-content h1',
+ lvl2: '.theme-default-content h2',
+ lvl3: '.theme-default-content h3',
+ lvl4: '.theme-default-content h4',
+ lvl5: '.theme-default-content h5',
+ lvl6: '.theme-default-content h6',
+ content: '.theme-default-content p, .theme-default-content li',
+ },
+ indexHeadings: true,
+ })
+ },
+ },
+ ],
+ initialIndexSettings: {
+ // 控制索引如何被初始化，这仅当索引尚未生成时有效
+ // 你可能需要在修改后手动删除并重新生成新的索引
+ YOUR_INDEX_NAME: {
+ attributesForFaceting: ['type', 'lang'],
+ attributesToRetrieve: ['hierarchy', 'content', 'anchor', 'url'],
+ attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'],
+ attributesToSnippet: ['content:10'],
+ camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'],
+ searchableAttributes: [
+ 'unordered(hierarchy_radio_camel.lvl0)',
+ 'unordered(hierarchy_radio.lvl0)',
+ 'unordered(hierarchy_radio_camel.lvl1)',
+ 'unordered(hierarchy_radio.lvl1)',
+ 'unordered(hierarchy_radio_camel.lvl2)',
+ 'unordered(hierarchy_radio.lvl2)',
+ 'unordered(hierarchy_radio_camel.lvl3)',
+ 'unordered(hierarchy_radio.lvl3)',
+ 'unordered(hierarchy_radio_camel.lvl4)',
+ 'unordered(hierarchy_radio.lvl4)',
+ 'unordered(hierarchy_radio_camel.lvl5)',
+ 'unordered(hierarchy_radio.lvl5)',
+ 'unordered(hierarchy_radio_camel.lvl6)',
+ 'unordered(hierarchy_radio.lvl6)',
+ 'unordered(hierarchy_camel.lvl0)',
+ 'unordered(hierarchy.lvl0)',
+ 'unordered(hierarchy_camel.lvl1)',
+ 'unordered(hierarchy.lvl1)',
+ 'unordered(hierarchy_camel.lvl2)',
+ 'unordered(hierarchy.lvl2)',
+ 'unordered(hierarchy_camel.lvl3)',
+ 'unordered(hierarchy.lvl3)',
+ 'unordered(hierarchy_camel.lvl4)',
+ 'unordered(hierarchy.lvl4)',
+ 'unordered(hierarchy_camel.lvl5)',
+ 'unordered(hierarchy.lvl5)',
+ 'unordered(hierarchy_camel.lvl6)',
+ 'unordered(hierarchy.lvl6)',
+ 'content',
+ ],
+ distinct: true,
+ attributeForDistinct: 'url',
+ customRanking: [
+ 'desc(weight.pageRank)',
+ 'desc(weight.level)',
+ 'asc(weight.position)',
+ ],
+ ranking: [
+ 'words',
+ 'filters',
+ 'typo',
+ 'attribute',
+ 'proximity',
+ 'exact',
+ 'custom',
+ ],
+ highlightPreTag: '<span class="algolia-docsearch-suggestion--highlight">',
+ highlightPostTag: '</span>',
+ minWordSizefor1Typo: 3,
+ minWordSizefor2Typos: 7,
+ allowTyposOnNumericTokens: false,
+ minProximity: 1,
+ ignorePlurals: true,
+ advancedSyntax: true,
+ attributeCriteriaComputedByMinProximity: true,
+ removeWordsIfNoResults: 'allOptional',
+ },
+ },
+})
+上述 recordProps 是用于默认主题的配置，你可以根据你使用的主题来修改它们。
注意 initialIndexSettings.YOUR_INDEX_NAME.attributesForFaceting 字段必须包含 'lang'，否则该插件将无法正常工作。
locales
类型：
Record<string, DocsearchPluginOptions>详情：
在不同 locales 下对该插件进行不同的配置。
该插件的所有其他选项都可以在 locale 中进行配置。
示例：
export default {
+ plugins: [
+ docsearchPlugin({
+ appId: '<APP_ID>',
+ apiKey: '<API_KEY>',
+ indexName: '<INDEX_NAME>',
+ locales: {
+ '/': {
+ placeholder: 'Search Documentation',
+ translations: {
+ button: {
+ buttonText: 'Search Documentation',
+ },
+ },
+ },
+ '/zh/': {
+ placeholder: '搜索文档',
+ translations: {
+ button: {
+ buttonText: '搜索文档',
+ },
+ },
+ },
+ },
+ }),
+ ],
+}
+injectStyles
类型：
boolean默认值：
true详情：
是否注入 DocSearch 的默认样式。
如果你认为 DocSearch 的默认样式和你的站点不兼容，你可以尝试覆盖默认样式，或者将该选项设置为
false来完全移除默认样式。当该选项被禁用时，你需要为 DocSearch 引入你自己的样式。同时要注意，你也无法再使用 样式 章节中提到的样式自定义能力。
样式
',3),ks={href:"https://docsearch.algolia.com/docs/styling",target:"_blank",rel:"noopener noreferrer"},Ss=e(`:root {
+ --docsearch-primary-color: rgb(84, 104, 255);
+ --docsearch-text-color: rgb(28, 30, 33);
+ --docsearch-spacing: 12px;
+ --docsearch-icon-stroke-width: 1.4;
+ --docsearch-highlight-color: var(--docsearch-primary-color);
+ --docsearch-muted-color: rgb(150, 159, 175);
+ --docsearch-container-background: rgba(101, 108, 133, 0.8);
+ --docsearch-logo-color: rgba(84, 104, 255);
+
+ /* modal */
+ --docsearch-modal-width: 560px;
+ --docsearch-modal-height: 600px;
+ --docsearch-modal-background: rgb(245, 246, 247);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 rgba(255, 255, 255, 0.5), 0 3px
+ 8px 0 rgba(85, 90, 100, 1);
+
+ /* searchbox */
+ --docsearch-searchbox-height: 56px;
+ --docsearch-searchbox-background: rgb(235, 237, 240);
+ --docsearch-searchbox-focus-background: #fff;
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--docsearch-primary-color);
+
+ /* hit */
+ --docsearch-hit-height: 56px;
+ --docsearch-hit-color: rgb(68, 73, 80);
+ --docsearch-hit-active-color: #fff;
+ --docsearch-hit-background: #fff;
+ --docsearch-hit-shadow: 0 1px 3px 0 rgb(212, 217, 225);
+
+ /* key */
+ --docsearch-key-gradient: linear-gradient(
+ -225deg,
+ rgb(213, 219, 228) 0%,
+ rgb(248, 248, 248) 100%
+ );
+ --docsearch-key-shadow: inset 0 -2px 0 0 rgb(205, 205, 230), inset 0 0 1px 1px
+ #fff, 0 1px 2px 1px rgba(30, 35, 90, 0.4);
+
+ /* footer */
+ --docsearch-footer-height: 44px;
+ --docsearch-footer-background: #fff;
+ --docsearch-footer-shadow: 0 -1px 0 0 rgb(224, 227, 232), 0 -3px 6px 0 rgba(69, 98, 155, 0.12);
+}
+组件
Docsearch
详情：
该插件会全局注册一个
<Docsearch />组件，你可以不传入任何 Props 来使用它。将该组件放置在你想要显示 docsearch 按钮的地方。例如，默认主题将这个组件放在了导航栏的末尾。
提示
该组件主要用于主题开发。在大多数情况下你不需要直接使用该组件。
继承
VuePress 默认主题有着大量的用户，因此我们对它进行了一些便于继承的设计，以便用户轻松进行定制化。
布局插槽
默认主题的 Layout 布局提供了一些插槽：
navbarnavbar-beforenavbar-aftersidebarsidebar-topsidebar-bottompagepage-toppage-bottompage-content-toppage-content-bottom
在它们的帮助下，你可以很容易地添加或替换内容。下面通过一个示例来介绍一下如何使用布局插槽来继承默认主题。
首先，创建一个客户端配置文件 .vuepress/client.ts ：
import { defineClientConfig } from 'vuepress/client'
+import Layout from './layouts/Layout.vue'
+
+export default defineClientConfig({
+ layouts: {
+ Layout,
+ },
+})
+接下来，创建 .vuepress/layouts/Layout.vue ，并使用由默认主题的 Layout 布局提供的插槽：
<script setup>
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+</script>
+
+<template>
+ <ParentLayout>
+ <template #page-bottom>
+ <div class="my-footer">This is my custom page footer</div>
+ </template>
+ </ParentLayout>
+</template>
+
+<style lang="css">
+.my-footer {
+ text-align: center;
+}
+</style>
+此时默认的 Layout 布局已经被你的本地布局覆盖，将会在除了首页外的所有页面添加一个自定义的页脚：
组件替换
布局插槽十分实用，但有时候你可能会觉得它不够灵活。默认主题同样提供了替换单个组件的能力。
',14),d={href:"https://github.com/vuepress/ecosystem/tree/main/themes/theme-default/src/client/components",target:"_blank",rel:"noopener noreferrer"},y=n("code",null,"@theme",-1),C={href:"https://v2.vuepress.vuejs.org/zh/reference/plugin-api.html#alias",target:"_blank",rel:"noopener noreferrer"},v=n("code",null,"HomeFooter.vue",-1),m=n("code",null,"@theme/HomeFooter.vue",-1),u=e(`接下来，如果你想要替换 HomeFooter.vue 组件，只需要在配置文件 .vuepress/config.ts 中覆盖这个别名即可：
import { defaultTheme } from '@vuepress/theme-default'
+import { getDirname, path } from 'vuepress/utils'
+import { defineUserConfig } from 'vuepress'
+
+const __dirname = getDirname(import.meta.url)
+
+export default defineUserConfig({
+ theme: defaultTheme(),
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+})
+开发一个子主题
除了在 .vuepress/config.ts 和 .vuepress/client.ts 中直接扩展默认主题以外，你可以通过继承默认主题来开发一个你自己的主题：
import { defaultTheme, type DefaultThemeOptions } from '@vuepress/theme-default'
+import type { Theme } from 'vuepress/core'
+import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export const childTheme = (options: DefaultThemeOptions): Theme => {
+ return {
+ name: 'vuepress-theme-child',
+ extends: defaultTheme(options),
+
+ // 在子主题的客户端配置文件中覆盖布局
+ // 注意，你在发布到 NPM 之前会将 TS 构建为 JS ，因此这里需要设置为 JS 文件的路径
+ clientConfigFile: path.resolve(__dirname, './client.js'),
+
+ // 覆盖组件别名
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+ }
+}
+Extending
VuePress default theme is widely used by users, so it is designed to be extendable, allowing users to make their own customization with ease.
Layout Slots
Default theme's Layout provides some slots:
navbarnavbar-beforenavbar-aftersidebarsidebar-topsidebar-bottompagepage-toppage-bottompage-content-toppage-content-bottom
With the help of them, you can add or replace content easily. Here comes an example to introduce how to extend default theme with layout slots.
Firstly, create a client config file .vuepress/client.ts:
import { defineClientConfig } from 'vuepress/client'
+import Layout from './layouts/Layout.vue'
+
+export default defineClientConfig({
+ layouts: {
+ Layout,
+ },
+})
+Next, create the .vuepress/layouts/Layout.vue, and make use of the slots that provided by the Layout of default theme:
<script setup>
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+</script>
+
+<template>
+ <ParentLayout>
+ <template #page-bottom>
+ <div class="my-footer">This is my custom page footer</div>
+ </template>
+ </ParentLayout>
+</template>
+
+<style lang="css">
+.my-footer {
+ text-align: center;
+}
+</style>
+Then the default Layout layout has been overridden by your own local layout, which will add a custom footer to every normal pages in default theme (excluding homepage):
Components Replacement
The layout slots are useful, but sometimes you might find it's not flexible enough. Default theme also provides the ability to replace a single component.
',14),D={href:"https://v2.vuepress.vuejs.org/plugin-api.html#alias",target:"_blank",rel:"noopener noreferrer"},y={href:"https://github.com/vuepress/ecosystem/tree/main/themes/theme-default/src/client/components",target:"_blank",rel:"noopener noreferrer"},m=n("code",null,"@theme",-1),u=n("code",null,"HomeFooter.vue",-1),v=n("code",null,"@theme/HomeFooter.vue",-1),C=l(`Then, if you want to replace the HomeFooter.vue component, just override the alias in your config file .vuepress/config.ts:
import { defaultTheme } from '@vuepress/theme-default'
+import { getDirname, path } from 'vuepress/utils'
+import { defineUserConfig } from 'vuepress'
+
+const __dirname = getDirname(import.meta.url)
+
+export default defineUserConfig({
+ theme: defaultTheme(),
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+})
+Developing a Child Theme
Instead of extending the default theme directly in .vuepress/config.ts and .vuepress/client.ts, you can also develop your own theme extending the default theme:
import { defaultTheme, type DefaultThemeOptions } from '@vuepress/theme-default'
+import type { Theme } from 'vuepress/core'
+import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export const childTheme = (options: DefaultThemeOptions): Theme => {
+ return {
+ name: 'vuepress-theme-child',
+ extends: defaultTheme(options),
+
+ // override layouts in child theme's client config file
+ // notice that you would build ts to js before publishing to npm,
+ // so this should be the path to the js file
+ clientConfigFile: path.resolve(__dirname, './client.js'),
+
+ // override component alias
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+ }
+}
+该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-external-link-icon@next
+import { externalLinkIconPlugin } from '@vuepress/plugin-external-link-icon'
+
+export default {
+ plugins: [
+ externalLinkIconPlugin({
+ // 配置项
+ }),
+ ],
+}
+选项
locales
类型：
Record<string, { openInNewWindow: string }>详情：
外部链接图标在不同 locales 下的 A11y 文字。
如果没有指定该配置项，它会降级使用默认文字。
示例：
export default {
+ plugins: [
+ externalLinkIconPlugin({
+ locales: {
+ '/': {
+ openInNewWindow: 'open in new window',
+ },
+ '/zh/': {
+ openInNewWindow: '在新窗口打开',
+ },
+ },
+ }),
+ ],
+}
+Frontmatter
externalLinkIcon
类型：
boolean详情：
是否在当前页面的外部链接的后面添加外部链接图标。
样式
你可以通过 CSS 变量来自定义外部链接图标的样式：
:root {
+ --external-link-icon-color: #aaa;
+}
+组件
ExternalLinkIcon
详情：
该插件会全局注册一个
<ExternalLinkIcon />组件，你可以不传入任何 Props 来使用它。
提示
该组件主要用于主题开发。在大多数情况下你不需要直接使用该组件。
This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-external-link-icon@next
+import { externalLinkIconPlugin } from '@vuepress/plugin-external-link-icon'
+
+export default {
+ plugins: [
+ externalLinkIconPlugin({
+ // options
+ }),
+ ],
+}
+Options
locales
Type:
Record<string, { openInNewWindow: string }>Details:
The a11y text of the external link icon in different locales.
If this option is not specified, it will fallback to default text.
Example:
export default {
+ plugins: [
+ externalLinkIconPlugin({
+ locales: {
+ '/': {
+ openInNewWindow: 'open in new window',
+ },
+ '/zh/': {
+ openInNewWindow: '在新窗口打开',
+ },
+ },
+ }),
+ ],
+}
+Frontmatter
externalLinkIcon
Type:
booleanDetails:
Whether to append an external link icon to external links in current page.
Styles
You can customize the style of the external link icon via CSS variables:
:root {
+ --external-link-icon-color: #aaa;
+}
+Components
ExternalLinkIcon
Details:
This plugin will register a
<ExternalLinkIcon />component globally, and you can use it without any props.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
Frontmatter
sitemap
Type:
SitemapFrontmatterOptions | falseDetails:
falsemeans exclude the page from sitemap.
sitemap.changefreq
',4),d=e("li",null,[e("p",null,[t("Type: "),e("code",null,'"always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"')])],-1),h=e("li",null,[e("p",null,[t("Default: "),e("code",null,'"daily"')])],-1),u=e("p",null,"Details:",-1),f=a('sitemap.priority
Type:
numberDefault:
0.5Details:
Page priority, range from
0to1.
Frontmatter 配置
你可以通过配置每个页面的 Frontmatter，来对每个 Feed 项目生成进行单独的控制。
添加与移除
默认情况下，所有文章均会被添加至 feed 流。如果你想在 feed 中移除特定页面，你可以在 frontmatter 中设置 feed: false。
读取的 Frontmatter 信息
title
- 类型：
string
由 VuePress 自动生成，默认为页面的 h1 内容
description
- 类型：
string
页面描述
date
- 类型：
Date
页面的发布日期
article
- 类型：
boolean
该页面是否是文章
如果此项设置为
false，则该页不会包含在最终的 feed 中。
copyright
- 类型：
string
页面版权信息
cover / image / banner
- 类型：
string
页面的封面/分享图，需为完整链接或绝对链接。
Frontmatter 选项
feed.title
- 类型：
string
Feed 项目的标题
feed.description
- 类型：
string
Feed 项目的描述
feed.content
- 类型：
string
Feed 项目的内容
feed.author
- 类型：
FeedAuthor[] | FeedAuthor
Feed 项目的作者
FeedAuthor 格式
interface FeedAuthor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.contributor
- 类型：
FeedContributor[] | FeedContributor
Feed 项目的贡献者
FeedContributor 格式
interface FeedContributor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.guid
- 类型：
string
Feed 项目的标识符，用于标识 Feed 项目。
你应该确保每个 Feed 项目有全局唯一的 guid。
pageClass
类型：
string详情：
为当前页面添加额外的类名。
示例：
---
+pageClass: custom-page-class
+---
+然后你可以在 .vuepress/styles/index.scss 文件中为这个页面添加自定义样式：
.theme-container.custom-page-class {
+ /* 页面样式 */
+}
+首页
本章节中的 Frontmatter 只会在首页中生效。
home
类型：
boolean详情：
设定该页面是首页还是普通页面。
如果你不设置该 Frontmatter 或将其设为
false，则该页面会是一个 普通页面示例：
--- +home: true +--- +
heroImage
`,5),L=i(`类型： string
详情：
首页图片的 URL 。
示例：
---
+# Public 文件路径
+heroImage: /images/hero.png
+# URL
+heroImage: https://vuejs.org/images/logo.png
+---
+heroAlt
类型：
string详情：
首页图片的
alt属性。如果不设置，则默认使用 heroText 。
heroHeight
',3),S=l("li",null,[l("p",null,[n("类型： "),l("code",null,"number")])],-1),H=l("li",null,[l("p",null,[n("默认值： "),l("code",null,"280")])],-1),V=l("p",null,"详情：",-1),T=l("p",null,[n("首页图片 "),l("code",null,"actions
- 类型：
Array<{
+ text: string
+ link: string
+ type?: 'primary' | 'secondary'
+}>
+详情：
配置首页按钮。
示例：
---
+actions:
+ - text: 快速上手
+ link: /zh/guide/getting-started.html
+ type: primary
+ - text: 项目简介
+ link: /zh/guide/introduction.html
+ type: secondary
+---
+features
- 类型：
Array<{
+ title: string
+ details: string
+}>
+详情：
配置首页特性列表。
示例：
---
+features:
+ - title: 简洁至上
+ details: 以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
+ - title: Vue 驱动
+ details: 享受 Vue 的开发体验，可以在 Markdown 中使用 Vue 组件，又可以使用 Vue 来开发自定义主题。
+ - title: 高性能
+ details: VuePress 会为每个页面预渲染生成静态的 HTML，同时，每个页面被加载的时候，将作为 SPA 运行。
+---
+footer
类型：
string详情：
首页的页脚。
footerHtml
类型：
boolean详情：
是否允许页脚中使用 HTML 。
如果设置为
true，那么 footer 会被作为 HTML 代码处理。
普通页面
本章节中的 Frontmatter 只会在普通页面中生效。
editLink
`,17),ll=l("li",null,[l("p",null,[n("类型： "),l("code",null,"boolean")])],-1),nl=l("li",null,[l("p",null,"详情："),l("p",null,[n("是否在本页面中启用 "),l("em",null,"编辑此页"),n(" 链接。")])],-1),sl=l("p",null,"参考：",-1),el=l("h3",{id:"editlinkpattern",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#editlinkpattern"},[l("span",null,"editLinkPattern")])],-1),al=l("li",null,[l("p",null,[n("类型： "),l("code",null,"string")])],-1),il=l("li",null,[l("p",null,"详情："),l("p",null,[n("本页面中 "),l("em",null,"编辑此页"),n(" 链接的 Pattern 。")])],-1),tl=l("p",null,"参考：",-1),ol=l("h3",{id:"lastupdated",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#lastupdated"},[l("span",null,"lastUpdated")])],-1),pl=l("li",null,[l("p",null,[n("类型： "),l("code",null,"boolean")])],-1),rl=l("li",null,[l("p",null,"详情："),l("p",null,[n("是否在本页面中启用 "),l("em",null,"最近更新时间戳"),n(" 。")])],-1),cl=l("p",null,"参考：",-1),dl=l("h3",{id:"contributors",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#contributors"},[l("span",null,"contributors")])],-1),ul=l("li",null,[l("p",null,[n("类型： "),l("code",null,"boolean")])],-1),hl=l("li",null,[l("p",null,"详情："),l("p",null,[n("是否在本页面中启用 "),l("em",null,"贡献者列表"),n(" 。")])],-1),Dl=l("p",null,"参考：",-1),vl=l("h3",{id:"sidebar",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#sidebar"},[l("span",null,"sidebar")])],-1),ml=l("li",null,[l("p",null,[n("类型： "),l("code",null,"false | 'auto' | SidebarConfigArray | SidebarConfigObject")])],-1),bl=l("li",null,[l("p",null,"详情："),l("p",null,"配置本页面的侧边栏。")],-1),_l=l("p",null,"参考：",-1),gl=l("h3",{id:"sidebardepth",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#sidebardepth"},[l("span",null,"sidebarDepth")])],-1),yl=l("li",null,[l("p",null,[n("类型： "),l("code",null,"number")])],-1),kl=l("li",null,[l("p",null,"详情："),l("p",null,"配置本页面的侧边栏深度。")],-1),fl=l("p",null,"参考：",-1),xl=i(`prev
类型：
NavLink | string详情：
上一个页面的链接。
如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。
为了手动配置上一页面的链接，你可以将其设置为一个
NavLink对象或者一个字符串：NavLink对象应该有一个text字段和一个link字段。- 字符串应为目标页面文件的路径。它将会被转换为
NavLink对象，将页面标题作为text，将页面路由路径作为link。
示例：
---
+# NavLink
+prev:
+ text: Get Started
+ link: /guide/getting-started.html
+
+# NavLink - 外部 URL
+prev:
+ text: GitHub
+ link: https://github.com
+
+# 字符串 - 页面文件路径
+prev: /guide/getting-started.md
+
+# 字符串 - 页面文件相对路径
+prev: ../../guide/getting-started.md
+---
+next
类型：
NavLink | string详情：
下一个页面的链接。
如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。
类型和 prev Frontmatter 相同。
pageClass
Type:
stringDetails:
Add extra class name to this page.
Example:
---
+pageClass: custom-page-class
+---
+Then you can customize styles of this page in .vuepress/styles/index.scss file:
.theme-container.custom-page-class {
+ /* page styles */
+}
+Home Page
Frontmatter in this section will only take effect in home pages.
home
Type:
booleanDetails:
Specify whether the page is homepage or a normal page.
If you don't set this frontmatter or set it to
false, the page would be a normal page.Example:
---
+home: true
+---
+heroImage
Type:
stringDetails:
Specify the url of the hero image.
Example:
---
+# public file path
+heroImage: /images/hero.png
+# url
+heroImage: https://vuejs.org/images/logo.png
+---
+heroAlt
Type:
stringDetails:
Specify the
altattribute of the hero image.This will fallback to the heroText.
heroHeight
',3),P=e("li",null,[e("p",null,[l("Type: "),e("code",null,"number")])],-1),F=e("li",null,[e("p",null,[l("Default: "),e("code",null,"280")])],-1),H=e("p",null,"Details:",-1),j=e("p",null,[l("Specify the "),e("code",null,"height"),l(" attribute of the hero "),e("code",null,"actions
- Type:
Array<{
+ text: string
+ link: string
+ type?: 'primary' | 'secondary'
+}>
+Details:
Configuration of the action buttons.
Example:
---
+actions:
+ - text: Get Started
+ link: /guide/getting-started.html
+ type: primary
+ - text: Introduction
+ link: /guide/introduction.html
+ type: secondary
+---
+features
- Type:
Array<{
+ title: string
+ details: string
+}>
+Details:
Configuration of the features list.
Example:
---
+features:
+ - title: Simplicity First
+ details: Minimal setup with markdown-centered project structure helps you focus on writing.
+ - title: Vue-Powered
+ details: Enjoy the dev experience of Vue, use Vue components in markdown, and develop custom themes with Vue.
+ - title: Performant
+ details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
+---
+footer
Type:
stringDetails:
Specify the content of the footer.
footerHtml
Type:
booleanDetails:
Allow HTML in footer or not.
If you set it to
true, the footer will be treated as HTML code.
Normal Page
Frontmatter in this section will only take effect in normal pages.
editLink
`,17),Z=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),$=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Enable the "),e("em",null,"edit this page"),l(" link in this page or not.")])],-1),ee=e("p",null,"Also see:",-1),le=e("h3",{id:"editlinkpattern",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#editlinkpattern"},[e("span",null,"editLinkPattern")])],-1),se=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),ne=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Specify the pattern of the "),e("em",null,"edit this page"),l(" link of this page.")])],-1),ae=e("p",null,"Also see:",-1),te=e("h3",{id:"lastupdated",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#lastupdated"},[e("span",null,"lastUpdated")])],-1),ie=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),oe=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Enable the "),e("em",null,"last updated timestamp"),l(" in this page or not.")])],-1),pe=e("p",null,"Also see:",-1),re=e("h3",{id:"contributors",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#contributors"},[e("span",null,"contributors")])],-1),ce=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),de=e("li",null,[e("p",null,"Details:"),e("p",null,[l("Enable the "),e("em",null,"contributors list"),l(" in this page or not.")])],-1),ue=e("p",null,"Also see:",-1),he=e("h3",{id:"sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sidebar"},[e("span",null,"sidebar")])],-1),me=e("li",null,[e("p",null,[l("Type: "),e("code",null,"false | 'auto' | SidebarConfigArray | SidebarConfigObject")])],-1),De=e("li",null,[e("p",null,"Details:"),e("p",null,"Configure the sidebar of this page.")],-1),ge=e("p",null,"Also see:",-1),ve=e("h3",{id:"sidebardepth",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#sidebardepth"},[e("span",null,"sidebarDepth")])],-1),fe=e("li",null,[e("p",null,[l("Type: "),e("code",null,"number")])],-1),be=e("li",null,[e("p",null,"Details:"),e("p",null,"Configure the sidebar depth of this page.")],-1),ye=e("p",null,"Also see:",-1),_e=t(`prev
Type:
NavLink | stringDetails:
Specify the link of the previous page.
If you don't set this frontmatter, the link will be inferred from the sidebar config.
To configure the prev link manually, you can set this frontmatter to a
NavLinkobject or a string:- A
NavLinkobject should have atextfield and alinkfield. - A string should be the path to the target page file. It will be converted to a
NavLinkobject, whosetextis the page title, andlinkis the page route path.
- A
Example:
---
+# NavLink
+prev:
+ text: Get Started
+ link: /guide/getting-started.html
+
+# NavLink - external url
+prev:
+ text: GitHub
+ link: https://github.com
+
+# string - page file path
+prev: /guide/getting-started.md
+
+# string - page file relative path
+prev: ../../guide/getting-started.md
+---
+next
Type:
NavLink | stringDetails:
Specify the link of the next page.
If you don't set this frontmatter, the link will be inferred from the sidebar config.
The type is the same as prev frontmatter.
Frontmatter Config
You can control each feed item generation by setting page frontmatter.
Additions and Removals
By default, all articles are added to the feed stream. Set feed: false in frontmatter to remove a page from feed.
Frontmatter Information
title
- Type:
string
Automatically generated by VuePress, defaults to the h1 content of the page
description
- Type:
string
Description of the page
date
- Type:
Date
Date when the page was published
article
- Type:
boolean
Whether the page is an article
If this is set to
false, the page will not be included in the final feed.
copyright
- Type:
string
Page copyright information
cover / image / banner
- Type:
string
Image used as page cover , should be full link or absolute link.
Frontmatter Options
feed.title
- Type:
string
The title of the feed item
feed.description
- Type:
string
Description of the feed item
feed.content
- Type:
string
The content of the feed item
feed.author
- Type:
FeedAuthor[] | FeedAuthor
The author of the feed item
FeedAuthor format
interface FeedAuthor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.contributor
- Type:
FeedContributor[] | FeedContributor
Contributors to feed item
FeedContributor format
interface FeedContributor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.guid
- Type:
string
The identifier of feed item, used to identify the feed item.
You should ensure every feed has a unique guid.
Frontmatter
sitemap
类型：
SitemapFrontmatterOptions | false详情：
false表示将页面排除在 sitemap 之外。
sitemap.changefreq
',4),h=e("li",null,[e("p",null,[t("类型："),e("code",null,'"always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"')])],-1),d=e("li",null,[e("p",null,[t("默认值："),e("code",null,'"daily"')])],-1),u=e("p",null,"详情：",-1),f=a('sitemap.priority
类型：
number默认值：
0.5详情：
页面优先级，范围
0至1。
Feed Getter
You can take full control of feed items generation by setting getter in the plugin options.
getter.title
- Type:
(page: Page) => string
Item title getter
getter.link
- Type:
(page: Page) => string
Item link getter
getter.description
- Type:
(page: Page) => string | undefined
Item description getter
TIP
Due to Atom support HTML in summary, so you can return HTML content here if possible, but the content must start with mark html:.
getter.content
- Type:
(page: Page) => string
Item content getter
getter.author
- Type:
(page: Page) => FeedAuthor[]
Item author getter.
The getter should return an empty array when author information is missing.
FeedAuthor format
interface FeedAuthor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.category
- Type:
(page: Page) => FeedCategory[] | undefined
Item category getter.
FeedCategory format
interface FeedCategory {
+ /**
+ * Category Name
+ */
+ name: string
+
+ /**
+ * A string that identifies a categorization taxonomy
+ *
+ * @description rss format only
+ */
+ domain?: string
+
+ /**
+ * the categorization scheme via a URI
+ *
+ * @description atom format only
+ */
+ scheme?: string
+}
+getter.enclosure
- Type:
(page: Page) => FeedEnclosure | undefined
Item enclosure getter.
FeedEnclosure format
interface FeedEnclosure {
+ /**
+ * Enclosure link
+ */
+ url: string
+
+ /**
+ * what its type is
+ *
+ * @description should be a standard MIME Type, rss format only
+ */
+ Type: string
+
+ /**
+ * Size in bytes
+ *
+ * @description rss format only
+ */
+ length?: number
+}
+getter.publishDate
- Type:
(page: Page) => Date | undefined
Item release date getter
getter.lastUpdateDate
- Type:
(page: Page) => Date
Item last update date getter
getter.image
- Type:
(page: Page) => string
Item Image Getter
Ensure it's returning a full URL
getter.contributor
- Type:
(page: Page) => FeedContributor[]
Item Contributor Getter
The getter should return an empty array when contributor information is missing.
FeedContributor format
interface FeedContributor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.copyright
- Type:
(page: Page) => string | undefined
Item copyright getter
`,46),i=[t];function p(r,c){return n(),e("div",null,i)}const d=s(l,[["render",p],["__file","getter.html.vue"]]),u=JSON.parse('{"path":"/plugins/feed/getter.html","title":"Feed Getter","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"getter.title","slug":"getter-title","link":"#getter-title","children":[]},{"level":2,"title":"getter.link","slug":"getter-link","link":"#getter-link","children":[]},{"level":2,"title":"getter.description","slug":"getter-description","link":"#getter-description","children":[]},{"level":2,"title":"getter.content","slug":"getter-content","link":"#getter-content","children":[]},{"level":2,"title":"getter.author","slug":"getter-author","link":"#getter-author","children":[]},{"level":2,"title":"getter.category","slug":"getter-category","link":"#getter-category","children":[]},{"level":2,"title":"getter.enclosure","slug":"getter-enclosure","link":"#getter-enclosure","children":[]},{"level":2,"title":"getter.publishDate","slug":"getter-publishdate","link":"#getter-publishdate","children":[]},{"level":2,"title":"getter.lastUpdateDate","slug":"getter-lastupdatedate","link":"#getter-lastupdatedate","children":[]},{"level":2,"title":"getter.image","slug":"getter-image","link":"#getter-image","children":[]},{"level":2,"title":"getter.contributor","slug":"getter-contributor","link":"#getter-contributor","children":[]},{"level":2,"title":"getter.copyright","slug":"getter-copyright","link":"#getter-copyright","children":[]}],"git":{"updatedTime":1706762763000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":2}]},"filePathRelative":"plugins/feed/getter.md"}');export{d as comp,u as data}; diff --git a/assets/getter.html-COH5xBAr.js b/assets/getter.html-COH5xBAr.js new file mode 100644 index 0000000000..93a0bbce25 --- /dev/null +++ b/assets/getter.html-COH5xBAr.js @@ -0,0 +1,91 @@ +import{_ as s,o as n,c as e,e as a}from"./app-BcH8wZQx.js";const l={},i=a(`Feed 获取器
你可以通过控制插件选项中的 getter 来完全控制 Feed 项目的生成。
getter.title
- 类型：
(page: Page) => string
项目标题获取器
getter.link
- 类型：
(page: Page) => string
项目链接获取器
getter.description
- 类型：
(page: Page) => string | undefined
项目描述获取器
提示
因为 Atom 在摘要中支持 HTML，所以如果可能的话，你可以在这里返回 HTML 内容，但内容必须以标记 html: 开头。
getter.content
- 类型：
(page: Page) => string
项目内容获取器
getter.author
- 类型：
(page: Page) => FeedAuthor[]
项目作者获取器。
获取器应在作者信息缺失时返回空数组。
FeedAuthor 格式
interface FeedAuthor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.category
- 类型：
(page: Page) => FeedCategory[] | undefined
项目分类获取器。
FeedCategory 格式
interface FeedCategory {
+ /**
+ * 分类名称
+ */
+ name: string
+
+ /**
+ * 标识分类法的字符串
+ *
+ * @description rss format only
+ */
+ domain?: string
+
+ /**
+ * URI 标识的分类 scheme
+ *
+ * @description atom format only
+ */
+ scheme?: string
+}
+getter.enclosure
- 类型：
(page: Page) => FeedEnclosure | undefined
项目附件获取器。
FeedEnclosure 格式
interface FeedEnclosure {
+ /**
+ * Enclosure 地址
+ */
+ url: string
+
+ /**
+ * 类型
+ *
+ * @description 应为一个标准的 MIME 类型，rss format only
+ */
+ type: string
+
+ /**
+ * 按照字节数计算的大小
+ *
+ * @description rss format only
+ */
+ length?: number
+}
+getter.publishDate
- 类型：
(page: Page) => Date | undefined
项目发布日期获取器
getter.lastUpdateDate
- 类型：
(page: Page) => Date
项目最后更新日期获取器
getter.image
- 类型：
(page: Page) => string
项目图片获取器
确保返回一个完整的 URL。
getter.contributor
- 类型：
(page: Page) => FeedContributor[]
项目贡献者获取器
获取器应在贡献者信息缺失时返回空数组。
FeedContributor 格式
interface FeedContributor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.copyright
- 类型：
(page: Page) => string | undefined
项目版权获取器
`,46),t=[i];function p(r,c){return n(),e("div",null,t)}const d=s(l,[["render",p],["__file","getter.html.vue"]]),u=JSON.parse('{"path":"/zh/plugins/feed/getter.html","title":"Feed 获取器","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"getter.title","slug":"getter-title","link":"#getter-title","children":[]},{"level":2,"title":"getter.link","slug":"getter-link","link":"#getter-link","children":[]},{"level":2,"title":"getter.description","slug":"getter-description","link":"#getter-description","children":[]},{"level":2,"title":"getter.content","slug":"getter-content","link":"#getter-content","children":[]},{"level":2,"title":"getter.author","slug":"getter-author","link":"#getter-author","children":[]},{"level":2,"title":"getter.category","slug":"getter-category","link":"#getter-category","children":[]},{"level":2,"title":"getter.enclosure","slug":"getter-enclosure","link":"#getter-enclosure","children":[]},{"level":2,"title":"getter.publishDate","slug":"getter-publishdate","link":"#getter-publishdate","children":[]},{"level":2,"title":"getter.lastUpdateDate","slug":"getter-lastupdatedate","link":"#getter-lastupdatedate","children":[]},{"level":2,"title":"getter.image","slug":"getter-image","link":"#getter-image","children":[]},{"level":2,"title":"getter.contributor","slug":"getter-contributor","link":"#getter-contributor","children":[]},{"level":2,"title":"getter.copyright","slug":"getter-copyright","link":"#getter-copyright","children":[]}],"git":{"updatedTime":1706762763000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":2}]},"filePathRelative":"zh/plugins/feed/getter.md"}');export{d as comp,u as data}; diff --git a/assets/git.html-D5W-c3Ut.js b/assets/git.html-D5W-c3Ut.js new file mode 100644 index 0000000000..86e9e3aedb --- /dev/null +++ b/assets/git.html-D5W-c3Ut.js @@ -0,0 +1,30 @@ +import{_ as r,r as n,o as c,c as d,a,b as s,d as e,w as i,e as o}from"./app-BcH8wZQx.js";const u={},h=s("h1",{id:"git",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#git"},[s("span",null,"git")])],-1),m=s("p",null,"This plugin will collect git information of your pages, including the created and updated time, the contributors, etc.",-1),g=o(`This plugin is mainly used to develop themes. You won't need to use it directly in most cases.
Usage
npm i -D @vuepress/plugin-git@next
+import { gitPlugin } from '@vuepress/plugin-git'
+
+export default {
+ plugins: [
+ gitPlugin({
+ // options
+ }),
+ ],
+}
+Git Repository
`,5),D={href:"https://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository",target:"_blank",rel:"noopener noreferrer"},y={href:"https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt",target:"_blank",rel:"noopener noreferrer"},v=o(`WARNING
This plugin will significantly slow down the speed of data preparation, especially when you have a lot of pages. You can consider disabling this plugin in dev mode to get better development experience.
Options
createdTime
Type:
booleanDefault:
trueDetails:
Whether to collect page created time or not.
updatedTime
Type:
booleanDefault:
trueDetails:
Whether to collect page updated time or not.
contributors
Type:
booleanDefault:
trueDetails:
Whether to collect page contributors or not.
Frontmatter
gitInclude
Type:
string[]Details:
An array of relative paths to be included when calculating page data.
Example:
---
+gitInclude:
+ - relative/path/to/file1
+ - relative/path/to/file2
+---
+Page Data
This plugin will add a git field to page data.
After using this plugin, you can get the collected git information in page data:
import type { GitPluginPageData } from '@vuepress/plugin-git'
+import { usePageData } from 'vuepress/client'
+
+export default {
+ setup() {
+ const page = usePageData<GitPluginPageData>()
+ console.log(page.value.git)
+ },
+}
+git.createdTime
Type:
numberDetails:
Unix timestamp in milliseconds of the first commit of the page.
This attribute would take the minimum of the first commit timestamps of the current page and the files listed in gitInclude.
git.updatedTime
Type:
numberDetails:
Unix timestamp in milliseconds of the last commit of the page.
This attribute would take the maximum of the last commit timestamps of the current page and the files listed in gitInclude.
git.contributors
- Type:
GitContributor[]
interface GitContributor {
+ name: string
+ email: string
+ commits: number
+}
+Details:
The contributors information of the page.
This attribute would also include contributors to the files listed in gitInclude.
该插件主要用于开发主题，大部分情况下你不需要直接使用它。
使用方法
npm i -D @vuepress/plugin-git@next
+import { gitPlugin } from '@vuepress/plugin-git'
+
+export default {
+ plugins: [
+ gitPlugin({
+ // 配置项
+ }),
+ ],
+}
+Git 仓库
`,5),g={href:"https://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository",target:"_blank",rel:"noopener noreferrer"},v={href:"https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt",target:"_blank",rel:"noopener noreferrer"},b=p(`注意
该插件会显著降低准备数据的速度，特别是在你的页面数量很多的时候。你可以考虑在 dev 模式下禁用该插件来获取更好的开发体验。
配置项
createdTime
类型：
boolean默认值：
true详情：
是否收集页面的创建时间。
updatedTime
类型：
boolean默认值：
true详情：
是否收集页面的更新时间。
contributors
类型：
boolean默认值：
true详情：
是否收集页面的贡献者。
Frontmatter
gitInclude
类型：
string[]详情：
文件相对路径组成的数组，该数组中的文件会在计算页面数据时被包含在内。
示例：
---
+gitInclude:
+ - relative/path/to/file1
+ - relative/path/to/file2
+---
+页面数据
该插件会向页面数据中添加一个 git 字段。
在使用该插件后，可以在页面数据中获取该插件收集到的 Git 信息：
import type { GitPluginPageData } from '@vuepress/plugin-git'
+import { usePageData } from 'vuepress/client'
+
+export default {
+ setup() {
+ const page = usePageData<GitPluginPageData>()
+ console.log(page.value.git)
+ },
+}
+git.createdTime
类型：
number详情：
页面第一次提交的 Unix 毫秒时间戳。
该属性将取当前页面及 gitInclude 中所列文件的第一次提交的时间戳的最小值。
git.updatedTime
类型：
number详情：
页面最后一次提交的 Unix 毫秒时间戳。
该属性将取当前页面及 gitInclude 中所列文件的最后一次提交的时间戳的最大值。
git.contributors
- 类型：
GitContributor[]
interface GitContributor {
+ name: string
+ email: string
+ commits: number
+}
+详情：
页面的贡献者信息。
该属性将会包含 gitInclude 所列文件的贡献者。
Usage
npm i -D @vuepress/plugin-google-analytics@next
+import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics'
+
+export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ // options
+ }),
+ ],
+}
+Reporting Events
`,4),v={href:"https://support.google.com/analytics/answer/9234069",target:"_blank",rel:"noopener noreferrer"},y=s("code",null,"page_view",-1),m=s("code",null,"first_visit",-1),_=s("p",null,[e("So if you only want to collect some basic data of your site, you don't need to do anything else except setting the "),s("a",{href:"#id"},"Measurement ID"),e(" correctly.")],-1),b=s("code",null,"gtag()",-1),f=s("code",null,"window",-1),C={href:"https://developers.google.com/analytics/devguides/collection/ga4/events",target:"_blank",rel:"noopener noreferrer"},k=s("h2",{id:"options",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#options"},[s("span",null,"Options")])],-1),E=s("h3",{id:"id",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#id"},[s("span",null,"id")])],-1),x=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string")])],-1),A=s("p",null,"Details:",-1),X=s("p",null,[e("The Measurement ID of Google Analytics 4, which should start with "),s("code",null,"'G-'"),e(".")],-1),w={href:"https://support.google.com/analytics/answer/9539598",target:"_blank",rel:"noopener noreferrer"},I=s("li",null,[s("p",null,"Example:")],-1),G=a(`export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ }),
+ ],
+}
+debug
`,2),N=s("li",null,[s("p",null,[e("Type: "),s("code",null,"boolean")])],-1),F=s("p",null,"Details:",-1),T=s("code",null,"true",-1),V={href:"https://support.google.com/analytics/answer/7201382",target:"_blank",rel:"noopener noreferrer"},P=s("li",null,[s("p",null,"Example:")],-1),S=a(`export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ debug: true,
+ }),
+ ],
+}
+使用方法
npm i -D @vuepress/plugin-google-analytics@next
+import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics'
+
+export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ // 配置项
+ }),
+ ],
+}
+上报事件
`,4),v={href:"https://support.google.com/analytics/answer/9234069",target:"_blank",rel:"noopener noreferrer"},y=s("code",null,"page_view",-1),_=s("code",null,"first_visit",-1),m=s("p",null,[n("因此，如果你只是想收集站点的一些基础数据，你只需要正确设置 "),s("a",{href:"#id"},"Measurement ID"),n(" ，不需要再额外做其他事情。")],-1),b=s("code",null,"gtag()",-1),C=s("code",null,"window",-1),f={href:"https://developers.google.com/analytics/devguides/collection/ga4/events",target:"_blank",rel:"noopener noreferrer"},k=s("h2",{id:"选项",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#选项"},[s("span",null,"选项")])],-1),E=s("h3",{id:"id",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#id"},[s("span",null,"id")])],-1),x=s("li",null,[s("p",null,[n("类型： "),s("code",null,"string")])],-1),A=s("p",null,"详情：",-1),X=s("p",null,[n("Google Analytics 4 的 Measurement ID ，应以 "),s("code",null,"'G-'"),n(" 开头。")],-1),w={href:"https://support.google.com/analytics/answer/9539598",target:"_blank",rel:"noopener noreferrer"},G=s("li",null,[s("p",null,"示例：")],-1),I=a(`export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ }),
+ ],
+}
+debug
`,2),N=s("li",null,[s("p",null,[n("类型： "),s("code",null,"boolean")])],-1),F=s("p",null,"详情：",-1),V=s("code",null,"true",-1),P={href:"https://support.google.com/analytics/answer/7201382",target:"_blank",rel:"noopener noreferrer"},B=s("li",null,[s("p",null,"示例：")],-1),M=a(`export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ debug: true,
+ }),
+ ],
+}
+With @vuepress/plugin-blog, you can easily bring blog feature into your theme.
Collecting Articles
The plugin filters all pages using filter option to drop pages you don't want.
By default, all pages generating from Markdown files but not homepage are considered as articles.
You can fully customize pages to collect through option filter, which accepts a function (page: Page) => boolean.
Gathering Info
You should set getInfo option with a function accepting Page as argument and returning an object containing the info you want.
The plugin will collect all the info you want and write them to routeMeta field of each page, so you will be able to get this information through Composition API later.
Demo
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ filter: ({ filePathRelative, frontmatter }) => {
+ // drop those pages which is NOT generated from file
+ if (!filePathRelative) return false
+
+ // drop those pages in \`archives\` directory
+ if (filePathRelative.startsWith('archives/')) return false
+
+ // drop those pages which do not use default layout
+ if (frontmatter.home || frontmatter.layout) return false
+
+ return true
+ },
+
+ getInfo: ({ frontmatter, git = {}, data = {} }) => {
+ // getting page info
+ const info: Record<string, any> = {
+ author: frontmatter.author || '',
+ categories: frontmatter.categories || [],
+ date: frontmatter.date || git.createdTime || null,
+ tags: frontmatter.tags || [],
+ excerpt: data.excerpt || '',
+ }
+
+ return info
+ },
+ }),
+ // other plugins ...
+ ],
+}
+Customizing Categories and Types
Basically, you would want 2 types of collection in your blog:
Category:
"Category" means grouping articles with their labels.
For example, each article may have their "categories" and "tags".
Type:
"Type" means identifying articles with conditions.
For example, you may want to describe some of your articles as diary.
After understanding description of these 2 types, you can set category and type options, each accepts an array, and each element represents a configuration.
Let's start with 2 examples here.
Imagine you are setting tags for each articles with tag field in page frontmatter. You want a tag mapping page in /tag/ with TagMap layout, and group each tag list with tagName in /tag/tagName with TagList layout, you probably need a configuration like this:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // other options ...
+ category: [
+ {
+ key: 'tag',
+ getter: ({ frontmatter }) => frontmatter.tag || [],
+ path: '/tag/',
+ layout: 'TagMap',
+ frontmatter: () => ({ title: 'Tag page' }),
+ itemPath: '/tag/:name/',
+ itemLayout: 'TagList',
+ itemFrontmatter: (name) => ({ title: \`Tag \${name}\` }),
+ },
+ ],
+ }),
+ // other plugins ...
+ ],
+}
+Also, you may want to star some of your articles, and display them to visitors. When you are setting star: true in frontmatter to mark them, you probably need a configuration like this to display them in /star/ path with StarList layout:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // other options ...
+ type: [
+ {
+ key: 'star',
+ filter: ({ frontmatter }) => frontmatter.star,
+ path: '/star/',
+ layout: 'StarList',
+ frontmatter: () => ({ title: 'Star page' }),
+ },
+ ],
+ }),
+ // other plugins ...
+ ],
+}
+Using Composition API in Client-side
When generating each page, the plugin will set following information under frontmatter.blog:
interface BlogFrontmatterOptions {
+ /** Current type of the page */
+ type: 'category' | 'type'
+ /** Unique key under current category or tag */
+ key: string
+ /**
+ * Current category name
+ *
+ * @description Only available in category item page
+ */
+ name?: string
+}
+So you can invoke useBlogCategory() and useBlogType() directly, and the result will be the category or type bind to current route.
Also, you can pass key you want as argument, then you will get information bind to that key.
So with node side settings above, you can get information about "tag" and "star" in client side:
TagMap layout:
<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+import { RouteLink } from 'vuepress/client'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+
+<template>
+ <div>
+ <h1>Tag page</h1>
+ <ul>
+ <li v-for="({ items, path }, name) in categoryMap.map">
+ <RouteLink :key="name" :to="path" class="category">
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </li>
+ </ul>
+ </div>
+</template>
+TagList layout:
<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+
+<template>
+ <div>
+ <h1>Tag page</h1>
+ <div class="category-wrapper">
+ <RouteLink
+ v-for="({ items, path }, name) in categoryMap.map"
+ :key="name"
+ :to="path"
+ class="category"
+ >
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </div>
+ <div class="article-wrapper" v-if="categoryMap.currentItems">
+ <div v-if="!categoryMap.currentItems.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in categoryMap.currentItems"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline
+ ? \`\${new Date(info.date).toLocaleDateString()}: \`
+ : '') + info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author"
+ >Author: {{ info.author }}</span
+ >
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag"
+ >Tag: {{ info.tag.join(', ') }}</span
+ >
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+ </div>
+</template>
+StarList layout:
<script setup lang="ts">
+import { useBlogType } from '@vuepress/plugin-blog/client'
+import { RouteLink } from 'vuepress/client'
+
+import ArticleList from '../components/ArticleList.vue'
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+
+const stars = useBlogType('star')
+</script>
+
+<template>
+ <div class="article-wrapper" v-if="stars.items">
+ <div v-if="!stars.items.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in stars.items"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline ? \`\${new Date(info.date).toLocaleDateString()}: \` : '') +
+ info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author">Author: {{ info.author }}</span>
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag">Tag: {{ info.tag.join(', ') }}</span>
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+</template>
+I18n Support
This plugin adds native i18n support, so your settings will be automatically applied to each language.
For example, if user has the following locales' config, and you are setting the "star" example above:
export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+}
+Then /zh/star/ and /star/ will both be available, and only articles under the correct locale will appear.
Generating Excerpt
This plugin provides a built-in excerpt generator, which can be enabled by setting excerpt option to true.
Excerpt introduction
An excerpt is an HTML fragment that is used to display a short description of an article in the blog list, so the excerpt has the following restrictions:
- It doesn't support any unknown tags (including all Vue components) and Vue syntax, so these contents will be removed when generating. If you have custom components (non-Vue components), set
isCustomElementoption. - Since the snippet is an HTML fragment, you will not be able to import any images via relative paths or aliases, they will be removed directly. If you want to keep images, please use absolute path based on
.vuepress/publicor full URL to ensure they can be accessed in other places.
The excerpt generator will try to find a valid excerpt separator from markdown contents, if it finds one, it will use content before the separator. The separator is default <!-- more -->, and you can customize it by setting excerptSeparator option.
If it cannot find a valid separator, it will parse content from the beginning of markdown file, and stop till its length reaches a preset value. The value is default 300, and you can customize it by setting excerptLength option.
To choose which page should generate excerpt, you can use excerptFilter option.
Example
Normally you may want to use frontmatter.description if users set them, so you can let filter function return false if frontmatter.description is not empty.
指南
本插件会为你的网站自动生成 Sitemap。为了使插件正常工作，你需要将部署的域名传递给插件的 hostname 选项。如果你想在开发服务器中预览，请配置 devServer 选项。
插件会自动根据页面的 Git 的时间戳生成页面的最后更新时间，同时会根据站点的多语言配置声明页面的其他语言版本替代地址。
控制 Sitemap 链接
默认情况下，所有除 404 页面以外的网站链接均会被添加进 Sitemap。
如果你希望在 VuePress 项目页面之外，添加其他页面链接到 Sitemap，请将它们变成数组传入插件的 extraUrls 选项。
如果你需要排除一些页面路径，你可以将它们变成数组传入到插件的 excludePaths 选项。你也可以在对应页面的 frontmatter 中，设置 sitemap 为 false。
输出位置
你还可以通过插件的 sitemapFilename 选项控制输出的地址，此地址相对于输出目录，默认为 sitemap.xml。
更新周期
页面默认的更新周期是 daily (每天)，如果你希望修改全部的页面周期，请在插件选项中设置 changefreq 。你也可以在页面的 frontmatter 中设置 sitemap.changefreq，页面具有更高的优先级。
合法的频率有:
"always""hourly""daily""weekly""monthly""yearly""never"
优先级
你可以在插件中设置 priority 以提供一个默认值。同时你可以通过 frontmatter 中的 sitemap.priority 来为每个页面设置优先级。可接受的值为 0 到 1 的浮点数。
修改时间获取
你可以通过插件的 modifyTimeGetter 来返回一个 ISO 字符串格式的时间，默认会通过 Git 插件生成。
以下是一个基于文件最后修改时间的例子。
// 基于文件最后修改时间
+({
+ modifyTimeGetter: (page, app) =>
+ fs.statSync(app.dir.source(page.filePathRelative)).mtime.toISOString();
+})
+Sitemap 介绍
网站地图 (Sitemap) 提供搜索引擎优化 (SEO):
- 为搜索引擎爬虫提供可以浏览整个网站的链接；
- 为搜索引擎爬虫提供一些链接，指向动态页面或者采用其他方法比较难以到达的页面；
- 如果访问者试图访问网站所在域内并不存在的 URL，那么这个访问者就会被转到“无法找到文件”的错误页面，而网站地图可以作为导航页。
网站地图通过使所有页面可被找到来增强搜索引擎优化的效果。
大部分搜索引擎只跟踪页面内有限数量的链接，因此当网站非常大的时候，网站地图对于使搜索引擎和访问者可以访问网站中的所有内容就变得必不可少了。
Sitemaps 是站点管理员向搜索引擎爬虫公布站点可被抓取页面的协议，sitemap 文件内容必须遵循 XML 格式的定义。每个 URL 可以包含更新的周期和时间、URL 在整个站点中的优先级。这样可以让搜索引擎更佳有效的抓取网站内容。
同步配置 robots.txt
由于 Sitemap 面向搜索引擎，配合此插件使用时，你最好保证你在 .vuepress/public 文件夹下放置了有效的 robots.txt，以允许搜索引擎收录。一个最简单的 robots.txt 如下 (允许所有搜索引擎访问所有路径)
User-agent: *
+
+Allow: /
+指南
使用
插件可为你生成以下三种格式的 feed 文件:
- Atom 1.0
- JSON 1.1
- RSS 2.0
请按照需要生成的格式，在插件选项中设置 atom, json 或 rss 为 true。
为了正确生成 Feed 链接，你需要在插件选项中设置 hostname。
可读的预览
',7),u={href:"/zh/atom.xml",target:"_blank",rel:"noopener noreferrer"},_={href:"/zh/rss.xml",target:"_blank",rel:"noopener noreferrer"},f=c('如果你想在开发服务器中预览 Feed，你需要在插件选项中设置 devServer: true。如果你没有使用默认的 http://localhost:{port}，你还需要设置 devHostname。
频道设置
你可以通过设置 channel 选项来自自定义 Feed 频道的各项信息。
我们推荐进行如下设置:
- 将建立 Feed 的日期转换为 ISOString 写入到
channel.pubDate中 - 通过
channel.ttl中设置内容的更新周期(单位: 分钟) - 通过
channel.copyright设置版权信息 - 通过
channel.author设置频道作者。
Guide
This plugin will automatically generate a Sitemap for your site. To let this plugin work, you need to pass the deployed domain name to the hostname option of the plugin. If you want to preview in devServer, set devServer options.
The plugin will automatically generate the last update time of the page based on the Git timestamp of the page, and will also declare the alternative links of the page in other languages according to the locales' config.
Control Sitemap Link
By default, all site links except 404 page will be added to the Sitemap.
To add other pages to the Sitemap outside the VuePress project page, please turn them into an array and pass to the extraUrls plugin option.
If you don't want certain pages to appear in the sitemap, you can turn their paths into an array and pass to the excludePaths plugin option, or set sitemap to false in the frontmatter of the corresponding page.
Output Location
You can also control the output link through the sitemapFilename option of the plugin, the link is relative to output directory. By default, the plugin will use sitemap.xml.
Change Frequency
The default update cycle of the page is daily (every day). To modify the entire page cycle, please set changefreq in the plugin options. You can also set sitemap.changefreq in the frontmatter of the page. Note that page has a higher priority.
The legal frequencies are:
"always""hourly""daily""weekly""monthly""yearly""never"
Priority
You can set priority in the plugin to provide a default value. At the same time you can set the priority for each page through sitemap.priority in frontmatter. Acceptable values are floating point numbers from 0 to 1.
Modify Time
You can use option modifyTimeGetter to return a time in ISO string format, which is generated by the Git plugin by default.
The following is an example based on the last modification time of a file.
// Based on file last modified time
+({
+ modifyTimeGetter: (page, app) =>
+ fs.statSync(app.dir.source(page.filePathRelative)).mtime.toISOString();
+})
+Sitemap Intro
Sitemaps provide SEO (Search Engine Optimization):
- Provide search engine spiders with links of the entire site;
- Provide some links for search engine spiders to dynamic pages or pages that are difficult to reach by other methods;
- If a visitor attempts to access a URL that does not exist within the site's domain, the visitor will be directed to a "file not found" error page, and the sitemap can be used as a navigation page.
A sitemap enhances SEO by making all pages findable.
Most search engines only follow a limited number of links within a page, so when the site is very large, a sitemap becomes essential to make everything on the site accessible to search engines and visitors.
Sitemaps is a protocol for site administrators to publish pages that can be crawled on a site to search engine spiders. The content of sitemap files must follow the definition in XML format. Each URL can contain the update period and last update time, the priority of the URL across the site. This allows search engines to crawl site content better and more efficiently.
Together with robots.txt
Sitemap is basically used by search engines, when using this plugin, you'd better ensure that you have a valid robots.txt in the .vuepress/public directory to allow search engines spiders to visit your site. The simplest robots.txt is as follows (allow all search engines to access all paths)
User-agent: *
+
+Allow: /
+Guide
Intro
Make your VuePress site a Progressive Web Application (PWA)[1].
',3),u={href:"https://developers.google.com/web/tools/workbox/modules/workbox-build",target:"_blank",rel:"noopener noreferrer"},f={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},g={class:"custom-container warning"},y=e("p",{class:"custom-container-title"},"WARNING",-1),m=n(`A PWA uses a Service Worker [2] (SW for short) to cache and proxy site content.
Web App Manifests
To make your website fully compliant with PWA, a Web app manifests [3] file is needed, and your pwa should satisfy the installability [4] specification.
You can set manifest option to customize the manifest file, or provide a manifest.webmanifest or manifest.json in public folder. The former has higher priority.
The plugin will automatically generate manifest.webmanifest for you and add manifest link declaration in each page, while you should still at least set a valid icon through manifest.icons or other icon related options in the PWA plugin.
WARNING
The installability [4:1] specification requires at least one valid icon to be declared in the manifest.
So if you do not configure manifest.icons, visitors can only enjoy the offline accessibility brought by the Service Worker cache, while cannot install your site as a PWA.
Besides the plugin does not process anything in the manifest by default, but outputs them as-is. This means that if you plan to deploy to a subdirectory, you should append the URL prefix to manifest Urls yourself. If everything you need is all under base directory, you can set appendBase: true in plugin options to let the plugin append base to any links in manifest.
Cache Control
To better control what the Service Worker can pre-cache, the plugin provides related options for cache control.
Default cache
By default, the plugin will pre-cache all js css files, and only homepage and 404 html are cached. The plugin will also cache font files (woff, woff2, eot, ttf, otf) and SVG icons.
Image Cache
If your site has only a few important images, and want them displayed in offline mode, you can cache site images by setting cacheImage: true .
We recognize images by file extension. Any files ending with .png, .jpg, .jpeg, .gif, .bmp, .webp will be regarded as images.
HTML Cache
If you have small sites, and would like to make document fully offline available, you can set cacheHTML to true to cache all HTML files.
Why only home and 404 page been cached by default?
Though VuePress generates HTML files through SSG[5] for all pages, these files are mainly used for SEO[6] and allow you to directly configure the backend without SPA[7] Visit any link.
VuePress is essentially an SPA. This means that you only need to cache the home page and enter from the home page to access all pages normally. Therefore, not caching other HTML by default can effectively reduce the cache size (40% smaller in size) and speed up the SW update speed.
But this also has the disadvantage. If the user enters the site directly from a non-home page, the HTML file for the first page still needs to be loaded from the internet. Also, in offline environment, users can only enter through the homepage and then navigate to the corresponding page by themselves. If they directly access a link, an inaccessible prompt will appear.
Size Control
To prevent large files from being included in the pre-cache list, any files > 2 MB or images > 1 MB will be omitted. You can customize these limits with maxSize and maxImageSize options (in KB unit).
Update Control
We provide the update option to control how users receive updates.
The default value of the update option is "available", which means that when new content available, the new SW will be installed and its resources will be fetched silently in the background. A pop-up window appears once the new SW is ready, and users can choose whether to refresh immediately to view new content. This means users are reading old content before a new SW is ready.
If your project is still in building stage, and you want to alert the user that he may be reading outdated content, you can set this to "hint". This allows users to be notified that new content has been published within seconds after visiting docs. But the negative effect of this is that if the user chooses to update before the new SW is ready, he will need to get all the resources of the page from the internet before the new SW installs and controls the page.
If your docs are stable, or you're hosting a blog and don't care much about users receiving the latest version right away, you can set this to "disabled", which means that the new SW will be installed completely silently in the background and start waiting, when all pages controlled by old SW are all closed, the new SW will start to take control and provide users with new content during next visit. This setting can prevent users from being disturbed during the visit.
To speed up user access under weak or no network conditions through SW, but also want users to always access new content, you can set this option to "force". This means any old SW will be removed as soon as a new SW is detected, and all pages are refreshed to ensure the user is browsing the latest content. The biggest disadvantage is that all users will experience unexpected sudden refresh within seconds after reentering an updated site.
Popups
When new content is detected (new SW detected), a update found popup appears; and when the new content is ready, an update ready popup appears.
If you are not satisfied with the default popup content, you can use your own component. Import PwaFoundPopup or PwaReadyPopup from @vuepress/plugin-pwa/client and use its slot to customize the popup content, then pass the component path to foundComponent or readyComponent option:
<script setup lang="ts">
+import { PwaFoundPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaFoundPopup v-slot="{ found, refresh }">
+ <div v-if="found">
+ New content is found.
+ <button @click="refresh">Refresh</button>
+ </div>
+ </PwaFoundPopup>
+</template>
+<script setup lang="ts">
+import { PwaReadyPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaReadyPopup v-slot="{ isReady, reload }">
+ <div v-if="isReady">
+ New content is ready.
+ <button @click="reload">Apply</button>
+ </div>
+ </PwaReadyPopup>
+</template>
+Other Options
`,31),b=e("code",null,"generateSwConfig",-1),v=e("code",null,"workbox-build",-1),D=e("h2",{id:"further-reading",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#further-reading"},[e("span",null,"Further Reading")])],-1),w=e("p",null,"For more details, please see:",-1),_={href:"https://web.dev/progressive-web-apps/",target:"_blank",rel:"noopener noreferrer"},C={href:"https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps",target:"_blank",rel:"noopener noreferrer"},k={href:"https://w3c.github.io/manifest/",target:"_blank",rel:"noopener noreferrer"},W=e("hr",{class:"footnotes-sep"},null,-1),S={class:"footnotes"},P={class:"footnotes-list"},x={id:"footnote1",class:"footnote-item"},E=e("p",null,[e("strong",null,"PWA introduction")],-1),T=e("p",null,"PWA, full name Progressive Web app. PWA standard is stipulated by W3C.",-1),A=e("p",null,"It allows sites to install the site as an App on supported platform through a browser that supports this feature.",-1),q={href:"https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps",target:"_blank",rel:"noopener noreferrer"},F=e("a",{href:"#footnote-ref1",class:"footnote-backref"},"↩︎",-1),I=n('Service Worker Introduction
The Service Worker will get and cache all the files registered in it during the registration process.
After the registration complete, the Service Worker is activated, and starts to proxy and control all your requests.
Whenever you want to initiate an access request through the browser, the Service Worker will check whether it exists in its own cache list, if it exists, it will directly return the cached result, otherwise it will call its own fetch method to get it. You can use a custom fetch method to fully control the result of the request for resources in the web page, such as providing a fallback web page when offline.
Every time the user reopens the site, the Service Worker will request to the link when it was registered. If a new version of Service Worker is detected, it will update itself and start caching the list of resources registered in the new Service Worker . After the content update is successfully obtained, the Service Worker will trigger the
updateevent. The user can be notified through this event, for example, a pop-up window will be displayed in the lower right corner, prompting the user that new content is available and allowing the user to trigger an update.
Installable
To let the site be registered as a PWA, the site needs to successfully register a valid service worker by itself, and declare a valid manifest file with its link in meta tag.
The manifest file should contain at least name (or short_name) icons start_url.
On safari, the maximum cache size of the service worker is 50 MB. ↩︎ ↩︎
SSG: Static Site Generation, ↩︎
SEO: Search Engine Optimization. ↩︎
SPA: Single Page Application, most of them only have the homepage, and use history mode to handle routing instead of actually navigating between pages. ↩︎
Guide
Usage
The plugin can generate feed files in the following three formats for you:
- Atom 1.0
- JSON 1.1
- RSS 2.0
Please set atom, json or rss to true in the plugin options according to the formats you want to generate.
To correctly generate feed links, you need to set hostname in the plugin options,
Readable Preview
',7),f={href:"/atom.xml",target:"_blank",rel:"noopener noreferrer"},p={href:"/rss.xml",target:"_blank",rel:"noopener noreferrer"},g=r('If you want to preview your feed in devServer, set devServer: true in plugin options. You may also need to set devHostname if you are not using the default http://localhost:{port}.
Channel settings
You can customize the feed channel information by setting the channel option.
We recommend the following settings:
- Convert the date of creating the feed to ISOString and write it into
channel.pubDate - The update period of the content set in
channel.ttl(unit: minutes) - Set copyright information via
channel.copyright - Set the channel author via
channel.author.
使用 @vuepress/plugin-blog，你可以轻松地将博客功能引入主题。
收集文章并生成信息
起步时，插件会首选过滤并选择那些需要作为文章的页面。这将剔除你不想要的页面，并在后续处理中排除它们。
默认情况下，所有从 Markdown 文件生成但不是主页的页面，都将被视作文章。
你可能需要设置 filter 选项来完全自定义要收集的页面。 filter 接受一个形状为 (page: Page) => boolean 的函数。
接着，你应该设置 getInfo 选项为一个接受 Page 作为参数并返回包含所需信息的对象的函数。这样稍后，你可以从组合 API 中获取这些信息。
案例
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ filter: ({ filePathRelative, frontmatter }) => {
+ // 舍弃那些不是从 Markdown 文件生成的页面
+ if (!filePathRelative) return false
+
+ // 舍弃 \`archives\` 文件夹的页面
+ if (filePathRelative.startsWith('archives/')) return false
+
+ // 舍弃那些没有使用默认布局的页面
+ if (frontmatter.home || frontmatter.layout) return false
+
+ return true
+ },
+
+ getInfo: ({ frontmatter, git = {}, data = {} }) => {
+ // 获取页面信息
+ const info: Record<string, any> = {
+ author: frontmatter.author || '',
+ categories: frontmatter.categories || [],
+ date: frontmatter.date || git.createdTime || null,
+ tags: frontmatter.tags || [],
+ excerpt: data.excerpt || '',
+ }
+
+ return info
+ },
+ }),
+ // 其他插件 ...
+ ],
+}
+自定义类别和类型
基本上，你的博客中需要两种“类型”:
类别:
“类别”是用文章的标签 (或类别) 对它们进行分组。
例如，每篇文章可能都有对应的“分类”和“标签”。
类型:
“类型”是过滤不同条件的文章。
例如，你的帖子中可能有日记或笔记。当帖子带有写作日期信息时，它可以称为“时间线项目”。
了解这两种类型的描述后，你可以设置 category 和 type 选项，它们都接受一个数组，每个元素代表一个配置。
让我们从此处 2 个例子开始。
假设你想为每篇文章设置标签，并且你正在通过 frontmatter.tag 设置它们。同时，你想要在 /tag/ 中使用 TagMap 布局的标签页面，并在/tag/标签名称 中使用 TagList 布局对标签按名称进行分组，你可能需要这样的配置:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // 其他配置 ...
+ category: [
+ {
+ key: 'tag',
+ getter: ({ frontmatter }) => frontmatter.tag || [],
+ path: '/tag/',
+ layout: 'TagMap',
+ frontmatter: () => ({ title: '标签页' }),
+ itemPath: '/tag/:name/',
+ itemLayout: 'TagList',
+ itemFrontmatter: (name) => ({ title: \`\${name}标签\` }),
+ },
+ ],
+ }),
+ // 其他插件 ...
+ ],
+}
+此外，你可能希望为你的一些文章加注星标，并将其展示给访问者。当你在 frontmatter 中设置 star: true 来标记它们时，你可能需要这样的配置来在 /star/ 路径中以 StarList 布局显示它们:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // 其他配置 ...
+ type: [
+ {
+ key: 'star',
+ filter: ({ frontmatter }) => frontmatter.star,
+ path: '/star/',
+ layout: 'StarList',
+ frontmatter: () => ({ title: '星标文章' }),
+ },
+ ],
+ }),
+ // 其他插件 ...
+ ],
+}
+在客户端使用组合 API
当生成每个页面时，插件将在 frontmatter.blog 中设置如下信息
interface BlogFrontmatterOptions {
+ /** 当前页面的类型 */
+ type: 'category' | 'type'
+ /** 在当前分类或类别下全局唯一的 key */
+ key: string
+ /**
+ * 当前的分类名称
+ *
+ * @description 仅在分类子项目页面中可用
+ */
+ name?: string
+}
+所以你可以直接调用 useBlogCategory() 和 useBlogType()，结果将是当前路由绑定的类别或类型。
此外，你可以通过传递所需的 key 作为参数，来将获得绑定到该 key 的信息。
对于上方的 Node 配置而言，你可以在客户端通过如下方式获取 tag 和 star 的信息:
TagMap 布局:
<template>
+ <div>
+ <h1>Tag page</h1>
+ <ul>
+ <li v-for="({ items, path }, name) in categoryMap.map">
+ <RouteLink :key="name" :to="path" class="category">
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </li>
+ </ul>
+ </div>
+</template>
+<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+import { RouteLink } from 'vuepress/client'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+TagList 布局:
<template>
+ <div>
+ <h1>Tag page</h1>
+ <div class="category-wrapper">
+ <RouteLink
+ v-for="({ items, path }, name) in categoryMap.map"
+ :key="name"
+ :to="path"
+ class="category"
+ >
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </div>
+ <div class="article-wrapper" v-if="categoryMap.currentItems">
+ <div v-if="!categoryMap.currentItems.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in categoryMap.currentItems"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline
+ ? \`\${new Date(info.date).toLocaleDateString()}: \`
+ : '') + info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author"
+ >Author: {{ info.author }}</span
+ >
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag"
+ >Tag: {{ info.tag.join(', ') }}</span
+ >
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+ </div>
+</template>
+<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+import { RouteLink } from 'vuepress/client'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+StarList 布局:
<template>
+ <div class="article-wrapper" v-if="stars.items">
+ <div v-if="!stars.items.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in stars.items"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline ? \`\${new Date(info.date).toLocaleDateString()}: \` : '') +
+ info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author">Author: {{ info.author }}</span>
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag">Tag: {{ info.tag.join(', ') }}</span>
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+</template>
+<script setup lang="ts">
+import { useBlogType } from '@vuepress/plugin-blog/client'
+
+import ArticleList from '../components/ArticleList.vue'
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+
+const stars = useBlogType('star')
+</script>
+多语言支持
该插件添加了原生多语言支持，因此你的设置将自动应用于每种语言。
例如，如果用户进行了以下 locales 配置，并且你正在设置上面的“star”示例:
export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+}
+那么 /zh/star/ 和 /star/ 都将可用，并且只会显示对应语言下的文章。
摘要生成
这个插件提供了一个内置的摘要生成器，可以通过将 excerpt 选项设置为 true 来启用。
摘要介绍
摘要是一个 HTML 片段，被用于在博客列表中显示文章的简短描述，所以摘要有如下限制:
- 摘要不支持任何未知标签以及 Vue 语法，所以此类内容会在生成时被移除。如果你有自定义组件 (非 Vue 组件)，请配置
isCustomElement选项。 - 由于摘要是一个 HTML 片段，所以你将无法通过相对路径或别名引入任何图片，这些图片会被直接移除。如果你想要保留图片，请使用基于
.vuepress/public的绝对路径或完整路径以确保它们可以在其他地址被访问。
摘要生成器将尝试从 Frontmatter 内容中找到有效的摘要分隔符，如果找到，它将使用分隔符之前的内容，分隔符默认为 <!-- more -->，并且你可以通过 excerptSeparator 选项来自定义它。
如果找不到有效的分隔符，它将从 Markdown 文件的开头开始解析内容，直到长度达到预设值时停止。该值默认为 300，你可以通过设置 excerptLength 选项来自定义它。
要选择哪个页面应该生成摘要，你可以使用 excerptFilter 选项。
示例
通常，如果用户设置了 frontmatter.description，你可能希望使用它们，因此如果 frontmatter.description 不为空，你可以让过滤器函数返回 false。
Out of Box
The plugin works out of the box. Without any config, it will extract information from the page content as much as possible to complete the necessary tags required by OGP and JSON-LD.
By default, the plugin will read the site config and page frontmatter to automatically generate tags as much as possible. Such as site name, page title, page type, writing date, last update date, and article tags are all automatically generated.
The following are the <meta> tags and their values that will be injected into <head> by default:
Default OGP Generation
The following are the <meta> tags and their value injected into <head> by default to satisfy OGP:
| Meta Name | Value |
|---|---|
og:url | options.hostname + path |
og:site_name | siteConfig.title |
og:title | page.title |
og:description | page.frontmatter.description || auto generated (when autoDescription is true in plugin options) |
og:type | "article" |
og:image | options.hostname + page.frontmatter.image ||first image in page || fallbackImage in plugin options |
og:updated_time | page.git.updatedTime |
og:locale | page.lang |
og:locale:alternate | Other languages in siteData.locales |
twitter:card | "summary_large_image" (only available when image found) |
twitter:image:alt | page.title (only available when image found) |
article:author | page.frontmatter.author || options.author |
article:tag | page.frontmatter.tags || page.frontmatter.tag |
article:published_time | page.frontmatter.date || page.git.createdTime |
article:modified_time | page.git.updatedTime |
Default JSON-LD Generation
| Property Name | Value |
|---|---|
@context | "https://schema.org" |
@type | "NewsArticle" |
headline | page.title |
image | image in page || options.hostname + page.frontmatter.image || siteFavIcon in plugin options |
datePublished | page.frontmatter.date || page.git.createdTime |
dateModified | page.git.updatedTime |
author | page.frontmatter.author || options.author |
Setting Tags Directly
You can configure the head option in the page's frontmatter to add specific tags to the page <head> to enhance SEO. For example:
---
+head:
+ - - meta
+ - name: keywords
+ content: SEO plugin
+---
+Will automatically inject <meta name="keywords" content="SEO plugin" />.
Customize Generation
The plugin also gives you full control over the build logic.
Page Type
For most pages, there are basically only two types: articles and website, so the plugin provides the isArticle option to allow you to provide logic for identifying articles.
The option accepts a function in the format (page: Page) => boolean, by default all non-home pages generated from Markdown files are treated as articles.
TIP
If a page does fit into the "unpopular" genre like books, music, etc., you can handle them by setting the three options below.
OGP
You can use the plugin options ogp to pass in a function to modify the default OGP object to your needs and return it.
function ogp(
+ /** OGP Object inferred by plugin */
+ ogp: SeoContent,
+ /** Page Object */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): SeoContent
+For example, if you are using a third-party theme and set a banner in frontmatter for each article according to the theme requirements, then you can pass in the following ogp:
seoPlugin({
+ ogp: (ogp, page) => ({
+ ...ogp,
+ 'og:image': page.frontmatter.banner || ogp['og:image'],
+ }),
+})
+JSON-LD
Like OGP, you can use the plugin options jsonLd to pass in a function to modify the default JSON-LD object to your needs and return it.
function jsonLd(
+ /** JSON-LD Object inferred by plugin */
+ jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema,
+ /** Page Object */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): ArticleSchema | BlogPostingSchema | WebPageSchema
+Canonical Link
If you are deploying your content to different sites, or same content under different URLs, you may need to set canonical option to provide a "Canonical Link" for your page. You can either set a string which will be appended before page route link, or adding a custom function (page: Page) => string | null to return a canonical link if necessary.
Example
If your sites are deployed under docs directory in example.com, but available in:
http://example.com/docs/xxxhttps://example.com/docs/xxxhttp://www.example.com/docs/xxxhttps://www.example.com/docs/xxx(primary)
To let search engine results always be the primary choice, you may need to set canonical to https://www.example.com/docs/, so that search engine will know that the fourth URL is preferred to be indexed.
Customize head Tags
Sometimes you may need to fit other protocols or provide the corresponding SEO tags in the format provided by other search engines. In this case, you can use the customHead option, whose type is:
function customHead(
+ /** Head tag config */
+ head: HeadConfig[],
+ /** Page Object */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): void
+You should modify the head array in this function directly.
SEO Introduction
Search engine optimization (SEO) is the process of improving the quality and quantity of site traffic to a site or a web page from search engines. SEO targets unpaid traffic (known as "natural" or "organic" results) rather than direct traffic or paid traffic. Unpaid traffic may originate from different kinds of searches, including image search, video search, academic search, news search, and industry-specific vertical search engines.
As an internet marketing strategy, SEO considers how search engines work, the computer-programmed algorithms that dictate search engine behavior, what people search for, the actual search terms or keywords typed into search engines, and which search engines are preferred by their targeted audience. SEO is performed because a site will receive more visitors from a search engine when sites rank higher on the search engine results page (SERP). These visitors can then potentially be converted into customers.
Related Documents
`,16),f={href:"https://ogp.me/",target:"_blank",rel:"noopener noreferrer"},b=e("strong",null,"O",-1),v=e("strong",null,"G",-1),x=e("strong",null,"Pr",-1),C=e("p",null,[t("This plugin perfectly supports this protocol and will automatically generate "),e("code",null,""),t(" tags that conform to the protocol.")],-1),k={href:"https://www.w3.org/TR/json-ld-api/",target:"_blank",rel:"noopener noreferrer"},E=e("p",null,'This plugin will generate "NewsArticle" scheme for article pages.',-1),_={href:"https://www.w3.org/TR/rdfa-primer/",target:"_blank",rel:"noopener noreferrer"},w={href:"https://schema.org/",target:"_blank",rel:"noopener noreferrer"},O=e("p",null,"Schema definition site for structural markup",-1),S=e("h2",{id:"related-tools",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#related-tools"},[e("span",null,"Related Tools")])],-1),P={href:"https://search.google.com/test/rich-results",target:"_blank",rel:"noopener noreferrer"};function T(A,j){const a=s("ExternalLinkIcon"),i=s("RouteLink"),r=s("ProjectLink");return d(),p("div",null,[u,e("p",null,[t("This plugin will make your site fully support "),e("a",h,[t("Open Content Protocol OGP"),n(a)]),t(" and "),e("a",y,[t("JSON-LD 1.1"),n(a)]),t(" to enhance the SEO of the site.")]),m,e("p",null,[t("For detailed parameter structure, see "),n(i,{to:"/plugins/seo/config.html"},{default:o(()=>[t("Config")]),_:1}),t(".")]),D,e("ul",null,[e("li",null,[e("p",null,[e("a",f,[t("Open Content Protocol OGP"),n(a)]),t(" ("),b,t("pen "),v,t("raph "),x,t("otocol)")]),C]),e("li",null,[e("p",null,[e("a",k,[t("JSON-LD 1.1"),n(a)])]),E]),e("li",null,[e("p",null,[e("a",_,[t("RDFa 1.1"),n(a)])]),e("p",null,[t("RDFa mainly marks HTML structure. This is what the plugin cannot support. "),n(r,{type:"theme",name:"hope"},{default:o(()=>[t("vuepress-theme-hope")]),_:1}),t(" uses this feature to pass Google's rich media structure test. You can consider using it.")])]),e("li",null,[e("p",null,[e("a",w,[t("Schema.Org"),n(a)])]),O])]),S,e("p",null,[t("You can use "),e("a",P,[t("Google Rich Media Structure Test Tool"),n(a)]),t(" to test this site.")])])}const L=c(g,[["render",T],["__file","guide.html.vue"]]),q=JSON.parse('{"path":"/plugins/seo/guide.html","title":"Guide","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"Out of Box","slug":"out-of-box","link":"#out-of-box","children":[{"level":3,"title":"Default OGP Generation","slug":"default-ogp-generation","link":"#default-ogp-generation","children":[]},{"level":3,"title":"Default JSON-LD Generation","slug":"default-json-ld-generation","link":"#default-json-ld-generation","children":[]}]},{"level":2,"title":"Setting Tags Directly","slug":"setting-tags-directly","link":"#setting-tags-directly","children":[]},{"level":2,"title":"Customize Generation","slug":"customize-generation","link":"#customize-generation","children":[{"level":3,"title":"Page Type","slug":"page-type","link":"#page-type","children":[]},{"level":3,"title":"OGP","slug":"ogp","link":"#ogp","children":[]},{"level":3,"title":"JSON-LD","slug":"json-ld","link":"#json-ld","children":[]}]},{"level":2,"title":"Canonical Link","slug":"canonical-link","link":"#canonical-link","children":[{"level":3,"title":"Customize head Tags","slug":"customize-head-tags","link":"#customize-head-tags","children":[]}]},{"level":2,"title":"SEO Introduction","slug":"seo-introduction","link":"#seo-introduction","children":[]},{"level":2,"title":"Related Documents","slug":"related-documents","link":"#related-documents","children":[]},{"level":2,"title":"Related Tools","slug":"related-tools","link":"#related-tools","children":[]}],"git":{"updatedTime":1706762763000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":3}]},"filePathRelative":"plugins/seo/guide.md"}');export{L as comp,q as data}; diff --git a/assets/guide.html-TN47Spm1.js b/assets/guide.html-TN47Spm1.js new file mode 100644 index 0000000000..03e36747ac --- /dev/null +++ b/assets/guide.html-TN47Spm1.js @@ -0,0 +1,23 @@ +import{_ as r,r as l,o as c,c as i,b as s,d as e,a as o,w as p,e as a}from"./app-BcH8wZQx.js";const d={},f=a('指南
介绍
将你的 VuePress 站点变成渐进式网络应用程序 (PWA)[1]。
',3),u={href:"https://developers.google.com/web/tools/workbox/modules/workbox-build",target:"_blank",rel:"noopener noreferrer"},h={href:"https://github.com/yyx990803/register-service-worker",target:"_blank",rel:"noopener noreferrer"},D={class:"custom-container warning"},y=s("p",{class:"custom-container-title"},"注意",-1),v=a(`A PWA uses a Service Worker [2] (SW for short) to cache and proxy site content.
一个 PWA 使用 Service Worker [2:1] (简称 SW) 来获取并托管网站内容。
网络 App 清单
为了使你的网站符合 PWA 的要求，一个网络 App 清单[3]文件是必要的，并且你的 PWA 应满足可安装性[4]要求。
你可以通过设置 manifest 选项来自定义 manifest 文件，或者在 public 文件夹中提供 manifest.webmanifest 或 manifest.json。前者优先级更高。
插件会自动为你生成 manifest.webmanifest，并在每个页面的 <head> 中添加清单链接声明，但是 你至少应该通过 manifest.icons 或 PWA 插件中的其他选项设置一个有效的图标。
注意
可安装性[4:1]规范要求 manifest 中至少声明一个有效的图标。
所以如果你不配置 manifest.icons，访问者只能享受到 Service Worker 缓存带来的离线可访问性，而并不能作为 PWA 进行安装。
此外，该插件默认不处理清单中的任何内容，而是按原样输出。 这意味着，如果你计划部署到子目录，则应自行将 URL 前缀附加到自己的清单 Urls 中。如果你需要的所有东西都在 base 文件夹下，你可以在插件选项中设置 appendBase: true 让插件将 base 自动附加到任何地址。
缓存控制
为了更好的控制 Service Worker 可以预缓存的内容，插件提供了相关的缓存控制选项。
默认缓存
默认情况下插件会预缓存所有的 JS 和 CSS 文件，但仅缓存主页和 404 页面的 HTML。插件同时还会缓存字体文件 (woff, woff2, eot, ttf, otf) 和 SVG 图标。
图片缓存
如果你的站点只有少量重要图片，并希望它们在离线模式下显示，你可以通过设置 cacheImage 选项为 true 来缓存站点图片。
我们通过文件后缀名识别图片，任何以 .png, .jpg, .jpeg, .gif, .bmp, .webp 结尾的文件都会视为图片。
HTML 缓存
当你网站体积不大，并且希望文档完全离线可用时，你可以通过设置 cacheHTML 为 true 来缓存所有 HTML 页面。
为什么默认不缓存非主页和 404 页面
虽然说 VuePress 为所有的页面通过 SSG[5] 生成了 HTML 文件，但是这些文件主要用于 SEO[6]，并能够让你在后端不做 SPA[7] 配置的情况下能够直接访问任何链接。
VuePress 本质上是一个 SPA。这意味着你只需要缓存主页并从主页进入即可正常访问所有页面。所以默认不缓存其他 HTML 能够有效减小缓存大小 (可以缩减大约 40% 的体积)，加快 SW 更新速度。
但是这样做也有缺点，如果用户直接从非主页进入网站，首个页面的 HTML 文件仍需要从互联网加载。同时离线环境下，用户只能通过主页进入再自行导航到对应页面，直接访问某个链接会出现无法访问的提示。
大小控制
为了防止在预缓存列表中包含大文件，任何 > 2 MB 的文件或 > 1 MB 的图片都将被忽略。 你可以通过 maxSize 和 maxImageSize 来自定义大小限制 (单位为 KB)。
更新控制
我们提供 update 选项控制用户如何接收更新。
update 选项的默认值是 "available"，这意味着当网站内容更新后，新的 SW 会在后台静默安装，并在安装结束后弹窗提示用户新内容就绪。用户可以自主选择是否立即刷新查看新内容。这意味在新 SW 就绪前用户会访问旧版本网站。
如果你的文档仍在建设期，希望尽早提示用户他可能在阅读已过时的内容，你可以将其设置为 "hint"。这样用户在进入文档后数秒内就可以收到新内容已发布的通知。但这样做的负面效果是如果用户在新 SW 就绪前选择更新，那么他将在新 SW 安装并接管页面前，需要从互联网获取页面的全部资源。
如果你的文档很稳定，或者你在托管博客，不太关心用户立即接收到最新版本，你可以将其设置为 "disabled"，这意味着新的 SW 将在后台完全静默安装并在安装后等待，当旧版本 SW 控制的页面全部关闭后，新 SW 将再下次访问接管并提供用户新内容。此设置可以避免用户在访中被弹窗打扰。
如果你希望通过 SW 来加速用户在弱网或无网条件下的访问，但同时希望用户时刻访问新内容，你可以将此选项设置为 "force"。这意味着检测到新 SW 后旧 SW 将会被立刻销毁并且页面会被刷新以确保用户浏览最新内容。最大的缺点就是致新 SW 发布后，用户在重新进入网站后的几秒内会遇到预期之外的突然刷新，并且他们将必须通过互联网访问文档并完全重新安装最新的 SW。
更新提示弹窗
当检测到新内容 (检测到新的 SW) 时，更新提示弹窗将会出现；当新内容就绪时，更新就绪弹窗将会出现。
如果你对默认的弹窗不满意，你可以自行编写组件更换。从 @vuepress/plugin-pwa/client 中导入 PwaFoundPopup 或 PwaReadyPopup 并使用其 slot 来自定义弹窗内容，然后将组件路径传递给 foundComponent 或 readyComponent 选项。
<script setup lang="ts">
+import { PwaFoundPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaFoundPopup v-slot="{ found, refresh }">
+ <div v-if="found">
+ 已找到新内容
+ <button @click="refresh">刷新</button>
+ </div>
+ </PwaFoundPopup>
+</template>
+<script setup lang="ts">
+import { PwaReadyPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaReadyPopup v-slot="{ isReady, reload }">
+ <div v-if="isReady">
+ 新内容已就绪
+ <button @click="reload">应用</button>
+ </div>
+ </PwaReadyPopup>
+</template>
+其他选项
`,32),g=s("code",null,"generateSwConfig",-1),m=s("code",null,"workbox-build",-1),_=s("h2",{id:"相关阅读",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#相关阅读"},[s("span",null,"相关阅读")])],-1),b=s("p",null,"更多内容，请详见:",-1),C={href:"https://web.dev/progressive-web-apps/",target:"_blank",rel:"noopener noreferrer"},k={href:"https://developer.mozilla.org/zh-CN/docs/Web/Progressive_web_apps",target:"_blank",rel:"noopener noreferrer"},S={href:"https://w3c.github.io/manifest/",target:"_blank",rel:"noopener noreferrer"},W=s("hr",{class:"footnotes-sep"},null,-1),P={class:"footnotes"},w={class:"footnotes-list"},E={id:"footnote1",class:"footnote-item"},x=s("p",null,[s("strong",null,"PWA 介绍")],-1),A=s("p",null,"PWA 全称 Progressive Web app，即渐进式网络应用程序，标准由 W3C 规定。",-1),q=s("p",null,"它允许网站通过支持该特性的浏览器将网站作为 App 安装在对应平台上。",-1),F={href:"https://developer.mozilla.org/zh-CN/docs/Web/Progressive_web_apps",target:"_blank",rel:"noopener noreferrer"},M=s("a",{href:"#footnote-ref1",class:"footnote-backref"},"↩︎",-1),z=a('Service Worker 简要介绍
Service Worker 会在注册过程中获取注册在其中的所有文件并缓存它们。
注册成功后，Service Worker 激活，并开始代理并控制你的全部请求。
每当你想要通过浏览器发起访问请求后，Service Worker 将会查看其是否存在与自身缓存列表中，若存在则直接返回缓存好的结果，否则调用自身的 fetch 方法进行获取。你可以通过自定义 fetch 方法，来完全控制网页内资源获取请求的结果，比如在离线时提供一个 fallback 的网页。
每次用户重新打开网站时，Service Worker 会向自身注册时的地址发出校验命令，如果检测到新版本的 Service Worker，则会更新自身，并开始缓存注册在新 Service Worker 中的资源列表。成功获取内容更新后，Service Worker 将会触发
update事件。可以通过此事件提示用户，比如将在右下角显示一个弹出窗口，提示用户新内容可用并允许用户触发更新。
可安装性
想要让网站可以注册为 PWA，网站需要自行成功注册有效的 Service Worker，同时拥有合法的 manifest 清单文件并在网站中声明它。
清单文件应至少包含 name(或 short_name) icons start_url。
SSG: Static Site Generating，静态站点生成。 ↩︎
开箱即用
插件开箱即用，在不做任何配置的情况下，会尽可能通过页面内容，提取对应的信息补全 OGP 与 JSON-LD 所需的必要标签。
默认情况下，插件会读取站点配置、主题配置与页面的 frontmatter 来尽可能自动生成。诸如站点名称，页面标题，页面类型，写作日期，最后更新日期，文章标签均会自动生成。
默认的 OGP 生成逻辑
| 属性名称 | 值 |
|---|---|
og:url | options.hostname + path |
og:site_name | siteConfig.title |
og:title | page.title |
og:description | page.frontmatter.description || 自动生成 (当插件选项中的 autoDescription 为 true 时) |
og:type | "article" |
og:image | options.hostname + page.frontmatter.image || 页面的第一张图片|| 插件选项的 fallbackImage |
og:updated_time | page.git.updatedTime |
og:locale | page.lang |
og:locale:alternate | siteData.locales 包含的其他语言 |
twitter:card | "summary_large_image" (仅在找到图片时) |
twitter:image:alt | page.title (仅在找到图片时) |
article:author | page.frontmatter.author || options.author |
article:tag | page.frontmatter.tags || page.frontmatter.tag |
article:published_time | page.frontmatter.date || page.git.createdTime |
article:modified_time | page.git.updatedTime |
默认的 JSON-LD 生成逻辑
| 属性名 | 值 |
|---|---|
@context | "https://schema.org" |
@type | "NewsArticle" |
headline | page.title |
image | 页面中的图片|| options.hostname + page.frontmatter.image |
datePublished | page.frontmatter.date || page.git.createdTime |
dateModified | page.git.updatedTime |
author | page.frontmatter.author || options.author |
直接添加 head 标签
你可以在页面的 frontmatter 中配置 head 选项，自主添加特定标签到页面 <head> 以增强 SEO。
如:
---
+head:
+ - - meta
+ - name: keywords
+ content: SEO plugin
+---
+会自动注入 <meta name="keywords" content="SEO plugin" />。
自定义生成过程
本插件也支持你完全控制生成逻辑。
页面类型
对于大多数页面，基本只有文章和网页两种类型，所以插件提供了 isArticle 选项让你提供辨别文章的逻辑。
选项接受一个 (page: Page) => boolean 格式的函数，默认情况下从 Markdown 文件生成的非主页页面都会被视为文章。
提示
如果某个网页的确符合图书、音乐之类的“冷门”类型，你可以通过设置下方三个选项处理它们。
OGP
你可以使用插件选项的 ogp 传入一个函数来按照你的需要修改默认 OGP 对象并返回。
function ogp(
+ /** 插件推断的 OGP 信息 */
+ ogp: SeoContent,
+ /** 页面对象 */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): SeoContent
+比如你在使用某个第三方主题，并按照主题要求为每篇文章在 Front Matter 中设置了 banner，那你可以传入这样的 ogp:
seoPlugin({
+ ogp: (ogp, page) => ({
+ ...ogp,
+ 'og:image': page.frontmatter.banner || ogp['og:image'],
+ }),
+})
+JSON-LD
同 OGP，你可以使用插件选项的 jsonLd 传入一个函数来按照你的需要修改默认 JSON-LD 对象并返回。
function jsonLd(
+ /** 由插件推断出的 JSON-LD 对象 */
+ jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema,
+ /** 页面对象 */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): ArticleSchema | BlogPostingSchema | WebPageSchema
+规范链接
如果你将内容部署到不同的站点，或不同 URL 下的相同内容，你可能需要设置 canonical 选项为你的页面提供 “规范链接”。 你可以设置一个字符串，这样它会附加在页面路由链接之前，或者添加一个自定义函数 (page: Page) => string | null 返回规范链接。
例子
如果你的站点部署在 example.com 的 docs 文件夹下，但同时在下列网址中可用:
http://example.com/docs/xxxhttps://example.com/docs/xxxhttp://www.example.com/docs/xxxhttps://www.example.com/docs/xxx(首选)
要让搜索引擎结果始终是首选，你可能需要将 canonical 设置为 https://www.example.com/docs/，以便搜索引擎知道首选第四个 URL 作为索引结果。
自定义 head 标签
有些时候你可能需要符合其他协议或按照其他搜索引擎提供的格式提供对应的 SEO 标签，此时你可以使用 customHead 选项，其类型为:
function customHead(
+ /** head 标签配置 */
+ head: HeadConfig[],
+ /** 页面对象 */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): void
+你应该直接修改传入的 head 参数。
SEO 介绍
搜索引擎优化 (Search Engine Optimization)，是一种透过了解搜索引擎的运作规则来调整网站，以及提高目的网站在有关搜索引擎内排名的方式。由于不少研究发现，搜索引擎的用户往往只会留意搜索结果最前面的几个条目，所以不少网站都希望透过各种形式来影响搜索引擎的排序，让自己的网站可以有优秀的搜索排名。 所谓“针对搜索引擎作最优化的处理”，是指为了要让网站更容易被搜索引擎接受。搜索引擎会将网站彼此间的内容做一些相关性的资料比对，然后再由浏览器将这些内容以最快速且接近最完整的方式，呈现给搜索者。搜索引擎优化就是通过搜索引擎的规则进行优化，为用户打造更好的用户体验，最终的目的就是做好用户体验。
相关文档
`,15),x={href:"https://ogp.me/",target:"_blank",rel:"noopener noreferrer"},b=e("strong",null,"O",-1),C=e("strong",null,"G",-1),_=e("strong",null,"Pr",-1),E=e("p",null,[s("本插件完美支持该协议，会自动生成符合该协议的 "),e("code",null,""),s(" 标签。")],-1),f={href:"https://www.w3.org/TR/json-ld-api/",target:"_blank",rel:"noopener noreferrer"},k=e("p",null,"本插件会为文章类页面生成 NewsArticle 类标签。",-1),w={href:"https://www.w3.org/TR/rdfa-primer/",target:"_blank",rel:"noopener noreferrer"},A={href:"https://schema.org/",target:"_blank",rel:"noopener noreferrer"},O=e("p",null,"结构标记的 Schema 定义站点",-1),P=e("h2",{id:"相关工具",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#相关工具"},[e("span",null,"相关工具")])],-1),S={href:"https://search.google.com/test/rich-results",target:"_blank",rel:"noopener noreferrer"};function B(F,L){const t=a("ExternalLinkIcon"),c=a("RouteLink"),d=a("ProjectLink");return r(),i("div",null,[g,e("p",null,[s("本插件会通过向网站 "),h,s(" 注入标签，让你的网站完全支持 "),e("a",y,[s("开放内容协议 OGP"),n(t)]),s(" 和 "),e("a",u,[s("JSON-LD 1.1"),n(t)]),s("，以全面增强站点的搜索引擎优化性。")]),m,e("p",null,[s("详细的参数结构详见 "),n(c,{to:"/zh/plugins/seo/config.html"},{default:l(()=>[s("配置")]),_:1}),s("。")]),v,e("ul",null,[e("li",null,[e("p",null,[e("a",x,[s("开放内容协议 OGP"),n(t)]),s(" ("),b,s("pen "),C,s("raph "),_,s("otocal)")]),E]),e("li",null,[e("p",null,[e("a",f,[s("JSON-LD 1.1"),n(t)])]),k]),e("li",null,[e("p",null,[e("a",w,[s("RDFa 1.1"),n(t)])]),e("p",null,[s("RDFa 主要标记 HTML 结构。这是插件无法支持的内容，"),n(d,{type:"theme",name:"hope",path:"/zh/"},{default:l(()=>[s("vuepress-theme-hope")]),_:1}),s(" 使用了这一功能通过了谷歌的富媒体结构测试。你可以考虑搭配使用。")])]),e("li",null,[e("p",null,[e("a",A,[s("Schema.Org"),n(t)])]),O])]),P,e("p",null,[s("你可以使用 "),e("a",S,[s("Google 富媒体结构测试工具"),n(t)]),s(" 测试本站点。")])])}const j=p(D,[["render",B],["__file","guide.html.vue"]]),q=JSON.parse('{"path":"/zh/plugins/seo/guide.html","title":"指南","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"开箱即用","slug":"开箱即用","link":"#开箱即用","children":[{"level":3,"title":"默认的 OGP 生成逻辑","slug":"默认的-ogp-生成逻辑","link":"#默认的-ogp-生成逻辑","children":[]},{"level":3,"title":"默认的 JSON-LD 生成逻辑","slug":"默认的-json-ld-生成逻辑","link":"#默认的-json-ld-生成逻辑","children":[]}]},{"level":2,"title":"直接添加 head 标签","slug":"直接添加-head-标签","link":"#直接添加-head-标签","children":[]},{"level":2,"title":"自定义生成过程","slug":"自定义生成过程","link":"#自定义生成过程","children":[{"level":3,"title":"页面类型","slug":"页面类型","link":"#页面类型","children":[]},{"level":3,"title":"OGP","slug":"ogp","link":"#ogp","children":[]},{"level":3,"title":"JSON-LD","slug":"json-ld","link":"#json-ld","children":[]}]},{"level":2,"title":"规范链接","slug":"规范链接","link":"#规范链接","children":[{"level":3,"title":"自定义 head 标签","slug":"自定义-head-标签","link":"#自定义-head-标签","children":[]}]},{"level":2,"title":"SEO 介绍","slug":"seo-介绍","link":"#seo-介绍","children":[]},{"level":2,"title":"相关文档","slug":"相关文档","link":"#相关文档","children":[]},{"level":2,"title":"相关工具","slug":"相关工具","link":"#相关工具","children":[]}],"git":{"updatedTime":1706762763000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":3}]},"filePathRelative":"zh/plugins/seo/guide.md"}');export{j as comp,q as data}; diff --git a/assets/index.html-4J_SM0OC.js b/assets/index.html-4J_SM0OC.js new file mode 100644 index 0000000000..6966322477 --- /dev/null +++ b/assets/index.html-4J_SM0OC.js @@ -0,0 +1 @@ +import{_ as a,r as o,o as n,c as s,a as r,b as e}from"./app-BcH8wZQx.js";const c={},l=e("h1",{id:"主题",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#主题"},[e("span",null,"主题")])],-1);function m(i,h){const t=o("Catalog");return n(),s("div",null,[l,r(t,{level:1})])}const _=a(c,[["render",m],["__file","index.html.vue"]]),p=JSON.parse('{"path":"/zh/themes/","title":"主题","lang":"zh-CN","frontmatter":{},"headers":[],"git":{"updatedTime":1708364547000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"zh/themes/README.md"}');export{_ as comp,p as data}; diff --git a/assets/index.html-B9g5ZyHl.js b/assets/index.html-B9g5ZyHl.js new file mode 100644 index 0000000000..89907f59f2 --- /dev/null +++ b/assets/index.html-B9g5ZyHl.js @@ -0,0 +1,11 @@ +import{_ as n,r as a,o as l,c as o,a as i,b as s,e as p}from"./app-BcH8wZQx.js";const c={},t=s("h1",{id:"seo",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#seo"},[s("span",null,"seo")])],-1),r=p(`Usage
npm i -D @vuepress/plugin-seo@next
+import { seoPlugin } from '@vuepress/plugin-seo'
+
+export default {
+ plugins: [
+ seoPlugin({
+ // options
+ }),
+ ],
+}
+Usage
npm i -D @vuepress/plugin-pwa@next
+import { pwaPlugin } from '@vuepress/plugin-pwa'
+
+export default {
+ plugins: [
+ pwaPlugin({
+ // options
+ }),
+ ],
+}
+使用
npm i -D @vuepress/plugin-seo@next
+import { seoPlugin } from '@vuepress/plugin-seo'
+
+export default {
+ plugins: [
+ seoPlugin({
+ // 选项
+ }),
+ ],
+}
+Usage
npm i -D @vuepress/plugin-sitemap@next
+import { sitemapPlugin } from '@vuepress/plugin-sitemap'
+
+export default {
+ plugins: [
+ sitemapPlugin({
+ // options
+ }),
+ ],
+}
+使用
npm i -D @vuepress/plugin-pwa@next
+import { pwaPlugin } from '@vuepress/plugin-pwa'
+
+export default {
+ plugins: [
+ pwaPlugin({
+ // 选项
+ }),
+ ],
+}
+使用
npm i -D @vuepress/plugin-feed@next
+import { feedPlugin } from '@vuepress/plugin-feed'
+
+export default {
+ plugins: [
+ feedPlugin({
+ // 选项
+ }),
+ ],
+}
+安装默认主题：
npm i -D @vuepress/theme-default@next
+在配置文件中指定主题：
import { defaultTheme } from '@vuepress/theme-default'
+
+export default {
+ theme: defaultTheme({
+ // 在这里添加主题配置
+ }),
+}
+使用
npm i -D @vuepress/plugin-blog@next
+import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ plugins: [
+ blogPlugin({
+ // 选项
+ }),
+ ],
+}
+Usage
npm i -D @vuepress/plugin-blog@next
+import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ plugins: [
+ blogPlugin({
+ // options
+ }),
+ ],
+}
+使用
npm i -D @vuepress/plugin-sitemap@next
+import { sitemapPlugin } from '@vuepress/plugin-sitemap'
+
+export default {
+ plugins: [
+ sitemapPlugin({
+ // 选项
+ }),
+ ],
+}
+Usage
npm i -D @vuepress/plugin-feed@next
+import { feedPlugin } from '@vuepress/plugin-feed'
+
+export default {
+ plugins: [
+ feedPlugin({
+ // options
+ }),
+ ],
+}
+Install @vuepress/theme-default :
npm install @vuepress/theme-default@next
+import { defaultTheme } from '@vuepress/theme-default'
+
+export default {
+ theme: defaultTheme({
+ // set theme config here
+ }),
+}
+selectLanguageAriaLabel
Type:
stringDetails:
Specify the
aria-labelattribute of the select language menu.This is mainly for a11y purpose.
selectLanguageName
',3),w=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),T=e("p",null,"Details:",-1),E=e("p",null,"Specify the name of the language of a locale.",-1),L=e("strong",null,"only take effect inside",-1),S=e("em",null,"select language menu",-1),N=e("li",null,[e("p",null,"Example:")],-1),F=t(`export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+ theme: defaultTheme({
+ locales: {
+ '/': {
+ selectLanguageName: 'English',
+ },
+ '/zh/': {
+ selectLanguageName: '简体中文',
+ },
+ },
+ }),
+}
+navbarLabel
Type:
null | stringDetails:
aria-labelvalue for main navigation in navbar.
pageNavbarLabel
Type:
null | stringDetails:
aria-labelvalue for next/previous page navigation.
editLinkText
Type:
stringDefault:
'Edit this page'Details:
Specify the text of the edit this page link.
lastUpdatedText
Type:
stringDefault:
'Last Updated'Details:
Specify the text of the last updated timestamp label.
contributorsText
Type:
stringDefault:
'Contributors'Details:
Specify the text of the contributors list label.
tip
`,12),I=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),A=e("li",null,[e("p",null,[l("Default: "),e("code",null,"'TIP'")])],-1),R=e("p",null,"Details:",-1),U=e("h2",{id:"warning",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#warning"},[e("span",null,"warning")])],-1),B=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),M=e("li",null,[e("p",null,[l("Default: "),e("code",null,"'WARNING'")])],-1),P=e("p",null,"Details:",-1),V=e("h2",{id:"danger",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#danger"},[e("span",null,"danger")])],-1),z=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),H=e("li",null,[e("p",null,[l("Default: "),e("code",null,"'DANGER'")])],-1),W=e("p",null,"Details:",-1),G=t('notFound
Type:
string[]Default:
['Not Found']Details:
Specify the messages of the 404 page.
The message will be randomly picked from the array when users enter the 404 page.
backToHome
Type:
stringDefault:
'Back to home'Details:
Specify the text of the back to home link in the 404 page.
openInNewWindow
',5),j=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),J=e("li",null,[e("p",null,[l("Default: "),e("code",null,"'open in new window'")])],-1),O=e("p",null,"Details:",-1),q=e("code",null,"sr-only",-1),K=e("p",null,"This is mainly for a11y purpose.",-1),Q=e("p",null,"Also see:",-1),X=e("h2",{id:"togglecolormode",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#togglecolormode"},[e("span",null,"toggleColorMode")])],-1),Y=e("li",null,[e("p",null,[l("Type: "),e("code",null,"string")])],-1),Z=e("li",null,[e("p",null,[l("Default: "),e("code",null,"'toggle color mode'")])],-1),$=e("li",null,[e("p",null,"Details:"),e("p",null,"Title text for the color mode toggle button."),e("p",null,"This is mainly for a11y purpose.")],-1),ee=e("p",null,"Also see:",-1),le=t('toggleSidebar
Type:
stringDefault:
'toggle sidebar'Details:
Title text for sidebar toggle button.
This is mainly for a11y purpose.
selectLanguageAriaLabel
类型：
string详情：
选择语言菜单 的
aria-label属性。它主要是为了站点的可访问性 (a11y) 。
selectLanguageName
',3),L=l("li",null,[l("p",null,[e("类型： "),l("code",null,"string")])],-1),A=l("p",null,"详情：",-1),N=l("p",null,"Locale 的语言名称。",-1),z=l("em",null,"选择语言菜单",-1),T=l("li",null,[l("p",null,"示例：")],-1),F=t(`export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+ theme: defaultTheme({
+ locales: {
+ '/': {
+ selectLanguageName: 'English',
+ },
+ '/zh/': {
+ selectLanguageName: '简体中文',
+ },
+ },
+ }),
+}
+navbarLabel
类型：
null | string详情：
导航栏中主导航
aria-label属性的值。
pageNavbarLabel
类型：
null | string详情：
下一页/上一页导航
aria-label属性的值
editLinkText
类型：
string默认值：
'Edit this page'详情：
编辑此页 链接的文字。
lastUpdatedText
类型：
string默认值：
'Last Updated'详情：
最近更新时间戳 标签的文字。
contributorsText
类型：
string默认值：
'Contributors'详情：
贡献者列表 标签的文字。
tip
`,12),B=l("li",null,[l("p",null,[e("类型： "),l("code",null,"string")])],-1),I=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"'TIP'")])],-1),S=l("p",null,"详情：",-1),R=l("h2",{id:"warning",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#warning"},[l("span",null,"warning")])],-1),M=l("li",null,[l("p",null,[e("类型： "),l("code",null,"string")])],-1),U=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"'WARNING'")])],-1),V=l("p",null,"详情：",-1),W=l("h2",{id:"danger",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#danger"},[l("span",null,"danger")])],-1),H=l("li",null,[l("p",null,[e("类型： "),l("code",null,"string")])],-1),P=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"'DANGER'")])],-1),G=l("p",null,"详情：",-1),j=t('notFound
类型：
string[]默认值：
['Not Found']详情：
404 页面的提示信息。
当用户进入 404 页面时，会从数组中随机选取一条信息进行展示。
backToHome
类型：
string默认值：
'Back to home'详情：
404 页面中 返回首页 链接的文字。
openInNewWindow
',5),J=l("li",null,[l("p",null,[e("类型： "),l("code",null,"string")])],-1),O=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"'open in new window'")])],-1),q=l("p",null,"详情：",-1),K=l("code",null,"sr-only",-1),Q=l("p",null,"它主要是为了站点的可访问性 (a11y) 。",-1),X=l("p",null,"参考：",-1),Y=l("h2",{id:"togglecolormode",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#togglecolormode"},[l("span",null,"toggleColorMode")])],-1),Z=l("li",null,[l("p",null,[e("类型： "),l("code",null,"string")])],-1),$=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"'toggle color mode'")])],-1),ll=l("li",null,[l("p",null,"详情："),l("p",null,"切换颜色模式按钮的标题文字。"),l("p",null,"它主要是为了站点的可访问性 (a11y) 。")],-1),el=l("p",null,"参考：",-1),nl=t('toggleSidebar
类型：
string默认值：
'toggle sidebar'详情：
切换侧边栏按钮的标题文字。
它主要是为了站点的可访问性 (a11y) 。
Usage:
::: <type> [title]
+[content]
+:::
+The type is required, and the title and content are optional.
Supported type :
Input
::: tip
+This is a tip
+:::
+
+::: warning
+This is a warning
+:::
+
+::: danger
+This is a dangerous warning
+:::
+
+::: details
+This is a details block
+:::
+Output
TIP
This is a tip
WARNING
This is a warning
DANGER
This is a dangerous warning
This is a details block
- Example 2 (custom title):
Input
::: danger STOP
+Danger zone, do not proceed
+:::
+
+::: details Click me to view the code
+
+\`\`\`ts
+console.log('Hello, VuePress!')
+\`\`\`
+
+:::
+Output
STOP
Danger zone, do not proceed
Click me to view the code
console.log('Hello, VuePress!')
+- Example 3 (code group alias):
Input
:::: code-group
+::: code-group-item FOO
+
+\`\`\`ts
+const foo = 'foo'
+\`\`\`
+
+:::
+
+::: code-group-item BAR
+
+\`\`\`ts
+const bar = 'bar'
+\`\`\`
+
+:::
+::::
+Output
`,17),f=s("div",{class:"language-typescript line-numbers-mode","data-ext":"ts","data-title":"ts"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#4FC1FF"}}," foo"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},"'foo'")]),n(` +`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1),x=s("div",{class:"language-typescript line-numbers-mode","data-ext":"ts","data-title":"ts"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#4FC1FF"}}," bar"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},"'bar'")]),n(` +`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1);function w(F,T){const t=e("NpmBadge"),i=e("RouteLink"),o=e("CodeGroupItem"),p=e("CodeGroup");return r(),u("div",null,[m,a(t,{package:"@vuepress/theme-default"}),v,s("ul",null,[s("li",null,[b,s("ul",null,[y,g,h,_,s("li",null,[n("Alias of "),a(i,{to:"/themes/default/components.html#codegroup"},{default:l(()=>[n("CodeGroup")]),_:1}),n(" and "),a(i,{to:"/themes/default/components.html#codegroupitem"},{default:l(()=>[n("CodeGroupItem")]),_:1}),n(": "),k])])]),C]),E,a(p,null,{default:l(()=>[a(o,{title:"FOO"},{default:l(()=>[f]),_:1}),a(o,{title:"BAR"},{default:l(()=>[x]),_:1})]),_:1})])}const O=d(D,[["render",w],["__file","markdown.html.vue"]]),A=JSON.parse('{"path":"/themes/default/markdown.html","title":"Markdown","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"Custom Containers","slug":"custom-containers","link":"#custom-containers","children":[]}],"git":{"updatedTime":1706605723000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"themes/default/markdown.md"}');export{O as comp,A as data}; diff --git a/assets/markdown.html-WIfWTHgC.js b/assets/markdown.html-WIfWTHgC.js new file mode 100644 index 0000000000..42bd1b2f81 --- /dev/null +++ b/assets/markdown.html-WIfWTHgC.js @@ -0,0 +1,50 @@ +import{_ as d,r as e,o as r,c as u,a as n,b as s,w as a,d as l,e as p}from"./app-BcH8wZQx.js";const D={},m=s("h1",{id:"markdown",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#markdown"},[s("span",null,"Markdown")])],-1),v=s("h2",{id:"自定义容器",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#自定义容器"},[s("span",null,"自定义容器")])],-1),b=p(`使用：
::: <type> [title]
+[content]
+:::
+type 是必需的， title 和 content 是可选的。
支持的 type 有：
输入
::: tip
+这是一个提示
+:::
+
+::: warning
+这是一个警告
+:::
+
+::: danger
+这是一个危险警告
+:::
+
+::: details
+这是一个 details 标签
+:::
+输出
提示
这是一个提示
注意
这是一个警告
警告
这是一个危险警告
这是一个 details 标签
- 示例 2 （自定义标题）：
输入
::: danger STOP
+危险区域，禁止通行
+:::
+
+::: details 点击查看代码
+
+\`\`\`ts
+console.log('你好，VuePress！')
+\`\`\`
+
+:::
+输出
STOP
危险区域，禁止通行
点击查看代码
console.log('你好，VuePress！')
+- 示例 3 （Code Group 别名）：
输入
:::: code-group
+::: code-group-item FOO
+
+\`\`\`ts
+const foo = 'foo'
+\`\`\`
+
+:::
+
+::: code-group-item BAR
+
+\`\`\`ts
+const bar = 'bar'
+\`\`\`
+
+:::
+::::
+输出
`,17),f=s("div",{class:"language-typescript line-numbers-mode","data-ext":"ts","data-title":"ts"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#4FC1FF"}}," foo"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},"'foo'")]),l(` +`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1),x=s("div",{class:"language-typescript line-numbers-mode","data-ext":"ts","data-title":"ts"},[s("pre",{class:"shiki dark-plus",style:{"background-color":"#1E1E1E",color:"#D4D4D4"},tabindex:"0"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#4FC1FF"}}," bar"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},"'bar'")]),l(` +`),s("span",{class:"line"})])]),s("div",{class:"line-numbers","aria-hidden":"true"},[s("div",{class:"line-number"})])],-1);function w(F,N){const c=e("NpmBadge"),i=e("RouteLink"),o=e("CodeGroupItem"),t=e("CodeGroup");return r(),u("div",null,[m,n(c,{package:"@vuepress/theme-default"}),v,s("ul",null,[s("li",null,[b,s("ul",null,[y,g,h,_,s("li",null,[n(i,{to:"/zh/themes/default/components.html#codegroup"},{default:a(()=>[l("CodeGroup")]),_:1}),l(" 和 "),n(i,{to:"/zh/themes/default/components.html#codegroupitem"},{default:a(()=>[l("CodeGroupItem")]),_:1}),l(" 的别名： "),k])])]),C]),E,n(t,null,{default:a(()=>[n(o,{title:"FOO"},{default:a(()=>[f]),_:1}),n(o,{title:"BAR"},{default:a(()=>[x]),_:1})]),_:1})])}const G=d(D,[["render",w],["__file","markdown.html.vue"]]),O=JSON.parse('{"path":"/zh/themes/default/markdown.html","title":"Markdown","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"自定义容器","slug":"自定义容器","link":"#自定义容器","children":[]}],"git":{"updatedTime":1706605723000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"zh/themes/default/markdown.md"}');export{G as comp,O as data}; diff --git a/assets/medium-zoom.html-BzW9Wo-K.js b/assets/medium-zoom.html-BzW9Wo-K.js new file mode 100644 index 0000000000..b601e684b1 --- /dev/null +++ b/assets/medium-zoom.html-BzW9Wo-K.js @@ -0,0 +1,31 @@ +import{_ as p,r as o,o as c,c as t,a as e,b as s,d as n,e as a}from"./app-BcH8wZQx.js";const r={},d=s("h1",{id:"medium-zoom",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#medium-zoom"},[s("span",null,"medium-zoom")])],-1),m={href:"https://github.com/francoischalifour/medium-zoom#readme",target:"_blank",rel:"noopener noreferrer"},u=a(`该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-medium-zoom@next
+import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom'
+
+export default {
+ plugins: [
+ mediumZoomPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
selector
类型：
string默认值：
':not(a) > img'详情：
可缩放的图片的选择器。
默认情况下，该插件会使
<a>标签以外的所有图片都支持缩放。
delay
类型：
number默认值：
500详情：
以毫秒为单位的延迟。
在切换路由进入一个新页面时，该插件会在一定延迟后才使页面内的图片支持缩放。
zoomOptions
`,10),D=s("li",null,[s("p",null,[n("类型： "),s("code",null,"Object")])],-1),h=s("li",null,[s("p",null,"详情："),s("p",null,"medium-zoom 的配置项。")],-1),v=s("p",null,"参考：",-1),y={href:"https://github.com/francoischalifour/medium-zoom#options",target:"_blank",rel:"noopener noreferrer"},b=a(`样式
你可以通过 zoomOptions 对大部分的缩放样式进行自定义，不过作为补充，该插件同样提供了一些 CSS 变量：
:root {
+ --medium-zoom-z-index: 100;
+ --medium-zoom-bg-color: #ffffff;
+ --medium-zoom-opacity: 1;
+}
+Composition API
useMediumZoom
`,5),C=s("p",null,"详情：",-1),_=s("code",null,"Zoom",-1),g={href:"https://github.com/francoischalifour/medium-zoom#methods",target:"_blank",rel:"noopener noreferrer"},f=s("p",null,"该插件会在切换路由进入当前页面时使图片支持缩放。但如果你要动态添加新图片，那么你可能就需要这个方法来让这些新图片也支持缩放。",-1),z=s("p",null,[n("该插件在 "),s("code",null,"Zoom"),n(" 实例上额外添加了一个 "),s("code",null,"refresh"),n(" 方法，它将使用 "),s("a",{href:"#selector"},"selector"),n(" 作为默认参数，先调用 "),s("code",null,"zoom.detach()"),n(" 再调用 "),s("code",null,"zoom.attach()"),n(" ，便于你快速刷新当前页面图片的缩放状态。")],-1),k=s("li",null,[s("p",null,"示例：")],-1),E=a(`import { nextTick } from 'vue'
+import { useMediumZoom } from '@vuepress/plugin-medium-zoom/client'
+
+export default {
+ setup() {
+ const zoom = useMediumZoom()
+
+ // ... 进行了一些操作，在当前页面添加了新的图片
+
+ // 此时你可能需要手动调用 \`refresh\` 来让这些新图片支持缩放
+ nextTick(() => {
+ zoom.refresh()
+ })
+ },
+}
+This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-medium-zoom@next
+import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom'
+
+export default {
+ plugins: [
+ mediumZoomPlugin({
+ // options
+ }),
+ ],
+}
+Options
selector
Type:
stringDefault:
':not(a) > img'Details:
Selector of zoomable images.
By default this plugin will make all images zoomable except those inside
<a>tags.
delay
Type:
numberDefault:
500Details:
Delay in milliseconds.
After navigating to a new page, this plugin will make images zoomable with a delay.
zoomOptions
`,10),h=s("li",null,[s("p",null,[e("Type: "),s("code",null,"Object")])],-1),D=s("li",null,[s("p",null,"Details:"),s("p",null,"Options for medium-zoom.")],-1),y=s("p",null,"Also see:",-1),v={href:"https://github.com/francoischalifour/medium-zoom#options",target:"_blank",rel:"noopener noreferrer"},g=a(`Styles
You can customize most of the zoom styles via zoomOptions, while this plugin also provides some CSS variables for additional customization:
:root {
+ --medium-zoom-z-index: 100;
+ --medium-zoom-bg-color: #ffffff;
+ --medium-zoom-opacity: 1;
+}
+Composition API
useMediumZoom
`,5),b=s("p",null,"Details:",-1),C=s("code",null,"Zoom",-1),f={href:"https://github.com/francoischalifour/medium-zoom#methods",target:"_blank",rel:"noopener noreferrer"},_=s("p",null,"This plugin will make images zoomable after navigating to current page. But if you are going to add new images dynamically, you may need this method to make those new images zoomable, too.",-1),z=s("p",null,[e("This plugin adds an extra "),s("code",null,"refresh"),e(" method on the "),s("code",null,"Zoom"),e(" instance, which will call "),s("code",null,"zoom.detach()"),e(" then "),s("code",null,"zoom.attach()"),e(" with the "),s("a",{href:"#selector"},"selector"),e(" as the default parameter. It will help you to refresh the zoomable images for current page.")],-1),k=s("li",null,[s("p",null,"Example:")],-1),x=a(`import { nextTick } from 'vue'
+import { useMediumZoom } from '@vuepress/plugin-medium-zoom/client'
+
+export default {
+ setup() {
+ const zoom = useMediumZoom()
+
+ // ... do something to add new images in current page
+
+ // then you may need to call \`refresh\` manually to make those new images zoomable
+ nextTick(() => {
+ zoom.refresh()
+ })
+ },
+}
+This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-nprogress@next
+import { nprogressPlugin } from '@vuepress/plugin-nprogress'
+
+export default {
+ plugins: [nprogressPlugin()],
+}
+Styles
You can customize the style of the progress bar via CSS variables:
:root {
+ --nprogress-color: #29d;
+ --nprogress-z-index: 1031;
+}
+该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-nprogress@next
+import { nprogressPlugin } from '@vuepress/plugin-nprogress'
+
+export default {
+ plugins: [nprogressPlugin()],
+}
+样式
你可以通过 CSS 变量来自定义进度条的样式：
:root {
+ --nprogress-color: #29d;
+ --nprogress-z-index: 1031;
+}
+Page Related
These functions generate common information for your pages.
getPageExcerpt
Get the excerpt of the page.
export interface PageExcerptOptions {
+ /**
+ * Excerpt separator
+ *
+ * @default "<!-- more -->"
+ */
+ separator?: string
+
+ /**
+ * Length of excerpt
+ *
+ * @description Excerpt length will be the minimal possible length reaching this value
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * Tags which is considered as custom elements
+ *
+ * @description This is used to determine whether a tag is a custom element since all unknown tags are removed in excerpt.
+ */
+ isCustomElement?: (tagName: string) => boolean
+
+ /**
+ * Whether keep page title (first h1) in excerpt
+ *
+ * @default false
+ */
+ keepPageTitle?: boolean
+
+ /**
+ * Whether preserve tags like line numbers and highlight lines for code blocks
+ *
+ * @default false
+ */
+ keepFenceDom?: boolean
+}
+
+export const getPageExcerpt: (
+ app: App,
+ page: Page,
+ options?: PageExcerptOptions,
+) => string
+getPageText
Get plain text of the page.
export interface PageTextOptions {
+ /**
+ * Whether convert text to single line content
+ *
+ * @default false
+ */
+ singleLine?: boolean
+
+ /**
+ * Length of text
+ *
+ * @description Text length will be the minimal possible length reaching this value
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * Tags to be removed
+ *
+ * @description Table and code blocks are removed by default.
+ *
+ * @default ['table', 'pre']
+ */
+ removedTags?: string[]
+}
+
+export const getPageText: (
+ app: App,
+ page: Page,
+ options?: PageTextOptions,
+) => string
+页面相关
这些函数为你的页面生成常见信息。
getPageExcerpt
获取页面摘要。
export interface PageExcerptOptions {
+ /**
+ * 摘要分隔符
+ *
+ * @default "<!-- more -->"
+ */
+ separator?: string
+
+ /**
+ * 摘要的长度
+ *
+ * @description 摘要的长度会尽可能的接近这个值
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * 被认为是自定义元素的标签
+ *
+ * @description 用于判断一个标签是否是自定义元素，因为在摘要中，所有的未知标签都会被移除。
+ */
+ isCustomElement?: (tagName: string) => boolean
+
+ /**
+ * 是否保留页面标题 (第一个 h1)
+ *
+ * @default false
+ */
+ keepPageTitle?: boolean
+
+ /**
+ * 是否保留代码块的标签，诸如行号和高亮行
+ *
+ * @default false
+ */
+ keepFenceDom?: boolean
+}
+
+export const getPageExcerpt: (
+ app: App,
+ page: Page,
+ options?: PageExcerptOptions,
+) => string
+getPageText
获取页面纯文本。
export interface PageTextOptions {
+ /**
+ * 是否将文字转换成单行内容
+ *
+ * @default false
+ */
+ singleLine?: boolean
+
+ /**
+ * 文字的长度
+ *
+ * @description 文字的长度会尽可能的接近这个值
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * 需要移除的标签
+ *
+ * @description 默认情况下表格和代码块会被移除
+ *
+ * @default ['table', 'pre']
+ */
+ removedTags?: string[]
+}
+
+export const getPageText: (
+ app: App,
+ page: Page,
+ options?: PageTextOptions,
+) => string
+Provide palette support for your theme.
This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
For theme authors, this plugin will help you to provide styles customization for users.
Usage
npm i -D @vuepress/plugin-palette@next
+import { palettePlugin } from '@vuepress/plugin-palette'
+
+export default {
+ plugins: [
+ palettePlugin({
+ // options
+ }),
+ ],
+}
+Palette and Style
This plugin will provide a @vuepress/plugin-palette/palette (palette file) and a @vuepress/plugin-palette/style (style file) to be imported in your theme styles.
The style file is used for overriding the default styles or adding extra styles, so it's likely to be imported at the end of your theme styles.
Usage
Use this plugin in your theme, assuming you are using SASS:
export default {
+ // ...
+ plugins: [palettePlugin({ preset: 'sass' })],
+}
+Usage of Palette
Import the plugin's palette file where your theme needs to use the corresponding variables, such as in the Layout.vue file:
<template>
+ <h1 class="palette-title">Hello, Palette!</h1>
+</template>
+
+<style lang="scss">
+/* import variables from the plugin's palette file */
+@import '@vuepress/plugin-palette/palette';
+
+/* set default value for variables */
+$color: red !default;
+
+/* use variables in your styles */
+.palette-title {
+ color: $color;
+}
+</style>
+Then users can customize variables in .vuepress/styles/palette.scss:
$color: green;
+Usage of Style
Import the plugin's style file after your theme's styles, for example, in the clientConfigFile:
// import your theme's style file
+import 'path/to/your/theme/style'
+// import the plugin's style file
+import '@vuepress/plugin-palette/style'
+Then users can add extra styles in .vuepress/styles/index.scss and override the default styles of your theme:
h1 {
+ font-size: 2.5rem;
+}
+Options
preset
Type:
'css' | 'sass' | 'less' | 'stylus'Default:
'css'Details:
Set preset for other options.
If you don't need advanced customization of the plugin, it's recommended to only set this option and omit other options.
userPaletteFile
Type:
stringDefault:
- css:
'.vuepress/styles/palette.css' - sass:
'.vuepress/styles/palette.scss' - less:
'.vuepress/styles/palette.less' - stylus:
'.vuepress/styles/palette.styl'
- css:
Details:
File path of the user palette file, relative to source directory.
The default value depends on the preset option.
The file is where users define style variables, and it's recommended to keep the default file path as a convention.
tempPaletteFile
Type:
stringDefault:
- css:
'styles/palette.css' - sass:
'styles/palette.scss' - less:
'styles/palette.less' - stylus:
'styles/palette.styl'
- css:
Details:
File path of the generated palette temp file, relative to temp directory.
The default value depends on the preset option.
You should import the palette file via
'@vuepress/plugin-palette/palette'alias, so you don't need to change this option in most cases.
userStyleFile
Type:
stringDefault:
- css:
'.vuepress/styles/index.css' - sass:
'.vuepress/styles/index.scss' - less:
'.vuepress/styles/index.less' - stylus:
'.vuepress/styles/index.styl'
- css:
Details:
File path of the user style file, relative to source directory.
The default value depends on the preset option.
The file is where users override default styles or add extra styles, and it's recommended to keep the default file path as a convention.
tempStyleFile
Type:
stringDefault:
- css:
'styles/index.css' - sass:
'styles/index.scss' - less:
'styles/index.less' - stylus:
'styles/index.styl'
- css:
Details:
File path of the generated style temp file, relative to temp directory.
The default value depends on the preset option.
You should import the style file via
'@vuepress/plugin-palette/style'alias, so you don't need to change this option in most cases.
importCode
Type:
(filePath: string) => stringDefault:
- css:
(filePath) => \`@import '\${filePath}';\\n\` - sass:
(filePath) => \`@forward 'file:///\${filePath}';\\n\` - less:
(filePath) => \`@import '\${filePath}';\\n\` - stylus:
(filePath) => \`@require '\${filePath}';\\n\`
- css:
Details:
Function to generate import code.
The default value depends on the preset option.
This option is used for generating tempPaletteFile and tempStyleFile, and you don't need to change this option in most cases.
为你的主题提供调色板功能。
该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。
对于主题作者，该插件可以帮助你提供用户自定义样式的能力。
使用方法
npm i -D @vuepress/plugin-palette@next
+import { palettePlugin } from '@vuepress/plugin-palette'
+
+export default {
+ plugins: [
+ palettePlugin({
+ // 配置项
+ }),
+ ],
+}
+调色板和样式
该插件会提供一个 @vuepress/plugin-palette/palette （调色板文件）和一个 @vuepress/plugin-palette/style （样式文件），用于在你的主题样式中引入。
样式文件用于覆盖默认样式或添加额外样式，因此它一般会在你主题样式的末尾引入。
使用
在你的主题中使用该插件，假设你使用 SASS 作为 CSS 预处理器：
export default {
+ // ...
+ plugins: [palettePlugin({ preset: 'sass' })],
+}
+使用调色板
在你主题需要使用对应变量的地方引入该插件的调色板文件，比如在 Layout.vue 中：
<template>
+ <h1 class="palette-title">你好，调色板！</h1>
+</template>
+
+<style lang="scss">
+/* 从该插件的调色板中引入变量 */
+@import '@vuepress/plugin-palette/palette';
+
+/* 设置变量的默认值 */
+$color: red !default;
+
+/* 在你的样式中使用变量 */
+.palette-title {
+ color: $color;
+}
+</style>
+然后，用户就可以在 .vuepress/styles/palette.scss 中自定义变量：
$color: green;
+使用样式
在你主题的样式之后引入该插件的样式文件，比如在 clientConfigFile 中：
// 引入你主题本身的样式文件
+import 'path/to/your/theme/style'
+// 引入该插件的样式文件
+import '@vuepress/plugin-palette/style'
+然后，用户就可以在 .vuepress/styles/index.scss 中添加额外样式，并可以覆盖你主题本身的样式：
h1 {
+ font-size: 2.5rem;
+}
+配置项
preset
类型：
'css' | 'sass' | 'less' | 'stylus'默认值：
'css'详情：
设置其他选项的预设。
如果你没有对该插件进行进阶定制化的需要，建议只设置该配置项并忽略其他选项。
userPaletteFile
类型：
string默认值：
- css:
'.vuepress/styles/palette.css' - sass:
'.vuepress/styles/palette.scss' - less:
'.vuepress/styles/palette.less' - stylus:
'.vuepress/styles/palette.styl'
- css:
详情：
用户调色板文件的路径，是针对源文件目录的相对路径。
默认值依赖于 preset 配置项。
该文件用于用户定义样式变量，建议保持默认值作为约定的文件路径。
tempPaletteFile
类型：
string默认值：
- css:
'styles/palette.css' - sass:
'styles/palette.scss' - less:
'styles/palette.less' - stylus:
'styles/palette.styl'
- css:
详情：
生成的调色板临时文件的路径，是针对临时文件文件目录的相对路径。
默认值依赖于 preset 配置项。
你应该使用
'@vuepress/plugin-palette/palette'别名来引入调色板文件，因此在绝大多数情况下你不需要修改该配置项。
userStyleFile
类型：
string默认值：
- css:
'.vuepress/styles/index.css' - sass:
'.vuepress/styles/index.scss' - less:
'.vuepress/styles/index.less' - stylus:
'.vuepress/styles/index.styl'
- css:
详情：
用户样式文件的路径，是针对源文件目录的相对路径。
默认值依赖于 preset 配置项。
该文件用于用户覆盖默认样式和添加额外样式，建议保持默认值作为约定的文件路径。
tempStyleFile
类型：
string默认值：
- css:
'styles/index.css' - sass:
'styles/index.scss' - less:
'styles/index.less' - stylus:
'styles/index.styl'
- css:
详情：
生成的样式临时文件的路径，是针对临时文件文件目录的相对路径。
默认值依赖于 preset 配置项。
你应该使用
'@vuepress/plugin-palette/style'别名来引入样式文件，因此在绝大多数情况下你不需要修改该配置项。
importCode
类型：
(filePath: string) => string默认值：
- css:
(filePath) => \`@import '\${filePath}';\\n\` - sass:
(filePath) => \`@forward 'file:///\${filePath}';\\n\` - less:
(filePath) => \`@import '\${filePath}';\\n\` - stylus:
(filePath) => \`@require '\${filePath}';\\n\`
- css:
详情：
用于生成引入代码的函数。
默认值依赖于 preset 配置项。
该配置项用于生成 tempPaletteFile 和 tempStyleFile ，在绝大多数情况下你不需要修改该配置项。
此插件会使页面正文内的图片在点击时进入浏览模式浏览。
使用方法
npm i -D @vuepress/plugin-photo-swipe@next
+import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe'
+
+export default {
+ plugins: [
+ photoSwipePlugin({
+ // 选项
+ }),
+ ],
+}
+在图片预览模式中，你可以:
- 左右滑动按顺序浏览页面内其他的图片
- 查看图片的描述
- 对图片进行缩放
- 全屏浏览图片
- 下载图片
- 分享图片
提示
- 除了点击右上角的 "×" 退出浏览模式外，在上下滚动超过一定距离后，会自动退出图片浏览模式。
- 在移动端，或使用 PC 触控板，你可以使用平移、缩放手势在浏览模式中平移、缩放图片。
选项
selector
- 类型：
string | string[] - 默认值：
".theme-default-content :not(a) > img:not([no-view])" - 详情：图片选择器
scrollToClose
- 类型：
boolean - 默认值：
true - 详情：是否在滚动时关闭当前图片。
delay
类型：
number默认值：
800详情：
操作页面 DOM 的延时，单位 ms。
提示
如果你使用的主题有切换动画，建议配置此选项为
切换动画时长 + 200。
locales
类型：
PhotoSwipePluginLocaleConfiginterface PhotoSwipePluginLocaleData { + /** + * 关闭按钮标签文字 + */ + close: string + + /** + * 全屏按钮标签文字 + */ + fullscreen: string + + /** + * 分享按钮标签文字 + */ + share: string + + /** + * 缩放按钮标签文字 + */ + zoom: string + + /** + * 上一张图片按钮标签文字 + */ + prev: string + + /** + * 下一张图片按钮标签文字 + */ + next: string + + /** + * 功能按钮配置 + */ + buttons: PhotoSwipeDefaultUI.ShareButtonData[] +} + +interface PhotoSwipePluginLocaleConfig { + [localePath: string]: PhotoSwipePluginLocaleData +} +详情：Photo Swipe 插件的国际化配置。
示例：
import { defineUserConfig } from 'vuepress' +import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe' + +export default defineUserConfig({ + locales: { + '/': { + // 这是一个支持的语言 + lang: 'zh-CN', + }, + '/xx/': { + // 这是一个没有收到插件支持的语言 + lang: 'mm-NN', + }, + }, + + plugins: [ + photoSwipePlugin({ + locales: { + '/': { + // 覆盖分享标签文字 + share: '分享给伙伴', + }, + + '/xx/': { + // 在这里完整设置 \`mm-NN\` 的多语言配置 + }, + }, + }), + ], +}) +
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
Frontmatter
photoswipe
类型：
string | false详情：
当前页面的图片选择器或
false以在当前页面中禁用 photo-swipe。
客户端配置
definePhotoSwipeConfig
`,22),y={href:"http://photoswipe.com/",target:"_blank",rel:"noopener noreferrer"},v=s("code",null,"photo-swipe",-1),u=e(`import { definePhotoSwipeConfig } from '@vuepress/plugin-photo-swipe/client'
+
+definePhotoSwipeConfig({
+ // 在此设置 photoswipe 选项
+})
+
+export default {}
+API
你可以通过 API 来调用 photoswipe。
createPhotoSwipe 允许你以编程的方式查看图片链接:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue';
+import { createPhotoSwipe } from "@vuepress/plugin-photo-swipe/client";
+
+let state: PhotoSwipeState | null = null;
+
+const openPhotoSwipe = (index: number) => {
+ state?.open(index - 1);
+};
+
+onMounted(async () => {
+ // 通过图片链接创建一个新的 photoswipe 实例
+ state= await createPhotoSwipe(
+ [
+ 'https://exmaple.com/image1.png'
+ 'https://exmaple.com/image2.png'
+ 'https://exmaple.com/image3.png'
+ ],
+ {
+ // photoswipe 选项
+ }
+ );
+});
+
+onUnmounted(() => {
+ state?.destroy()
+})
+</script>
+
+<template>
+ <button v-for="i in 3" @click="openPhotoSwipe(i)">open photo {{ i }}</button>
+</template>
+registerPhotoSwipe 允许你为给定的图片元素注册 photoswipe:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue'
+import { registerPhotoSwipe } from '@vuepress/plugin-photo-swipe/client'
+
+let destroy: () => void | null = null
+
+onMounted(async () => {
+ await nextTick()
+
+ const images = Array.from(document.querySelectorAll('img'))
+
+ // 通过图片元素创建一个新的 photoswipe 实例
+ state = await registerPhotoSwipe(images, {
+ // photoswipe 选项
+ })
+})
+
+onUnmounted(() => {
+ destroy?.()
+})
+</script>
+样式
你可以通过 CSS 变量来自定义部分样式：
:root {
+ --photo-swipe-bullet: #fff;
+ --photo-swipe-bullet-active: #3eaf7c;
+}
+This plugin will make the pictures in the body of the page enter the preview mode when clicked.
Usage
npm i -D @vuepress/plugin-photo-swipe@next
+import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe'
+
+export default {
+ plugins: [
+ photoSwipePlugin({
+ // options
+ }),
+ ],
+}
+In preview mode, you can:
- Swipe left and right to preview other pictures on the page in order
- View the description of the picture
- Zoom in and zoom out the picture
- View pictures in full screen
- Download pictures
- Share pictures
TIP
- Besides clicking "×" in the upper right corner to exit the preview mode, scrolling up and down more than a certain distance will also exit preview mode.
- On mobile devices, or using the PC trackpad, you can use pan and zoom gestures to pan and zoom in the preview mode.
Options
selector
- Type:
string | string[] - Default:
".theme-default-content :not(a) > img:not([no-view])" - Details: Image selector
scrollToClose
- Type:
boolean - Default:
true - Details: Whether close the current image when scrolling.
delay
Type:
numberDefault:
800Details:
The delay of operating dom, in ms.
TIP
If the theme you are using has a switching animation, it is recommended to configure this option to
Switch animation duration + 200.
locales
Type:
PhotoSwipePluginLocaleConfiginterface PhotoSwipePluginLocaleData { + /** + * Close button label text + */ + close: string + + /** + * Full screen button label text + */ + fullscreen: string + + /** + * Share button label text + */ + share: string + + /** + * Zoom button label text + */ + zoom: string + + /** + * Previous image button label text + */ + prev: string + + /** + * Next image button label text + */ + next: string + + /** + * Share button config + */ + buttons: PhotoSwipeDefaultUI.ShareButtonData[] +} + +interface PhotoSwipePluginLocaleConfig { + [localePath: string]: PhotoSwipePluginLocaleData +} +Details: Locales config for photo-swipe plugin.
Example:
import { defineUserConfig } from 'vuepress' +import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe' + +export default defineUserConfig({ + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + photoSwipePlugin({ + locales: { + '/': { + // Override share label text + share: 'Share with friends', + }, + + '/xx/': { + // Complete locale config for \`mm-NN\` language here + }, + }, + }), + ], +}) +
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Frontmatter
- Type:
string | false - Details:
Image selector for the current page, or false to disable photo-swipe in current page.
Client Config
definePhotoSwipeConfig
`,22),y={href:"http://photoswipe.com/",target:"_blank",rel:"noopener noreferrer"},u=s("code",null,"photo-swipe",-1),v=a(`import { definePhotoSwipeConfig } from '@vuepress/plugin-photo-swipe/client'
+
+definePhotoSwipeConfig({
+ // set photoswipe options here
+})
+
+export default {}
+API
You can also call photoswipe with apis.
createPhotoSwipe allows you to programmatically view images links with PhotoSwipe:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue';
+import { createPhotoSwipe } from "@vuepress/plugin-photo-swipe/client";
+
+let state: PhotoSwipeState | null = null;
+
+const openPhotoSwipe = (index: number) => {
+ state?.open(index - 1);
+};
+
+onMounted(async () => {
+ // create a new photoswipe instance with image links
+ state= await createPhotoSwipe(
+ [
+ 'https://exmaple.com/image1.png'
+ 'https://exmaple.com/image2.png'
+ 'https://exmaple.com/image3.png'
+ ],
+ {
+ // photoswipe options
+ }
+ );
+});
+
+onUnmounted(() => {
+ state?.destroy()
+})
+</script>
+
+<template>
+ <button v-for="i in 3" @click="openPhotoSwipe(i)">open photo {{ i }}</button>
+</template>
+registerPhotoSwipe allows you to register photoswipe for the given image elements:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue'
+import { registerPhotoSwipe } from '@vuepress/plugin-photo-swipe/client'
+
+let destroy: () => void | null = null
+
+onMounted(async () => {
+ await nextTick()
+
+ const images = Array.from(document.querySelectorAll('img'))
+
+ // create a new photoswipe instance on image elements
+ state = await registerPhotoSwipe(images, {
+ // photoswipe options
+ })
+})
+
+onUnmounted(() => {
+ destroy?.()
+})
+</script>
+Styles
You can customize the style via CSS variables:
:root {
+ --photo-swipe-bullet: #fff;
+ --photo-swipe-bullet-active: #3eaf7c;
+}
+插件配置
你可以通过 themePlugins 设置默认主题使用的插件。
默认主题使用了一些插件，如果你确实不需要该插件，你可以选择禁用它。在禁用插件之前，请确保你已了解它的用途。
import { defaultTheme } from '@vuepress/theme-default'
+
+export default {
+ theme: defaultTheme({
+ themePlugins: {
+ // 在这里自定义主题插件
+ },
+ }),
+}
+themePlugins.activeHeaderLinks
`,5),h=l("li",null,[l("p",null,[e("类型： "),l("code",null,"boolean")])],-1),r=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"true")])],-1),m=l("p",null,"详情：",-1),g=l("h2",{id:"themeplugins-backtotop",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#themeplugins-backtotop"},[l("span",null,"themePlugins.backToTop")])],-1),_=l("li",null,[l("p",null,[e("类型： "),l("code",null,"BackToTopPluginOptions | boolean")])],-1),v=l("li",null,[l("p",null,[e("默认值： "),l("code",null,"true")])],-1),k=l("p",null,"详情：",-1),b=l("p",null,"支持对象格式以作为插件选项。",-1),f=l("h2",{id:"themeplugins-container",tabindex:"-1"},[l("a",{class:"header-anchor",href:"#themeplugins-container"},[l("span",null,"themePlugins.container")])],-1),D=l("li",null,[l("p",null,[e("类型： "),l("code",null,"RecordContainerType 类型为：
tipwarningdangerdetailscodeGroupcodeGroupItem
Plugins Config
You can configure the plugins that used by default theme with themePlugins.
Default theme is using some plugins by default. You can disable a plugin if you really do not want to use it. Make sure you understand what the plugin is for before disabling it.
import { defaultTheme } from '@vuepress/theme-default'
+
+export default {
+ theme: defaultTheme({
+ themePlugins: {
+ // customize theme plugins here
+ },
+ }),
+}
+themePlugins.activeHeaderLinks
`,5),h=e("li",null,[e("p",null,[l("Type: "),e("code",null,"boolean")])],-1),r=e("li",null,[e("p",null,[l("Default: "),e("code",null,"true")])],-1),m=e("p",null,"Details:",-1),g=e("h2",{id:"themeplugins-backtotop",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#themeplugins-backtotop"},[e("span",null,"themePlugins.backToTop")])],-1),_=e("li",null,[e("p",null,[l("Type: "),e("code",null,"BackToTopPluginOptions | boolean")])],-1),b=e("li",null,[e("p",null,[l("Default: "),e("code",null,"true")])],-1),f=e("p",null,"Details:",-1),v=e("p",null,"Object value is supported as plugin options.",-1),D=e("h2",{id:"themeplugins-container",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#themeplugins-container"},[e("span",null,"themePlugins.container")])],-1),y=e("li",null,[e("p",null,[l("Type: "),e("code",null,"RecordContainerType type is:
tipwarningdangerdetailscodeGroupcodeGroupItem
This plugin has been integrated into the default theme.
Notice that this plugin would only tokenize the code fence without adding styles. When using it with a custom theme, you may need to choose and import Prism.js style theme yourself.
Usage
npm i -D @vuepress/plugin-prismjs@next
+import { prismjsPlugin } from '@vuepress/plugin-prismjs'
+
+export default {
+ plugins: [
+ prismjsPlugin({
+ // options
+ }),
+ ],
+}
+Options
preloadLanguages
`,7),h=s("li",null,[s("p",null,[e("Type: "),s("code",null,"string[]")])],-1),g=s("li",null,[s("p",null,[e("Default: "),s("code",null,"['markdown', 'jsdoc', 'yaml']")])],-1),v=s("p",null,"Details:",-1),D=s("p",null,"Languages to preload.",-1),_=s("p",null,"By default, languages will be loaded on demand when parsing markdown files.",-1),y={href:"https://github.com/PrismJS/prism/issues/2716",target:"_blank",rel:"noopener noreferrer"};function b(f,k){const i=l("NpmBadge"),a=l("ExternalLinkIcon");return t(),p("div",null,[d,n(i,{package:"@vuepress/plugin-prismjs"}),s("p",null,[e("This plugin will enable syntax highlighting for markdown code fence with "),s("a",u,[e("Prism.js"),n(a)]),e(".")]),m,s("ul",null,[h,g,s("li",null,[v,D,_,s("p",null,[e("However, Prism.js has "),s("a",y,[e("some potential issues"),n(a)]),e(" about loading languages dynamically. To avoid them, you can preload languages via this option.")])])])])}const j=o(c,[["render",b],["__file","prismjs.html.vue"]]),x=JSON.parse('{"path":"/plugins/prismjs.html","title":"prismjs","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"Usage","slug":"usage","link":"#usage","children":[]},{"level":2,"title":"Options","slug":"options","link":"#options","children":[{"level":3,"title":"preloadLanguages","slug":"preloadlanguages","link":"#preloadlanguages","children":[]}]}],"git":{"updatedTime":1706605723000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"plugins/prismjs.md"}');export{j as comp,x as data}; diff --git a/assets/prismjs.html-C-Pt75oH.js b/assets/prismjs.html-C-Pt75oH.js new file mode 100644 index 0000000000..83d6e89ab5 --- /dev/null +++ b/assets/prismjs.html-C-Pt75oH.js @@ -0,0 +1,11 @@ +import{_ as r,r as l,o as p,c as o,a as e,b as s,d as n,e as t}from"./app-BcH8wZQx.js";const c={},d=s("h1",{id:"prismjs",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#prismjs"},[s("span",null,"prismjs")])],-1),u={href:"https://prismjs.com/",target:"_blank",rel:"noopener noreferrer"},m=t(`该插件已经集成到默认主题中。
需要注意的是，该插件仅会给代码块添加 HTML 标记，而不会添加样式。当你在一个自定义主题中使用它时，可能需要自己选择并引入 Prism.js 样式主题。
使用方法
npm i -D @vuepress/plugin-prismjs@next
+import { prismjsPlugin } from '@vuepress/plugin-prismjs'
+
+export default {
+ plugins: [
+ prismjsPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
preloadLanguages
`,7),h=s("li",null,[s("p",null,[n("类型： "),s("code",null,"string[]")])],-1),g=s("li",null,[s("p",null,[n("默认值： "),s("code",null,"['markdown', 'jsdoc', 'yaml']")])],-1),v=s("p",null,"详情：",-1),D=s("p",null,"需要预加载的语言。",-1),_=s("p",null,"默认情况下，语言会在解析 Markdown 文件时按需加载。",-1),b={href:"https://github.com/PrismJS/prism/issues/2716",target:"_blank",rel:"noopener noreferrer"};function y(k,C){const i=l("NpmBadge"),a=l("ExternalLinkIcon");return p(),o("div",null,[d,e(i,{package:"@vuepress/plugin-prismjs"}),s("p",null,[n("该插件使用 "),s("a",u,[n("Prism.js"),e(a)]),n(" 来为 Markdown 代码块启用代码高亮。")]),m,s("ul",null,[h,g,s("li",null,[v,D,_,s("p",null,[n("然而， Prism.js 在动态加载语言时可能会遇到 "),s("a",b,[n("一些潜在的问题"),e(a)]),n(" 。为了避免这些问题，你可以使用该配置项来预加载一些语言。")])])])])}const j=r(c,[["render",y],["__file","prismjs.html.vue"]]),x=JSON.parse('{"path":"/zh/plugins/prismjs.html","title":"prismjs","lang":"zh-CN","frontmatter":{},"headers":[{"level":2,"title":"使用方法","slug":"使用方法","link":"#使用方法","children":[]},{"level":2,"title":"配置项","slug":"配置项","link":"#配置项","children":[{"level":3,"title":"preloadLanguages","slug":"preloadlanguages","link":"#preloadlanguages","children":[]}]}],"git":{"updatedTime":1706605723000,"contributors":[{"name":"Mr.Hope","email":"mister-hope@outlook.com","commits":1}]},"filePathRelative":"zh/plugins/prismjs.md"}');export{j as comp,x as data}; diff --git a/assets/reading-time.html-CKM9bz7P.js b/assets/reading-time.html-CKM9bz7P.js new file mode 100644 index 0000000000..35571bb93a --- /dev/null +++ b/assets/reading-time.html-CKM9bz7P.js @@ -0,0 +1,95 @@ +import{_ as a,r as l,o as e,c as p,a as i,b as s,e as o}from"./app-BcH8wZQx.js";const c={},r=s("h1",{id:"reading-time",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#reading-time"},[s("span",null,"reading-time")])],-1),t=o(`此插件会为每个页面生成字数统计与预计阅读时间。
使用方法
npm i -D @vuepress/plugin-reading-time@next
+import { readingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default {
+ plugins: [
+ readingTimePlugin({
+ // 配置项
+ }),
+ ],
+}
+插件会将相关信息注入到页面数据的 readingTime，其中：
readingTime.minutes：为预计阅读时间（分钟）numberreadingTime.words：字数统计，number
在 Node 侧获取数据
对于任何页面，你可以从 page.data.readingTime 获取预计阅读时间与字数统计:
page.data.readingTime // { minutes: 3.2, words: 934 }
+你可以在 extendsPage 以及其他生命周期获取它做进一步处理:
export default {
+ // ...
+ extendsPage: (page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ },
+
+ onInitialized: (app) => {
+ app.pages.map((page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ })
+ },
+}
+在客户端侧获取数据
你可以从 @vuepress/plugin-reading-time/client 导入 useReadingTimeData 和 useReadingTimeLocale 来获取当前页面的阅读时间数据和语言环境数据：
<script setup lang="ts">
+import {
+ useReadingTimeData,
+ useReadingTimeLocale,
+} from '@vuepress/plugin-reading-time/client'
+
+const readingTimeData = useReadingTimeData() // { minutes: 1.1, words: 100 }
+const readingTimeLocale = useReadingTimeLocale() // { time: "1 分钟", words: "100 字" }
+</script>
+选项
wordPerMinute
- 类型：
number - 默认值：
300 - 详情： 每分钟阅读字数
locales
类型：
ReadingTimePluginLocaleConfiginterface ReadingTimePluginLocaleData { + /** + * 字数模板，模板中 \`$word\` 会被自动替换为字数 + */ + word: string + + /** + * 小于一分钟文字 + */ + less1Minute: string + + /** + * 时间模板 + */ + time: string +} + +interface ReadingTimePluginLocaleConfig { + [localePath: string]: ReadingTimePluginLocaleData +} +必填：否
详情：
阅读时间插件的国际化配置。
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
客户端 API
你可以从 @vuepress/plugin-reading-time/client 导入并使用这些 API：
即使插件被禁用，这些 API 也不会抛出错误。
useReadingTimeData
interface ReadingTime {
+ /** 分钟为单位的预计阅读时长 */
+ minutes: number
+ /** 内容的字数 */
+ words: number
+}
+
+const useReadingTimeData: () => ComputedRef<ReadingTime | null>
+当插件被禁用时会返回 null。
useReadingTimeLocale
interface ReadingTimeLocale {
+ /** 当前语言的预计阅读时间 */
+ time: string
+ /** 当前语言的字数文字 */
+ words: string
+}
+
+const useReadingTimeLocale: () => ComputedRef<ReadingTimeLocale>
+高级使用
由于此插件主要面向插件和主题开发者，所以提供了 "使用 API"：
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ useReadingTimePlugin(app, {
+ // 你的选项
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+为什么你应该使用 "使用 API"
当你多次注册一个插件时，vuepress 会给你一个警告，告诉你只有第一个插件会生效。
useReadingTimePlugin会自动检测插件是否已经注册，避免多次注册。如果你在
extendsPage生命周期访问阅读时间数据，那么@vuepress/plugin-reading-time必须在你的主题或插件之前被调用，否则你会得到未定义的page.data.readingTime。useReadingTimePlugin确保了@vuepress/plugin-reading-time在你的主题或插件之前被调用。
我们也提供了一个 removeReadingTimePlugin api 来移除插件。你可以使用它来确保你的调用生效或清除插件:
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ // 这会移除任何当前存在的阅读时间插件
+ removeReadingTimePlugin(app)
+
+ // 所以这会生效，即使之前已经注册了一个阅读时间插件
+ useReadingTimePlugin(app, {
+ // 你的选项
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+This plugin will generate word count and estimated reading time for each page.
Usage
npm i -D @vuepress/plugin-reading-time@next
+import { readingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default {
+ plugins: [
+ readingTimePlugin({
+ // options
+ }),
+ ],
+}
+The plugin will inject reading time information into the readingTime of the page data, where:
readingTime.minutes: estimated reading time (minutes)numberreadingTime.words: word countnumber
Getting data on Node Side
For any page, you can get estimated reading time and word count from page.data.readingTime:
page.data.readingTime // { minutes: 3.2, words: 934 }
+You can access it for further processing in the extendsPage lifecycle and other lifecycle:
export default {
+ // ...
+ extendsPage: (page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ },
+
+ onInitialized: (app) => {
+ app.pages.map((page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ })
+ },
+}
+Getting data on Client Side
You can import useReadingTimeData and useReadingTimeLocale from @vuepress/plugin-reading-time/client to get the reading time data and locale data of the current page:
<script setup lang="ts">
+import {
+ useReadingTimeData,
+ useReadingTimeLocale,
+} from '@vuepress/plugin-reading-time/client'
+
+const readingTimeData = useReadingTimeData() // { minutes: 1.1, words: 100 }
+const readingTimeLocale = useReadingTimeLocale() // { time: "1 minute", words: "100 words" }
+</script>
+Options
wordPerMinute
- Type:
number - Default:
300 - Details: Reading speed (words per minute)
locales
Type:
ReadingTimePluginLocaleConfiginterface ReadingTimePluginLocaleData { + /** + * Word template, \`$word\` will be automatically replaced by actual words + */ + word: string + + /** + * Text for less than one minute + */ + less1Minute: string + + /** + * Time template + */ + time: string +} + +interface ReadingTimePluginLocaleConfig { + [localePath: string]: ReadingTimePluginLocaleData +} +Required: No
Details:
Locales config for reading-time plugin.
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Client API
You can import and use these APIs from @vuepress/plugin-reading-time/client:
These APIs won't throw even you disable the plugin.
useReadingTimeData
interface ReadingTime {
+ /** Expect reading time in minute unit */
+ minutes: number
+ /** Words count of content */
+ words: number
+}
+
+const useReadingTimeData: () => ComputedRef<ReadingTime | null>
+null is returned when the plugin is disabled.
useReadingTimeLocale
interface ReadingTimeLocale {
+ /** Expect reading time text in locale */
+ time: string
+ /** Word count text in locale */
+ words: string
+}
+
+const useReadingTimeLocale: () => ComputedRef<ReadingTimeLocale>
+Advanced Usage
This plugin is targeting plugin and theme developers mostly, so we provide a "Use API":
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ useReadingTimePlugin(app, {
+ // your options
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+Why you should use "Use API"
- When you register a plugin multiple times, vuepress will gives you warning about that telling you only the first one takes effect. The
useReadingTimePluginautomatically detects if the plugin is registered and avoid registering multiple times. - If you access reading time data in
extendsPagelifecycle, then@vuepress/plugin-reading-timemust be called before your theme or plugin, otherwise you will getundefinedforpage.data.readingTime. TheuseReadingTimePluginensures that@vuepress/plugin-reading-timeis called before your theme or plugin.
We also provides a removeReadingTimePlugin api to remove the plugin.You can use this to ensure your call take effect or clear the plugin:
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ // this removes any existing reading time plugin at this time
+ removeReadingTimePlugin(app)
+
+ // so this will take effect even if there is a reading time plugin registered before
+ useReadingTimePlugin(app, {
+ // your options
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+This plugin can automatically handle redirects for your site.
Usage
npm i -D @vuepress/plugin-redirect@next
+import { redirectPlugin } from '@vuepress/plugin-redirect'
+
+export default {
+ plugins: [
+ redirectPlugin({
+ // options
+ }),
+ ],
+}
+Control Page Redirection
If you change the address of an existing page, you can use the redirectFrom option in Frontmatter to redirect to the address of this page, which ensures that users are redirected to the new address when they visit the old link.
If you need to redirect an existing page to a new page, you can use the redirectTo option in Frontmatter to set the address to redirect to. This way the page will redirect to the new address when accessed.
You can also set config with a redirect map in plugin options, see config for more details.
Auto Locales
The plugin can automatically redirect non-multilingual links to the multilingual pages the user needs based on the user's language preference.
To achieve this, you need to leave the default language directory (/) blank and set autoLocale: true in plugin options. The plugin will automatically redirect to the correct page according to the user's language.
I.E.: you need to set the following directory structure:
.
+├── en
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+├── zh
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+└── other_languages
+ ├── ...
+ ├── page.md
+ └── README.md
+And set locales in theme options with:
export default {
+ locales: {
+ '/en/': {
+ lang: 'en-US',
+ // ...
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ // ...
+ },
+ // other languages
+ },
+ // ...
+}
+So when a user accesses / or /page.html, they are automatically redirected to /en/ /en/page.html and /en/ /en/page.html based on current browser language.
Customizing fallback behavior
Sometimes, users may add more than one language to the system settings. By default, when a site supports a preferred language, but the page not exists for the preferred language, the plugin attempts to match the alternate language set by the user.
If you don't need to fall back to the user's alternate language, but directly match the user's preferred language, set localeFallback: false in the plugin options.
Customizing missing behavior
Sometimes, when a user visits a page, the document does not yet contain the language version the user needs (a common case is that the current page has not been localized in the relevant language), so the plugin needs to perform a default action, which you can customize by defaultBehavior in the plugin options:
"defaultLocale": Redirect to default language or first available language page (default behavior)"homepage": redirect to the home page in the current language (only available if the document contains the user's language)"404": Redirect to page 404 in current language (only available if the document contains the user's language)
Customizing default locale path
You can customize the default locale path by setting defaultLocale in the plugin options. By default, the plugin uses the first locale key in locales as the default language.
Automatically switch languages
The plugin supports automatically switching the link to the multilingual page that the user needs according to the user's language preference when opening a multilingual document. In order to achieve this, you need to set switchLocale in the plugin options, which can be the following two values:
direct: switch directly to the user language preference page without askingmodal: When the user's language preference is different from the current page language, show a modal asking whether to switch language
Customizing Locale Settings
By default, the plugin generates a locale setting by reading locale path and lang from the site's locales option. Sometimes, you may want multiple languages to hit the same path, in which case you should set localeConfig in plugin options.
For example, you might want all English users to match to /en/ and Chinese Traditional users to /zh/, then you can set:
redirect({
+ localeConfig: {
+ '/en/': ['en-US', 'en-UK', 'en'],
+ '/zh/': ['zh-CN', 'zh-TW', 'zh'],
+ },
+})
+Redirecting Sites
Sometimes you may change base or use new domain for your site, so you may want the original site automatically redirects to the new one.
To solve this, the plugin provide vp-redirect cli.
Usage:
+ $ vp-redirect generate [sourceDir]
+
+Options:
+ --hostname <hostname> Hostname to redirect to (E.g.: https://new.example.com/) (default: /)
+ -c, --config <config> Set path to config file
+ -o, --output <output> Set the output directory (default: .vuepress/redirect)
+ --cache <cache> Set the directory of the cache files
+ -t, --temp <temp> Set the directory of the temporary files
+ --clean-cache Clean the cache files before generation
+ --clean-temp Clean the temporary files before generation
+ -h, --help Display this message
+You need to pass in VuePress project source dir and also set the hostname option. The redirect helper cli will initialize your VuePress project to get pages, then generate and output the redirect html files to the output directory.
By default, the plugin will output to .vuepress/redirect directory under source directory. And you should upload it to your original site to provide redirection.
Options
config
Type:
Record<string, string> | ((app: App) => Record<string, string>)Details: Redirect map.
Example:
When base is set to
/base/:- redirect
/base/foo.htmlto/base/bar.html /base/baz.htmltohttps://example.com/qux.html.
redirect({ + config: { + '/foo.html': '/bar.html', + '/baz.html': 'https://example.com/qux.html', + }, +}) +Redirect post folder to posts folder:
redirect({ + hostname: 'https://example.com', + config: (app) => + Object.fromEntries( + app.pages + .filter(({ path }) => path.startsWith('/posts/')) + .map(({ path }) => [path.replace(/^\\/posts\\//, '/post/'), path]), + ), +}) +- redirect
autoLocale
- Type:
boolean - Default:
false - Details: Whether enable locales redirection.
switchLocale
Type:
"direct" | "modal" | falseDefault:
falseDetails:
Whether switch to a new locale based on user preference.
"direct": redirect to the new locale directly without asking"modal": show a modal to let user choose whether to switch to the new locale
localeConfig
Type:
Record<string, string | string[]>Details: Locale language config
localeFallback
- Type:
boolean - Default:
true - Details: Whether fallback to other locales user defined
defaultBehavior
- Type:
"defaultLocale" | "homepage" | "404" - Default:
"defaultLocale" - Details: Behavior when a locale version is not available for current link.
defaultLocale
- Type:
string - Default: the first locale
- Details: Default locale path.
Frontmatter
redirectFrom
- Type:
string | string[] - Details: The link which this page redirects from.
redirectTo
- Type:
string - Details: The link which this page redirects to.
Styles
You can customize the style of the redirect popup via CSS variables:
:root {
+ --redirect-z-index: 1499;
+ --redirect-bg-color: #fff;
+ --redirect-bg-color-light: #f3f4f5;
+ --redirect-bg-color-lighter: #eeeeee;
+ --redirect-text-color: #2c3e50;
+ --redirect-primary-bg-color: #3eaf7c;
+ --redirect-primary-hover-bg-color: #4abf8a;
+ --redirect-primary-text-color: #fff;
+}
+此插件提供页面与整站重定向功能。
使用方法
npm i -D @vuepress/plugin-redirect@next
+import { redirectPlugin } from '@vuepress/plugin-redirect'
+
+export default {
+ plugins: [
+ redirectPlugin({
+ // 配置项
+ }),
+ ],
+}
+设置重定向
如果你改动了已有页面的地址，你可以在 Frontmatter 中使用 redirectFrom 选项设置重定向到此页面的地址，这样可以保证用户在访问旧链接时重定向到新的地址。
如果你需要将已有的页面重定向到新的页面，可以在 Frontmatter 中使用 redirectTo 选项设置需要重定向到的地址。这样该页面会在访问时重定向到新的地址。
你还可以通过插件选项中的 config 设置一个重定向映射，详见 config。
自动多语言
插件可以根据用户的语言首选项，自动将无多语言链接重定向到用户需要的多语言页面。为了实现这一点，你需要留空默认的语言目录 (/)，并在插件选项中设置 autoLocale: true。插件会自动根据用户语言跳转到对应的语言页面。
也就是你需要设置以下目录结构:
.
+├── en
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+├── zh
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+└── other_languages
+ ├── ...
+ ├── page.md
+ └── README.md
+并将主题选项的 locales 设置为:
export default {
+ locales: {
+ '/en/': {
+ lang: 'en-US',
+ // ...
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ // ...
+ },
+ // other languages
+ },
+ // ...
+}
+这样当用户访问 / 或 /page.html 时，他们会自动根据当前浏览器语言重定向到 /en/ /en/page.html 与 /zh/ /zh/page.html。
自定义回退行为
有些时候，用户可能会在系统设置中添加多个语言。默认情况下，在站点支持首选语言，但首选语言不存在相应页面时，插件会尝试匹配用户设置的备用语言。
如果不需要回退到用户备用语言，而直接匹配用户首选语言，请在插件选项中设置 localeFallback: false。
自定义缺失行为
有些时候，当用户访问一个页面时，文档尚未包含用户需要的语言版本 (一个普遍的情况是当前页面尚未完成相关语言的本地化)，这样插件需要做出默认行为，你可以通过插件选项中的 defaultBehavior 定制它:
"defaultLocale": 重定向到默认语言或首个可用语言页面 (默认行为)"homepage": 重定向到当前语言的主页 (仅在文档包含用户语言时可用)"404": 重定向到当前语言的 404 页 (仅在文档包含用户语言时可用)
自定义默认路径
你可以通过设置插件选项中的 defaultLocale 来自定义默认路径。默认情况下，插件会使用 locales 中的第一个键名作为默认路径。
自动切换语言
插件支持在多语言文档中，自动根据用户语言首选项，将链接切换到用户需要的多语言页面。为了实现这一点，你需要在插件选项中设置 switchLocale，它可以是以下两个值:
direct: 直接切换到用户语言首选项页面，而不询问modal: 在用户语言首选项与当前页面语言不同时，弹出一个对话框询问用户是否切换语言
自定义多语言配置
默认情况下，插件会从站点的多语言配置 locales 选项中，读取 语言路径 和 lang 生成多语言配置。有些时候，你可能希望多个语言命中同一个路径，这种情况下，你应该设置插件的 localeConfig 选项。
比如，你可能希望所有英文用户都匹配到 /en/，并将繁体中文用户匹配到 /zh/ 中，那么你可以设置:
redirect({
+ localeConfig: {
+ '/en/': ['en-US', 'en-UK', 'en'],
+ '/zh/': ['zh-CN', 'zh-TW', 'zh'],
+ },
+})
+重定向站点
有时你可能会更改 base 或为你的站点使用新域名，因此你可能希望原始站点自动重定向到新站点。
为了解决这个问题，插件提供了 vp-redirect 脚手架。
使用:
+ $ vp-redirect generate [源文件夹]
+
+Options:
+ --hostname <hostname> 重定向到的域名 (例如: https://new.example.com/) (默认: /)
+ -c, --config <config> 设置配置文件路径
+ -o, --output <output> 设置输出目录 (默认: .vuepress/redirect)
+ --cache <cache> 设置缓存文件的目录
+ -t, --temp <temp> 设置临时文件的目录
+ --clean-cache 生成前清理缓存文件
+ --clean-temp 生成前清理临时文件
+ -h, --help 显示此消息
+你需要传入 VuePress 项目源目录并设置 hostname 选项。重定向助手脚手架将初始化你的 VuePress 项目以获取页面，然后在输出目录生成重定向 html 文件。
默认情况下，插件将输出到源文件夹下的 .vuepress/redirect 目录。你应该将其上传到你的原始站点以提供重定向。
选项
config
类型：
Record<string, string> | ((app: App) => Record<string, string>)详情
页面重定向映射。
可直接传入对象或传入参数为
App的函数返回值一个对象。每个键名必须是一个绝对路径，代表重定向的源页面地址。
每个键值是重定向的目标地址，可以是绝对路径或完整路径。
示例：
当 base 为
/base/时：- 将
/base/foo.html重定向到/base/bar.html - 将
/base/baz.html重定向到https://example.com/qux.html。
redirect({ + config: { + '/foo.html': '/bar.html', + '/baz.html': 'https://example.com/qux.html', + }, +}) +将 post 文件夹的路径重定向到 posts 文件夹
redirect({ + hostname: 'https://example.com', + config: (app) => + Object.fromEntries( + app.pages + .filter(({ path }) => path.startsWith('/posts/')) + .map(({ path }) => [path.replace(/^\\/posts\\//, '/post/'), path]), + ), +}) +- 将
autoLocale
`,35),v=s("li",null,[a("类型："),s("code",null,"boolean")],-1),y=s("li",null,[a("默认值: "),s("code",null,"false")],-1),h=s("li",null,"详情： 是否启用语言重定向",-1),m=e(`switchLocale
类型：
"direct" | "modal" | false默认值:
false详情：
是否根据用户偏好切换到新的语言环境。
"direct": 直接重定向到新的语言环境而不询问"modal": 显示一个模式让用户选择是否切换到新的语言环境
localeConfig
- 类型：
Record<string, string | string[]> - 详情：多语言语言配置
localeFallback
- 类型：
boolean - 默认值:
true - 详情：是否回退到用户定义的其他语言
defaultBehavior
- 类型：
"defaultLocale" | "homepage" | "404" - 默认值:
"defaultLocale" - 详情：当前链接没有可用的语言版本时的行为
defaultLocale
- 类型：
string - 默认值: 首个语言路径
- 详情：默认语言路径
Frontmatter
redirectFrom
- 类型：
string | string[] - 详情：重定向到该页面的地址。
redirectTo
- 类型：
string - 详情：该页面重定向到的地址。
样式
你可以通过 CSS 变量来自定义重定向弹窗的样式：
:root {
+ --redirect-z-index: 1499;
+ --redirect-bg-color: #fff;
+ --redirect-bg-color-light: #f3f4f5;
+ --redirect-bg-color-lighter: #eeeeee;
+ --redirect-text-color: #2c3e50;
+ --redirect-primary-bg-color: #3eaf7c;
+ --redirect-primary-hover-bg-color: #4abf8a;
+ --redirect-primary-text-color: #fff;
+}
+根据组件文件或目录自动注册 Vue 组件。
使用方法
npm i -D @vuepress/plugin-register-components@next
+import { registerComponentsPlugin } from '@vuepress/plugin-register-components'
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
components
类型：
Record<string, string>默认值：
{}详情：
一个定义了组件名称和其对应文件路径的对象。
键会被用作组件名称，值是组件文件的绝对路径。
如果该配置项中的组件名称和 componentsDir 配置项发生冲突，那么该配置项会有更高的优先级。
示例：
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ components: {
+ FooBar: path.resolve(__dirname, './components/FooBar.vue'),
+ },
+ }),
+ ],
+}
+componentsDir
类型：
string | null默认值：
null详情：
组件目录的绝对路径。
该目录下匹配 componentsPatterns 的文件会被自动注册为 Vue 组件。
示例：
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ componentsDir: path.resolve(__dirname, './components'),
+ }),
+ ],
+}
+组件目录：
components
+├─ FooBar.vue
+└─ Baz.vue
+组件会像这样被注册：
import { defineAsyncComponent } from 'vue'
+
+app.component(
+ 'FooBar',
+ defineAsyncComponent(() => import('/path/to/components/FooBar.vue')),
+)
+
+app.component(
+ 'Baz',
+ defineAsyncComponent(() => import('/path/to/components/Baz.vue')),
+)
+componentsPatterns
`,16),m=s("li",null,[s("p",null,[n("类型： "),s("code",null,"string[]")])],-1),u=s("li",null,[s("p",null,[n("默认值： "),s("code",null,"['**/*.vue']")])],-1),y=s("p",null,"详情：",-1),v={href:"https://github.com/sindresorhus/globby",target:"_blank",rel:"noopener noreferrer"},C=s("p",null,[n("该 Patterns 是相对于 "),s("a",{href:"#componentsdir"},"componentsDir"),n(" 目录的。")],-1),h=l('getComponentName
类型：
(filename: string) => string默认值：
(filename) => path.trimExt(filename.replace(/\\/|\\\\/g, '-'))详情：
用于从文件名获取对应组件名称的函数。
它只会对 componentsDir 目录下匹配了 componentsPatterns 的文件生效。
注意，这里的
filename是相对于 componentsPatterns 目录的文件路径。
Register Vue components from component files or directory automatically.
Usage
npm i -D @vuepress/plugin-register-components@next
+import { registerComponentsPlugin } from '@vuepress/plugin-register-components'
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ // options
+ }),
+ ],
+}
+Options
components
Type:
Record<string, string>Default:
{}Details:
An object that defines name of components and their corresponding file path.
The key will be used as the component name, and the value is an absolute path of the component file.
If the component name from this option conflicts with componentsDir option, this option will have a higher priority.
Example:
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ components: {
+ FooBar: path.resolve(__dirname, './components/FooBar.vue'),
+ },
+ }),
+ ],
+}
+componentsDir
Type:
string | nullDefault:
nullDetails:
Absolute path to the components directory.
Files in this directory which are matched with componentsPatterns will be registered as Vue components automatically.
Example:
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ componentsDir: path.resolve(__dirname, './components'),
+ }),
+ ],
+}
+Components directory:
components
+├─ FooBar.vue
+└─ Baz.vue
+Components will be registered like this:
import { defineAsyncComponent } from 'vue'
+
+app.component(
+ 'FooBar',
+ defineAsyncComponent(() => import('/path/to/components/FooBar.vue')),
+)
+
+app.component(
+ 'Baz',
+ defineAsyncComponent(() => import('/path/to/components/Baz.vue')),
+)
+componentsPatterns
`,16),m=s("li",null,[s("p",null,[n("Type: "),s("code",null,"string[]")])],-1),u=s("li",null,[s("p",null,[n("Default: "),s("code",null,"['**/*.vue']")])],-1),y=s("p",null,"Details:",-1),v={href:"https://github.com/sindresorhus/globby",target:"_blank",rel:"noopener noreferrer"},C=s("p",null,[n("The patterns are relative to "),s("a",{href:"#componentsdir"},"componentsDir"),n(".")],-1),h=l('getComponentName
Type:
(filename: string) => stringDefault:
(filename) => path.trimExt(filename.replace(/\\/|\\\\/g, '-'))Details:
A function to get component name from the filename.
It will only take effect on the files in the componentsDir which are matched with the componentsPatterns.
Notice that the
filenameis a filepath relative to componentsDir.
Usage
npm i -D @vuepress/plugin-remove-pwa@next
+import { removePwaPlugin } from '@vuepress/plugin-remove-pwa'
+
+export default {
+ plugins: [
+ removePwaPlugin({
+ // options
+ }),
+ ],
+}
+Options
cachePrefix
- Type:
string - Default:
'workbox' - Details: The cache prefix for the service worker.
swLocation
- Type:
string - Default:
'service-worker.js' - Details: The location of the old service worker.
使用方法
npm i -D @vuepress/plugin-remove-pwa@next
+import { removePwaPlugin } from '@vuepress/plugin-remove-pwa'
+
+export default {
+ plugins: [
+ removePwaPlugin({
+ // options
+ }),
+ ],
+}
+选项
cachePrefix
- 类型：
string - 默认值：
'workbox' - 详情：Service worker 的缓存前缀。
swLocation
- 类型：
string - 默认值：
'service-worker.js' - 详情：旧 Service Worker 的位置。
This plugin will set direction to rtl on configured locales.
Usage
npm i -D @vuepress/plugin-rtl@next
+import { rtlPlugin } from '@vuepress/plugin-rtl'
+
+export default {
+ plugins: [
+ rtlPlugin({
+ // options
+ locales: ['/ar/'],
+ }),
+ ],
+}
+Options
locales
- Type:
string[] - Default:
['/'] - Details: Locale path to enable rtl.
selector
Type:
SelectorOptionsinterface SelectorOptions { + [element: string]: { + [attrs: string]: string + } +} +Default:
{ 'html': { dir: 'rtl' } }Details:
Selector to enable rtl.
The default settings mean that the
dirattribute of thehtmlelement will be set tortlin rtl locales.
此插件会在配置的语言上设置 rtl 方向。
使用方法
npm i -D @vuepress/plugin-rtl@next
+import { rtlPlugin } from '@vuepress/plugin-rtl'
+
+export default {
+ plugins: [
+ rtlPlugin({
+ // 配置项
+ locales: ['/ar/'],
+ }),
+ ],
+}
+选项
locales
- 类型：
string[] - 默认值：
['/'] - 详情： 开启 RTL 布局的多语言路径。
selector
类型：
SelectorOptionsinterface SelectorOptions { + [element: string]: { + [attrs: string]: string + } +} +默认值：
{ 'html': { dir: 'rtl' } }详情：
开启 RTL 的选择器。
默认设置意味着在 RTL 多语言中，
html元素的dir属性将被设置为rtl。
Provide local search to your documentation site.
TIP
Default theme will add search box to the navbar once you configure this plugin correctly.
This plugin may not be used directly in other themes, so you'd better refer to the documentation of your theme for more details.
Usage
npm i -D @vuepress/plugin-search@next
+import { searchPlugin } from '@vuepress/plugin-search'
+
+export default {
+ plugins: [
+ searchPlugin({
+ // options
+ }),
+ ],
+}
+Local Search Index
This plugin will generate search index from your pages locally, and load the search index file when users enter your site. In other words, this is a lightweight built-in search which does not require any external requests.
`,7),y=a(`Options
locales
Type:
Record<string, { placeholder: string }>Details:
The text of the search box in different locales.
If this option is not specified, it will fallback to default text.
Example:
export default {
+ plugins: [
+ searchPlugin({
+ locales: {
+ '/': {
+ placeholder: 'Search',
+ },
+ '/zh/': {
+ placeholder: '搜索',
+ },
+ },
+ }),
+ ],
+}
+hotKeys
- Type:
(string | HotKeyOptions)[]
export interface HotKeyOptions {
+ /**
+ * Value of \`event.key\` to trigger the hot key
+ */
+ key: string;
+ /**
+ * Whether to press \`event.altKey\` at the same time
+ *
+ * @default false
+ */
+ alt?: boolean;
+ /**
+ * Whether to press \`event.ctrlKey\` at the same time
+ *
+ * @default false
+ */
+ ctrl?: boolean;
+ /**
+ * Whether to press \`event.shiftKey\` at the same time
+ *
+ * @default false
+ */
+ shift?: boolean;
+}
+maxSuggestions
Type:
numberDefault:
5Details:
Specify the maximum number of search results.
isSearchable
Type:
(page: Page) => booleanDefault:
() => trueDetails:
A function to determine whether a page should be included in the search index.
- Return
trueto include the page. - Return
falseto exclude the page.
- Return
Example:
export default {
+ plugins: [
+ searchPlugin({
+ // exclude the homepage
+ isSearchable: (page) => page.path !== '/',
+ }),
+ ],
+}
+getExtraFields
Type:
(page: Page) => string[]Default:
() => []Details:
A function to add extra fields to the search index of a page.
By default, this plugin will use page title and headers as the search index. This option could help you to add more searchable fields.
Example:
export default {
+ plugins: [
+ searchPlugin({
+ // allow searching the \`tags\` frontmatter
+ getExtraFields: (page) => page.frontmatter.tags ?? [],
+ }),
+ ],
+}
+Styles
You can customize the style of the search box via CSS variables:
:root {
+ --search-bg-color: #ffffff;
+ --search-accent-color: #3eaf7c;
+ --search-text-color: #2c3e50;
+ --search-border-color: #eaecef;
+ --search-item-text-color: #5d81a5;
+ --search-item-focus-bg-color: #f3f4f5;
+ --search-input-width: 8rem;
+ --search-result-width: 20rem;
+}
+Components
SearchBox
Details:
This plugin will register a
<SearchBox />component globally, and you can use it without any props.Put this component to where you want to place the search box. For example, default theme puts this component to the end of the navbar.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
为你的文档网站提供本地搜索能力。
提示
当你正确配置该插件后，默认主题会把搜索框添加到导航栏。
该插件不一定能在其他主题中直接使用，因此你应参考主题本身的文档来获取更多信息。
使用方法
npm i -D @vuepress/plugin-search@next
+import { searchPlugin } from '@vuepress/plugin-search'
+
+export default {
+ plugins: [
+ searchPlugin({
+ // 配置项
+ }),
+ ],
+}
+本地搜索索引
该插件会根据你的页面，在本地生成搜索索引，然后在用户访问站点时加载搜索索引文件。换句话说，这是一个轻量级的内置搜索能力，不会进行任何外部请求。
`,7),y=l(`配置项
locales
类型：
Record<string, { placeholder: string }>详情：
搜索框在不同 locales 下的文字。
如果没有指定该配置项，它会降级使用默认文字。
示例：
export default {
+ plugins: [
+ searchPlugin({
+ locales: {
+ '/': {
+ placeholder: 'Search',
+ },
+ '/zh/': {
+ placeholder: '搜索',
+ },
+ },
+ }),
+ ],
+}
+hotKeys
- 类型：
(string | HotKeyOptions)[]
export interface HotKeyOptions {
+ /**
+ * Value of \`event.key\` to trigger the hot key
+ */
+ key: string;
+ /**
+ * Whether to press \`event.altKey\` at the same time
+ *
+ * @default false
+ */
+ alt?: boolean;
+ /**
+ * Whether to press \`event.ctrlKey\` at the same time
+ *
+ * @default false
+ */
+ ctrl?: boolean;
+ /**
+ * Whether to press \`event.shiftKey\` at the same time
+ *
+ * @default false
+ */
+ shift?: boolean;
+}
+maxSuggestions
类型：
number默认值：
5详情：
指定搜索结果的最大条数。
isSearchable
类型：
(page: Page) => boolean默认值：
() => true详情：
一个函数，用于判断一个页面是否应该被包含在搜索索引中。
- 返回
true来包含该页面。 - 返回
false来排除该页面。
- 返回
示例：
export default {
+ plugins: [
+ searchPlugin({
+ // 排除首页
+ isSearchable: (page) => page.path !== '/',
+ }),
+ ],
+}
+getExtraFields
类型：
(page: Page) => string[]默认值：
() => []详情：
一个函数，用于在页面的搜索索引中添加额外字段。
默认情况下，该插件会将页面标题和小标题作为搜索索引。该配置项可以帮助你添加更多的可搜索字段。
示例：
export default {
+ plugins: [
+ searchPlugin({
+ // 允许搜索 Frontmatter 中的 \`tags\`
+ getExtraFields: (page) => page.frontmatter.tags ?? [],
+ }),
+ ],
+}
+样式
你可以通过 CSS 变量来自定义搜索框的样式：
:root {
+ --search-bg-color: #ffffff;
+ --search-accent-color: #3eaf7c;
+ --search-text-color: #2c3e50;
+ --search-border-color: #eaecef;
+ --search-item-text-color: #5d81a5;
+ --search-item-focus-bg-color: #f3f4f5;
+ --search-input-width: 8rem;
+ --search-result-width: 20rem;
+}
+组件
SearchBox
详情：
该插件会全局注册一个
<SearchBox />组件，你可以不传入任何 Props 来使用它。将该组件放置在你想要显示搜索框的地方。例如，默认主题将这个组件放在了导航栏的末尾。
提示
该组件主要用于主题开发。在大多数情况下你不需要直接使用该组件。
Shared Methods
The following functions are available on both Node.js and Client.
Data Related
Encode/decode and zip/unzip data.
This is useful in markdown plugins when you want to encode string content and pass it to the component through props.
You may simply achieve this with encodeURIComponent and decodeURIComponent, but it can be very large if the content contains lots of special characters.
So we provide encodeData and decodeData to zip and encode content.
export const encodeData: (
+ data: string,
+ level: DeflateOptions['level'] = 6,
+) => string
+
+export const decodeData: (compressed: string) => string
+const content = \`
+{
+ "type": "bar",
+ "data": {
+ "labels": ["Red", "Blue", "Yellow", "Green", "Purple", "Orange"],
+ "datasets": [
+ {
+ "label": "# of Votes",
+ "data": [12, 19, 3, 5, 2, 3],
+ "backgroundColor": [
+ "rgba(255, 99, 132, 0.2)",
+ "rgba(54, 162, 235, 0.2)",
+ "rgba(255, 206, 86, 0.2)",
+ "rgba(75, 192, 192, 0.2)",
+ "rgba(153, 102, 255, 0.2)",
+ "rgba(255, 159, 64, 0.2)"
+ ],
+ "borderColor": [
+ "rgba(255, 99, 132, 1)",
+ "rgba(54, 162, 235, 1)",
+ "rgba(255, 206, 86, 1)",
+ "rgba(75, 192, 192, 1)",
+ "rgba(153, 102, 255, 1)",
+ "rgba(255, 159, 64, 1)"
+ ],
+ "borderWidth": 1
+ }
+ ]
+ },
+ "options": {
+ "scales": {
+ "y": {
+ "beginAtZero": true
+ }
+ }
+ }
+}
+\`
+
+const prop = encodeData(content) // "eJyNUsFOwzAMve8rrHABKZqWlg5WxAE4cARxAMHEIV1NmQhNlaaCCe3fcdKtW0sLWGpjxy/v+UV512mlcIyfhTa2hHP4GgHYVYExsEQaxqlMpZWxbwAomaAqY5izO0wZB3apKnTrIyqlP1x2bRBzl9xWplC+eWNkniF7dmw1X4nWsfgaNtwNP2kfgH6Be22x9CPUUQ8yFwEHMeMQcog4UBFuiF0kcvGWGV3l6ZVW2uw0XDCTJfIwiOjYjAhESIcn4+BoT2MLio6pP6V+EBJ6AOSZgsmUwyl9A6ATwoiZn3lYTkTkRkycnuP8TU9ENPqUxuuA9i9BmxTNPy9A/G2/F9I23wtpW++FdIwPKzW2W5Afph+WqX2NQWz313XicT7XhV3qnB5f/ejKhVTYVACrXUqUmC3zC/uERsdgTYUdVr/Qb302+gZxe7S/"
+
+decodeData(prop) // will be the original content
+
+// if you use \`encodeURIComponent\`, it will be much longer
+encodeURIComponent(content) // '%0A%7B%0A%20%20%22type%22%3A%20%22bar%22%2C%0A%20%20%22data%22%3A%20%7B%0A%20%20%20%20%22labels%22%3A%20%5B%22Red%22%2C%20%22Blue%22%2C%20%22Yellow%22%2C%20%22Green%22%2C%20%22Purple%22%2C%20%22Orange%22%5D%2C%0A%20%20%20%20%22datasets%22%3A%20%5B%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22%23%20of%20Votes%22%2C%0A%20%20%20%20%20%20%20%20%22data%22%3A%20%5B12%2C%2019%2C%203%2C%205%2C%202%2C%203%5D%2C%0A%20%20%20%20%20%20%20%20%22backgroundColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%200.2)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%201)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderWidth%22%3A%201%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%20%20%7D%2C%0A%20%20%22options%22%3A%20%7B%0A%20%20%20%20%22scales%22%3A%20%7B%0A%20%20%20%20%20%20%22y%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22beginAtZero%22%3A%20true%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A'
+Type Helper
isDef(x): Check ifxis defined.isBoolean(x): Check ifxis a boolean.isString(x): Check ifxis a string.isNumber(x): Check ifxis a number.isPlainObject(x): Check ifxis a plain object.isArray(x): Check ifxis an array.isFunction(x): Check ifxis a function.isRegExp(x): Check ifxis a regular expression.
String Related
startsWith(a, b): Check if stringastarts with stringb.endsWith(a, b): Check if stringaends with stringb.
Return false if a is not a string.
对象相关
keys(x): Return an array of keys of objectx.values(x): Return an array of values of objectx.entries(x): Convert objectxto an array of key-value pairs.fromEntries(x): Convert an array of key-value pairsxto an object.deepAssign(x, y, ...): A deep version ofObject.assign.Example
// or @vuepress/helper/client +import { deepAssign } from '@vuepress/helper' + +const defaultOptions = { + optionA: { + optionA1: 'defaultOptionA1', + optionA2: 'defaultOptionA2', + optionA3: 'defaultOptionA3', + }, + optionB: true, + optionC: 'optionC', +} + +const userOptions = { + optionA: { + optionA1: 'optionA1', + optionA2: 'optionA2', + }, + optionB: false, +} + +deepAssign(defaultOptions, userOptions) +// { +// optionA: { +// optionA1: "optionA1", +// optionA2: "optionA2", +// optionA3: "defaultOptionA3", +// }, +// optionB: false, +// optionC: "optionC", +// } +
Date Related
getDate(x): Convert inputxto a date. It can supportDate, timestamp, and date string. The support degree of date string depends on theDate.parsesupport degree of the environment. Returnnullwhen it cannot be converted to a date.Example
getDate('2021-01-01') // a Date object represents 2021-01-01 +getDate(1609459200000) // a Date object represents 2021-01-01 +getDate('2021-01-01T00:00:00.000Z') // a Date object represents 2021-01-01 +getDate('2021/01/01') // a Date object represents 2021-01-01 (might be null in some browsers) +getDate('invalid date') // null +getDate(undefined) // null +getDate(-32) // null +dateSorter: Sort the values that can be converted to dates from new to old, and the values that cannot be converted to dates will be at the end.Example
const arr = [ + '2020-01-01', + 1609459200000, + '2022-01-01T00:00:00.000Z', + '2023/01/01', + 'invalid date', + undefined, + -32, +] + +arr.sort(dateSorter) +// [ +// '2023/01/01', +// '2022-01-01T00:00:00.000Z', +// 1609459200000, +// '2020-01-01', +// 'invalid date', +// undefined, +// -32, +// ] +
Link Related
isLinkHttp(x): Check ifxis a valid HTTP URL.isLinkWithProtocol(x): Check ifxis a valid URL with protocol.isLinkExternal(x): Check ifxis a valid external URL.isLinkAbsolute(x): Check ifxis a valid absolute URL.ensureEndingSlash(x): Ensurexends with a slash.ensureLeadingSlash(x): Ensurexstarts with a slash.removeEndingSlash(x): Ensurexdoes not end with a slash.removeLeadingSlash(x): Ensurexdoes not start with a slash.
共享方法
以下函数在 Node.js 和客户端上均可用。
数据相关
此方法在 MarkdownIt 插件中很有用。有些时候你可能需要在 Markdown 插件中生成组件，并将复杂的数据写入到组件属性中，一个通常做法是使用 JSON.stringify + encodeURIComponent，并在客户端 decodeURIComponent + JSON.parse。但如果内容包含很多特殊字符，转换结果会很长。
所以我们提供 encodeData 和 decodeData 来压缩和编码内容。
export const encodeData: (
+ data: string,
+ level: DeflateOptions['level'] = 6,
+) => string
+
+export const decodeData: (compressed: string) => string
+const content = \`
+{
+ "type": "bar",
+ "data": {
+ "labels": ["Red", "Blue", "Yellow", "Green", "Purple", "Orange"],
+ "datasets": [
+ {
+ "label": "# of Votes",
+ "data": [12, 19, 3, 5, 2, 3],
+ "backgroundColor": [
+ "rgba(255, 99, 132, 0.2)",
+ "rgba(54, 162, 235, 0.2)",
+ "rgba(255, 206, 86, 0.2)",
+ "rgba(75, 192, 192, 0.2)",
+ "rgba(153, 102, 255, 0.2)",
+ "rgba(255, 159, 64, 0.2)"
+ ],
+ "borderColor": [
+ "rgba(255, 99, 132, 1)",
+ "rgba(54, 162, 235, 1)",
+ "rgba(255, 206, 86, 1)",
+ "rgba(75, 192, 192, 1)",
+ "rgba(153, 102, 255, 1)",
+ "rgba(255, 159, 64, 1)"
+ ],
+ "borderWidth": 1
+ }
+ ]
+ },
+ "options": {
+ "scales": {
+ "y": {
+ "beginAtZero": true
+ }
+ }
+ }
+}
+\`
+
+const prop = encodeData(content) // "eJyNUsFOwzAMve8rrHABKZqWlg5WxAE4cARxAMHEIV1NmQhNlaaCCe3fcdKtW0sLWGpjxy/v+UV512mlcIyfhTa2hHP4GgHYVYExsEQaxqlMpZWxbwAomaAqY5izO0wZB3apKnTrIyqlP1x2bRBzl9xWplC+eWNkniF7dmw1X4nWsfgaNtwNP2kfgH6Be22x9CPUUQ8yFwEHMeMQcog4UBFuiF0kcvGWGV3l6ZVW2uw0XDCTJfIwiOjYjAhESIcn4+BoT2MLio6pP6V+EBJ6AOSZgsmUwyl9A6ATwoiZn3lYTkTkRkycnuP8TU9ENPqUxuuA9i9BmxTNPy9A/G2/F9I23wtpW++FdIwPKzW2W5Afph+WqX2NQWz313XicT7XhV3qnB5f/ejKhVTYVACrXUqUmC3zC/uERsdgTYUdVr/Qb302+gZxe7S/"
+
+decodeData(prop) // will be the original content
+
+// if you use \`encodeURIComponent\`, it will be much longer
+encodeURIComponent(content) // '%0A%7B%0A%20%20%22type%22%3A%20%22bar%22%2C%0A%20%20%22data%22%3A%20%7B%0A%20%20%20%20%22labels%22%3A%20%5B%22Red%22%2C%20%22Blue%22%2C%20%22Yellow%22%2C%20%22Green%22%2C%20%22Purple%22%2C%20%22Orange%22%5D%2C%0A%20%20%20%20%22datasets%22%3A%20%5B%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22%23%20of%20Votes%22%2C%0A%20%20%20%20%20%20%20%20%22data%22%3A%20%5B12%2C%2019%2C%203%2C%205%2C%202%2C%203%5D%2C%0A%20%20%20%20%20%20%20%20%22backgroundColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%200.2)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%201)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderWidth%22%3A%201%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%20%20%7D%2C%0A%20%20%22options%22%3A%20%7B%0A%20%20%20%20%22scales%22%3A%20%7B%0A%20%20%20%20%20%20%22y%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22beginAtZero%22%3A%20true%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A'
+类型助手
isDef(x): 判断 x 是否定义。isBoolean(x): 判断 x 是否为布尔值。isString(x): 判断 x 是否为字符串。isNumber(x): 判断 x 是否为数字。isPlainObject(x): 判断值是否为纯对象。isArray(x): 判断 x 是否为数组isFunction(x): 判断 x 是否为函数。isRegExp(x): 判断 x 是否为正则表达式
字符串相关
startsWith(a, b): 判断字符串 a 是否以指定字符串 b 开头endsWith(a, b): 判断字符串 a 是否以指定字符串 b 结尾
当 a 不是字符串时返回 false
对象相关
keys(x): 以数组形式返回对象 x 的键values(x): 以数组形式返回对象 x 的值entries(x): 将对象 x 转换为键值对数组。fromEntries(x): 将键值对数组 x 转换为对象。deepAssign(x, y, ...):Object.assign的深度版本。示例
// or @vuepress/helper/client +import { deepAssign } from '@vuepress/helper' + +const defaultOptions = { + optionA: { + optionA1: 'defaultOptionA1', + optionA2: 'defaultOptionA2', + optionA3: 'defaultOptionA3', + }, + optionB: true, + optionC: 'optionC', +} + +const userOptions = { + optionA: { + optionA1: 'optionA1', + optionA2: 'optionA2', + }, + optionB: false, +} + +deepAssign(defaultOptions, userOptions) +// { +// optionA: { +// optionA1: "optionA1", +// optionA2: "optionA2", +// optionA3: "defaultOptionA3", +// }, +// optionB: false, +// optionC: "optionC", +// } +
日期相关
getDate(x): 将输入 x 转换为日期，可以支持 Date，时间戳，日期字符串。日期字符串的支持度以环境的Date.parse支持度为准。当不能转换为日期时返回null示例
getDate('2021-01-01') // a Date object represents 2021-01-01 +getDate(1609459200000) // a Date object represents 2021-01-01 +getDate('2021-01-01T00:00:00.000Z') // a Date object represents 2021-01-01 +getDate('2021/01/01') // a Date object represents 2021-01-01 (might be null in some browsers) +getDate('invalid date') // null +getDate(undefined) // null +getDate(-32) // null +dateSorter: 将可转换为日期的值从新到旧排序，不能转换为日期的值会在最后。示例
const arr = [ + '2020-01-01', + 1609459200000, + '2022-01-01T00:00:00.000Z', + '2023/01/01', + 'invalid date', + undefined, + -32, +] + +arr.sort(dateSorter) +// [ +// '2023/01/01', +// '2022-01-01T00:00:00.000Z', +// 1609459200000, +// '2020-01-01', +// 'invalid date', +// undefined, +// -32, +// ] +
链接相关
isLinkHttp(x): x 是否是有效的 HTTP URL。isLinkWithProtocol(x): x 是否是有效的带有协议的 URL。isLinkExternal(x): x 是否是有效的外部 URL。isLinkAbsolute(x): x 是否是有效的绝对 URL。ensureEndingSlash(x): 确保 x 以斜杠结尾。ensureLeadingSlash(x): 确保 x 以斜杠开头。removeEndingSlash(x): 确保 x 不以斜杠结尾。removeLeadingSlash(x): 确保 x 不以斜杠开头。
使用方法
npm i -D @vuepress/plugin-shiki@next
+import { shikiPlugin } from '@vuepress/plugin-shiki'
+
+export default {
+ plugins: [
+ shikiPlugin({
+ // 配置项
+ langs: ['ts', 'json', 'vue', 'md', 'bash', 'diff'],
+ }),
+ ],
+}
+配置项
langs
`,5),v=s("li",null,[s("p",null,[e("类型： "),s("code",null,"ShikiLang[]")])],-1),y=s("li",null,[s("p",null,"详情："),s("p",null,"Shiki 要解析的代码块的语言。"),s("p",null,[e("该配置项会被传递到 Shiki 的 "),s("code",null,"getHighlighter()"),e(" 方法中。")]),s("p",null,"你最好明确传入所有你使用的语言列表，否则 Shiki 会加载所有语言，并可能影响性能。")],-1),b=s("p",null,"参考：",-1),f={href:"https://shiki.style/languages",target:"_blank",rel:"noopener noreferrer"},C=s("h3",{id:"theme",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#theme"},[s("span",null,"theme")])],-1),E=i("类型： ShikiTheme
默认值： 'nord'
详情：
Shiki 的主题。
该配置项会被传递到 Shiki 的 codeToHtml() 方法中。
Usage
npm i -D @vuepress/plugin-shiki@next
+import { shikiPlugin } from '@vuepress/plugin-shiki'
+
+export default {
+ plugins: [
+ shikiPlugin({
+ // options
+ langs: ['ts', 'json', 'vue', 'md', 'bash', 'diff'],
+ }),
+ ],
+}
+Options
langs
`,5),y=e("li",null,[e("p",null,[s("Type: "),e("code",null,"ShikiLang[]")])],-1),b=e("li",null,[e("p",null,"Details:"),e("p",null,"Languages of code blocks to be parsed by Shiki."),e("p",null,[s("This option will be forwarded to "),e("code",null,"getHighlighter()"),s(" method of Shiki.")]),e("p",null,"You'd better provide the languages list you are using explicitly, otherwise Shiki will load all languages and can affect performance.")],-1),v=e("p",null,"Also see:",-1),f={href:"https://shiki.style/languages",target:"_blank",rel:"noopener noreferrer"},C=e("h3",{id:"theme",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#theme"},[e("span",null,"theme")])],-1),x=i("Type: ShikiTheme
Default: 'nord'
Details:
Theme of Shiki.
This option will be forwarded to codeToHtml() method of Shiki.
Users can customize style variables via a palette file, and add extra styles via a style file.
Palette File
The path of the palette file is .vuepress/styles/palette.scss.
You can make use of it to override predefined SASS variables of the default theme.
Click to expand SASS variables
// responsive breakpoints
+$MQNarrow: 959px !default;
+$MQMobile: 719px !default;
+$MQMobileNarrow: 419px !default;
+Style File
The path of the style file is .vuepress/styles/index.scss.
You can add extra styles here, or override the default styles:
:root {
+ scroll-behavior: smooth;
+}
+You can also make use of it to override predefined CSS variables of the default theme.
Click to expand CSS variables
:root {
+ // brand colors
+ --c-brand: #3eaf7c;
+ --c-brand-light: #4abf8a;
+
+ // background colors
+ --c-bg: #ffffff;
+ --c-bg-light: #f3f4f5;
+ --c-bg-lighter: #eeeeee;
+ --c-bg-dark: #ebebec;
+ --c-bg-darker: #e6e6e6;
+ --c-bg-navbar: var(--c-bg);
+ --c-bg-sidebar: var(--c-bg);
+ --c-bg-arrow: #cccccc;
+
+ // text colors
+ --c-text: #2c3e50;
+ --c-text-accent: var(--c-brand);
+ --c-text-light: #3a5169;
+ --c-text-lighter: #4e6e8e;
+ --c-text-lightest: #6a8bad;
+ --c-text-quote: #999999;
+
+ // border colors
+ --c-border: #eaecef;
+ --c-border-dark: #dfe2e5;
+
+ // custom container colors
+ --c-tip: #42b983;
+ --c-tip-bg: var(--c-bg-light);
+ --c-tip-title: var(--c-text);
+ --c-tip-text: var(--c-text);
+ --c-tip-text-accent: var(--c-text-accent);
+ --c-warning: #ffc310;
+ --c-warning-bg: #fffae3;
+ --c-warning-bg-light: #fff3ba;
+ --c-warning-bg-lighter: #fff0b0;
+ --c-warning-border-dark: #f7dc91;
+ --c-warning-details-bg: #fff5ca;
+ --c-warning-title: #f1b300;
+ --c-warning-text: #746000;
+ --c-warning-text-accent: #edb100;
+ --c-warning-text-light: #c1971c;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #f11e37;
+ --c-danger-bg: #ffe0e0;
+ --c-danger-bg-light: #ffcfde;
+ --c-danger-bg-lighter: #ffc9c9;
+ --c-danger-border-dark: #f1abab;
+ --c-danger-details-bg: #ffd4d4;
+ --c-danger-title: #ed1e2c;
+ --c-danger-text: #660000;
+ --c-danger-text-accent: #bd1a1a;
+ --c-danger-text-light: #b5474d;
+ --c-danger-text-quote: #c15b5b;
+ --c-details-bg: #eeeeee;
+
+ // badge component colors
+ --c-badge-tip: var(--c-tip);
+ --c-badge-warning: #ecc808;
+ --c-badge-warning-text: var(--c-bg);
+ --c-badge-danger: #dc2626;
+ --c-badge-danger-text: var(--c-bg);
+
+ // code group colors
+ --c-code-group-tab-title: rgba(255, 255, 255, 0.9);
+ --c-code-group-tab-bg: var(--code-bg-color);
+ --c-code-group-tab-outline: var(var(--c-code-group-tab-title));
+ --c-code-group-tab-active-border: var(--c-brand);
+
+ // transition vars
+ --t-color: 0.3s ease;
+ --t-transform: 0.3s ease;
+
+ // code blocks vars
+ --code-bg-color: #282c34;
+ --code-hl-bg-color: rgba(0, 0, 0, 0.66);
+ --code-ln-color: #9e9e9e;
+ --code-ln-wrapper-width: 3.5rem;
+
+ // font vars
+ --font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
+ Ubuntu, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
+ --font-family-code: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
+
+ // layout vars
+ --navbar-height: 3.6rem;
+ --navbar-padding-v: 0.7rem;
+ --navbar-padding-h: 1.5rem;
+ --sidebar-width: 20rem;
+ --sidebar-width-mobile: calc(var(--sidebar-width) * 0.82);
+ --content-width: 740px;
+ --homepage-width: 960px;
+}
+
+// plugin-back-to-top
+.vp-back-to-top-button {
+ --back-to-top-color: var(--c-brand);
+ --back-to-top-color-hover: var(--c-brand-light);
+ --back-to-top-bg-color: var(--c-bg);
+}
+
+// plugin-catalog
+.vp-catalog-wrapper {
+ --catalog-bg-color: var(--c-bg);
+ --catalog-bg-secondary-color: var(--c-bg-dark);
+ --catalog-border-color: var(--c-border);
+ --catalog-active-color: var(--c-brand);
+ --catalog-hover-color: var(--c-brand-light);
+}
+
+// plugin-docsearch
+.DocSearch {
+ --docsearch-primary-color: var(--c-brand);
+ --docsearch-text-color: var(--c-text);
+ --docsearch-highlight-color: var(--c-brand);
+ --docsearch-muted-color: var(--c-text-quote);
+ --docsearch-container-background: rgba(9, 10, 17, 0.8);
+ --docsearch-modal-background: var(--c-bg-light);
+ --docsearch-searchbox-background: var(--c-bg-lighter);
+ --docsearch-searchbox-focus-background: var(--c-bg);
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--c-brand);
+ --docsearch-hit-color: var(--c-text-light);
+ --docsearch-hit-active-color: var(--c-bg);
+ --docsearch-hit-background: var(--c-bg);
+ --docsearch-hit-shadow: 0 1px 3px 0 var(--c-border-dark);
+ --docsearch-footer-background: var(--c-bg);
+}
+
+// plugin-external-link-icon
+.external-link-icon {
+ --external-link-icon-color: var(--c-text-quote);
+}
+
+// plugin-medium-zoom
+.medium-zoom-overlay {
+ --medium-zoom-bg-color: var(--c-bg);
+}
+
+// plugin-nprogress
+#nprogress {
+ --nprogress-color: var(--c-brand);
+}
+
+// plugin-photo-swipe
+body {
+ --photo-swipe-bullet: var(--c-bg);
+ --photo-swipe-bullet-active: var(--c-brand);
+}
+
+// plugin-pwa-popup
+html {
+ --pwa-text-color: var(--c-text);
+ --pwa-bg-color: var(--c-bg);
+ --pwa-border-color: var(--c-brand);
+ --pwa-btn-text-color: var(--c-bg);
+ --pwa-btn-bg-color: var(--c-brand);
+ --pwa-btn-hover-bg-color: var(--c-brand-light);
+}
+
+html.dark {
+ --pwa-shadow-color: rgb(0 0 0 / 30%);
+ --pwa-content-color: #ccc;
+ --pwa-content-light-color: #999;
+}
+
+// plugin-redirect
+.language-modal-mask {
+ --redirect-bg-color: var(--c-bg);
+ --redirect-bg-color-light: var(--c-bg-light);
+ --redirect-bg-color-lighter: var(--c-bg-lighter);
+ --redirect-text-color: var(--c-text);
+ --redirect-primary-bg-color: var(--c-brand);
+ --redirect-primary-hover-bg-color: var(--c-brand-light);
+ --redirect-primary-text-color: var(--c-bg);
+}
+
+// plugin-search
+.search-box {
+ --search-bg-color: var(--c-bg);
+ --search-accent-color: var(--c-brand);
+ --search-text-color: var(--c-text);
+ --search-border-color: var(--c-border);
+
+ --search-item-text-color: var(--c-text-lighter);
+ --search-item-focus-bg-color: var(--c-bg-light);
+}
+Click to expand dark mode CSS variables
html.dark {
+ // brand colors
+ --c-brand: #3aa675;
+ --c-brand-light: #349469;
+
+ // background colors
+ --c-bg: #22272e;
+ --c-bg-light: #2b313a;
+ --c-bg-lighter: #262c34;
+ --c-bg-dark: #343b44;
+ --c-bg-darker: #37404c;
+
+ // text colors
+ --c-text: #adbac7;
+ --c-text-light: #96a7b7;
+ --c-text-lighter: #8b9eb0;
+ --c-text-lightest: #8094a8;
+
+ // border colors
+ --c-border: #3e4c5a;
+ --c-border-dark: #34404c;
+
+ // custom container colors
+ --c-tip: #318a62;
+ --c-warning: #e0ad15;
+ --c-warning-bg: #2d2f2d;
+ --c-warning-bg-light: #423e2a;
+ --c-warning-bg-lighter: #44442f;
+ --c-warning-border-dark: #957c35;
+ --c-warning-details-bg: #39392d;
+ --c-warning-title: #fdca31;
+ --c-warning-text: #d8d96d;
+ --c-warning-text-accent: #ffbf00;
+ --c-warning-text-light: #ddb84b;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #fc1e38;
+ --c-danger-bg: #39232c;
+ --c-danger-bg-light: #4b2b35;
+ --c-danger-bg-lighter: #553040;
+ --c-danger-border-dark: #a25151;
+ --c-danger-details-bg: #482936;
+ --c-danger-title: #fc2d3b;
+ --c-danger-text: #ea9ca0;
+ --c-danger-text-accent: #fd3636;
+ --c-danger-text-light: #d9777c;
+ --c-danger-text-quote: #d56b6b;
+ --c-details-bg: #323843;
+
+ // badge component colors
+ --c-badge-warning: var(--c-warning);
+ --c-badge-warning-text: #3c2e05;
+ --c-badge-danger: var(--c-danger);
+ --c-badge-danger-text: #401416;
+
+ // code blocks vars
+ --code-hl-bg-color: #363b46;
+}
+
+// plugin-docsearch
+html.dark .DocSearch {
+ --docsearch-logo-color: var(--c-text);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309;
+ --docsearch-key-shadow: inset 0 -2px 0 0 #282d55, inset 0 0 1px 1px #51577d,
+ 0 2px 2px 0 rgba(3, 4, 9, 0.3);
+ --docsearch-key-gradient: linear-gradient(-225deg, #444950, #1c1e21);
+ --docsearch-footer-shadow: inset 0 1px 0 0 rgba(73, 76, 106, 0.5),
+ 0 -4px 8px 0 rgba(0, 0, 0, 0.2);
+}
+用户可以通过 palette 文件 来自定义样式变量，还可以通过 style 文件 来添加额外的样式。
Palette 文件
Palette 文件的路径是 .vuepress/styles/palette.scss 。
你可以利用它来覆盖默认主题的预定义 SASS 变量。
点击查看 SASS 变量
// responsive breakpoints
+$MQNarrow: 959px !default;
+$MQMobile: 719px !default;
+$MQMobileNarrow: 419px !default;
+Style 文件
Style 文件的路径是 .vuepress/styles/index.scss 。
你可以在这里添加额外的样式，或者覆盖默认样式：
:root {
+ scroll-behavior: smooth;
+}
+你也可以利用它来覆盖默认主题的预定义 CSS 变量。
点击查看 CSS 变量
:root {
+ // brand colors
+ --c-brand: #3eaf7c;
+ --c-brand-light: #4abf8a;
+
+ // background colors
+ --c-bg: #ffffff;
+ --c-bg-light: #f3f4f5;
+ --c-bg-lighter: #eeeeee;
+ --c-bg-dark: #ebebec;
+ --c-bg-darker: #e6e6e6;
+ --c-bg-navbar: var(--c-bg);
+ --c-bg-sidebar: var(--c-bg);
+ --c-bg-arrow: #cccccc;
+
+ // text colors
+ --c-text: #2c3e50;
+ --c-text-accent: var(--c-brand);
+ --c-text-light: #3a5169;
+ --c-text-lighter: #4e6e8e;
+ --c-text-lightest: #6a8bad;
+ --c-text-quote: #999999;
+
+ // border colors
+ --c-border: #eaecef;
+ --c-border-dark: #dfe2e5;
+
+ // custom container colors
+ --c-tip: #42b983;
+ --c-tip-bg: var(--c-bg-light);
+ --c-tip-title: var(--c-text);
+ --c-tip-text: var(--c-text);
+ --c-tip-text-accent: var(--c-text-accent);
+ --c-warning: #ffc310;
+ --c-warning-bg: #fffae3;
+ --c-warning-bg-light: #fff3ba;
+ --c-warning-bg-lighter: #fff0b0;
+ --c-warning-border-dark: #f7dc91;
+ --c-warning-details-bg: #fff5ca;
+ --c-warning-title: #f1b300;
+ --c-warning-text: #746000;
+ --c-warning-text-accent: #edb100;
+ --c-warning-text-light: #c1971c;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #f11e37;
+ --c-danger-bg: #ffe0e0;
+ --c-danger-bg-light: #ffcfde;
+ --c-danger-bg-lighter: #ffc9c9;
+ --c-danger-border-dark: #f1abab;
+ --c-danger-details-bg: #ffd4d4;
+ --c-danger-title: #ed1e2c;
+ --c-danger-text: #660000;
+ --c-danger-text-accent: #bd1a1a;
+ --c-danger-text-light: #b5474d;
+ --c-danger-text-quote: #c15b5b;
+ --c-details-bg: #eeeeee;
+
+ // badge component colors
+ --c-badge-tip: var(--c-tip);
+ --c-badge-warning: #ecc808;
+ --c-badge-warning-text: var(--c-bg);
+ --c-badge-danger: #dc2626;
+ --c-badge-danger-text: var(--c-bg);
+
+ // code group colors
+ --c-code-group-tab-title: rgba(255, 255, 255, 0.9);
+ --c-code-group-tab-bg: var(--code-bg-color);
+ --c-code-group-tab-outline: var(var(--c-code-group-tab-title));
+ --c-code-group-tab-active-border: var(--c-brand);
+
+ // transition vars
+ --t-color: 0.3s ease;
+ --t-transform: 0.3s ease;
+
+ // code blocks vars
+ --code-bg-color: #282c34;
+ --code-hl-bg-color: rgba(0, 0, 0, 0.66);
+ --code-ln-color: #9e9e9e;
+ --code-ln-wrapper-width: 3.5rem;
+
+ // font vars
+ --font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
+ Ubuntu, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
+ --font-family-code: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
+
+ // layout vars
+ --navbar-height: 3.6rem;
+ --navbar-padding-v: 0.7rem;
+ --navbar-padding-h: 1.5rem;
+ --sidebar-width: 20rem;
+ --sidebar-width-mobile: calc(var(--sidebar-width) * 0.82);
+ --content-width: 740px;
+ --homepage-width: 960px;
+}
+
+// plugin-back-to-top
+.vp-back-to-top-button {
+ --back-to-top-color: var(--c-brand);
+ --back-to-top-color-hover: var(--c-brand-light);
+ --back-to-top-bg-color: var(--c-bg);
+}
+
+// plugin-catalog
+.vp-catalog-wrapper {
+ --catalog-bg-color: var(--c-bg);
+ --catalog-bg-secondary-color: var(--c-bg-dark);
+ --catalog-border-color: var(--c-border);
+ --catalog-active-color: var(--c-brand);
+ --catalog-hover-color: var(--c-brand-light);
+}
+
+// plugin-docsearch
+.DocSearch {
+ --docsearch-primary-color: var(--c-brand);
+ --docsearch-text-color: var(--c-text);
+ --docsearch-highlight-color: var(--c-brand);
+ --docsearch-muted-color: var(--c-text-quote);
+ --docsearch-container-background: rgba(9, 10, 17, 0.8);
+ --docsearch-modal-background: var(--c-bg-light);
+ --docsearch-searchbox-background: var(--c-bg-lighter);
+ --docsearch-searchbox-focus-background: var(--c-bg);
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--c-brand);
+ --docsearch-hit-color: var(--c-text-light);
+ --docsearch-hit-active-color: var(--c-bg);
+ --docsearch-hit-background: var(--c-bg);
+ --docsearch-hit-shadow: 0 1px 3px 0 var(--c-border-dark);
+ --docsearch-footer-background: var(--c-bg);
+}
+
+// plugin-external-link-icon
+.external-link-icon {
+ --external-link-icon-color: var(--c-text-quote);
+}
+
+// plugin-medium-zoom
+.medium-zoom-overlay {
+ --medium-zoom-bg-color: var(--c-bg);
+}
+
+// plugin-nprogress
+#nprogress {
+ --nprogress-color: var(--c-brand);
+}
+
+// plugin-photo-swipe
+body {
+ --photo-swipe-bullet: var(--c-bg);
+ --photo-swipe-bullet-active: var(--c-brand);
+}
+
+// plugin-pwa-popup
+html {
+ --pwa-text-color: var(--c-text);
+ --pwa-bg-color: var(--c-bg);
+ --pwa-border-color: var(--c-brand);
+ --pwa-btn-text-color: var(--c-bg);
+ --pwa-btn-bg-color: var(--c-brand);
+ --pwa-btn-hover-bg-color: var(--c-brand-light);
+}
+
+html.dark {
+ --pwa-shadow-color: rgb(0 0 0 / 30%);
+ --pwa-content-color: #ccc;
+ --pwa-content-light-color: #999;
+}
+
+// plugin-redirect
+.language-modal-mask {
+ --redirect-bg-color: var(--c-bg);
+ --redirect-bg-color-light: var(--c-bg-light);
+ --redirect-bg-color-lighter: var(--c-bg-lighter);
+ --redirect-text-color: var(--c-text);
+ --redirect-primary-bg-color: var(--c-brand);
+ --redirect-primary-hover-bg-color: var(--c-brand-light);
+ --redirect-primary-text-color: var(--c-bg);
+}
+
+// plugin-search
+.search-box {
+ --search-bg-color: var(--c-bg);
+ --search-accent-color: var(--c-brand);
+ --search-text-color: var(--c-text);
+ --search-border-color: var(--c-border);
+
+ --search-item-text-color: var(--c-text-lighter);
+ --search-item-focus-bg-color: var(--c-bg-light);
+}
+点击查看暗黑模式 CSS 变量
html.dark {
+ // brand colors
+ --c-brand: #3aa675;
+ --c-brand-light: #349469;
+
+ // background colors
+ --c-bg: #22272e;
+ --c-bg-light: #2b313a;
+ --c-bg-lighter: #262c34;
+ --c-bg-dark: #343b44;
+ --c-bg-darker: #37404c;
+
+ // text colors
+ --c-text: #adbac7;
+ --c-text-light: #96a7b7;
+ --c-text-lighter: #8b9eb0;
+ --c-text-lightest: #8094a8;
+
+ // border colors
+ --c-border: #3e4c5a;
+ --c-border-dark: #34404c;
+
+ // custom container colors
+ --c-tip: #318a62;
+ --c-warning: #e0ad15;
+ --c-warning-bg: #2d2f2d;
+ --c-warning-bg-light: #423e2a;
+ --c-warning-bg-lighter: #44442f;
+ --c-warning-border-dark: #957c35;
+ --c-warning-details-bg: #39392d;
+ --c-warning-title: #fdca31;
+ --c-warning-text: #d8d96d;
+ --c-warning-text-accent: #ffbf00;
+ --c-warning-text-light: #ddb84b;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #fc1e38;
+ --c-danger-bg: #39232c;
+ --c-danger-bg-light: #4b2b35;
+ --c-danger-bg-lighter: #553040;
+ --c-danger-border-dark: #a25151;
+ --c-danger-details-bg: #482936;
+ --c-danger-title: #fc2d3b;
+ --c-danger-text: #ea9ca0;
+ --c-danger-text-accent: #fd3636;
+ --c-danger-text-light: #d9777c;
+ --c-danger-text-quote: #d56b6b;
+ --c-details-bg: #323843;
+
+ // badge component colors
+ --c-badge-warning: var(--c-warning);
+ --c-badge-warning-text: #3c2e05;
+ --c-badge-danger: var(--c-danger);
+ --c-badge-danger-text: #401416;
+
+ // code blocks vars
+ --code-hl-bg-color: #363b46;
+}
+
+// plugin-docsearch
+html.dark .DocSearch {
+ --docsearch-logo-color: var(--c-text);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309;
+ --docsearch-key-shadow: inset 0 -2px 0 0 #282d55, inset 0 0 1px 1px #51577d,
+ 0 2px 2px 0 rgba(3, 4, 9, 0.3);
+ --docsearch-key-gradient: linear-gradient(-225deg, #444950, #1c1e21);
+ --docsearch-footer-shadow: inset 0 1px 0 0 rgba(73, 76, 106, 0.5),
+ 0 -4px 8px 0 rgba(0, 0, 0, 0.2);
+}
+该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。
对于主题作者，该插件可以提供与 VuePress 及默认主题相同的多语言支持机制。但是如果你的主题不需要提供多语言支持，或者你想用你自己的方式来实现多语言支持，那么你不需要使用该插件。
使用方法
npm i -D @vuepress/plugin-theme-data@next
+import { themeDataPlugin } from '@vuepress/plugin-theme-data'
+
+export default {
+ plugins: [
+ themeDataPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
themeData
类型：
ThemeData默认值：
{}详情：
你希望在 Client 端中使用的主题数据对象。
你可以通过该配置项，在 Node 端提供主题数据，然后在客户端通过 useThemeData 和 useThemeLocaleData 来使用主题数据。
示例：
export default {
+ plugins: [
+ themeDataPlugin({
+ themeData: {
+ foo: 'foo',
+ locales: {
+ '/zh/': {
+ foo: 'zh-foo',
+ },
+ },
+ },
+ }),
+ ],
+}
+注意
主题数据对象在传递到客户端之前，会使用 JSON.stringify() 进行处理，因此你需要保证你提供的是一个可以被 JSON 序列化的对象。
Composition API
useThemeData
详情：
返回主题数据的 Ref 对象。
数据是通过 themeData 配置项提供的。
示例：
import { useThemeData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeData = useThemeData<MyThemeData>()
+ console.log(themeData.value)
+ },
+}
+useThemeLocaleData
详情：
返回当前 locale 下主题数据的 Ref 对象。
当前 locale 中的字段已被合并到顶层字段中。
示例：
import { useThemeLocaleData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeLocaleData = useThemeLocaleData<MyThemeData>()
+ console.log(themeLocaleData.value)
+ },
+}
+This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
For theme authors, this plugin will help you to use the same i18n mechanism as VuePress and the default theme. But if you don't want to provide i18n support, or you want to implement in your own way, you don't need this plugin.
Usage
npm i -D @vuepress/plugin-theme-data@next
+import { themeDataPlugin } from '@vuepress/plugin-theme-data'
+
+export default {
+ plugins: [
+ themeDataPlugin({
+ // options
+ }),
+ ],
+}
+Options
themeData
Type:
ThemeDataDefault:
{}Details:
The theme data object that you want to use in client side.
You can provide theme data in Node side via this option, and use it in client side via useThemeData and useThemeLocaleData.
Example:
export default {
+ plugins: [
+ themeDataPlugin({
+ themeData: {
+ foo: 'foo',
+ locales: {
+ '/zh/': {
+ foo: 'zh-foo',
+ },
+ },
+ },
+ }),
+ ],
+}
+WARNING
The theme data object will be processed by JSON.stringify() before forwarding to client side, so you should ensure that you are providing a JSON-friendly object.
Composition API
useThemeData
Details:
Returns the theme data ref object.
The value is provided by themeData option.
Example:
import { useThemeData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeData = useThemeData<MyThemeData>()
+ console.log(themeData.value)
+ },
+}
+useThemeLocaleData
Details:
Returns the theme data ref object in current locale.
The properties of current locale has been merged into the root-level properties.
Example:
import { useThemeLocaleData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeLocaleData = useThemeLocaleData<MyThemeData>()
+ console.log(themeLocaleData.value)
+ },
+}
+This plugin will provide a table-of-contents (TOC) component.
Usage
npm i -D @vuepress/plugin-toc@next
+import { tocPlugin } from '@vuepress/plugin-toc'
+
+export default {
+ plugins: [
+ tocPlugin({
+ // options
+ }),
+ ],
+}
+Differences with Markdown TOC Syntax
`,5),y=o(`<!-- markdown toc syntax -->
+
+[[toc]]
+
+<!-- vue toc component -->
+<Toc />
+Both of them can be pre-rendered correctly in build mode. However, there are some differences between them.
The markdown syntax [[toc]] could only be used in markdown files. It is parsed by markdown-it, and the generated TOC is static content.
The component <Toc/> could be used in both markdown files and vue files. It is loaded by vue, and the generated TOC is a vue component.
Therefore, this plugin is more useful for theme developers.
Options
componentName
Type:
stringDefault:
'Toc'Details:
Specify the name of the TOC component.
defaultPropsOptions
Type:
Partial<TocPropsOptions>Default:
{}Details:
Override the default values of the component options prop.
Component Props
The TOC component also accepts props for customization.
<template>
+ <Toc :headers="headers" :options="options" />
+</template>
+headers
- Type:
PageHeader[]
interface PageHeader {
+ level: number
+ title: string
+ slug: string
+ children: PageHeader[]
+}
+Details:
Specify the headers array to render.
If this prop is not specified, the headers of current page will be used.
options
- Type:
Partial<TocPropsOptions>
interface TocPropsOptions {
+ containerTag: string
+ containerClass: string
+ listClass: string
+ itemClass: string
+ linkTag: 'a' | 'RouterLink' | 'RouteLink'
+ linkClass: string
+ linkActiveClass: string
+ linkChildrenActiveClass: string
+}
+Default:
Following default values can be overridden by defaultPropsOptions.
const defaultOptions = {
+ containerTag: 'nav',
+ containerClass: 'vuepress-toc',
+ listClass: 'vuepress-toc-list',
+ itemClass: 'vuepress-toc-item',
+ linkTag: 'RouteLink',
+ linkClass: 'vuepress-toc-link',
+ linkActiveClass: 'active',
+ linkChildrenActiveClass: 'active',
+}
+Details:
Customize the TOC component.
If the
containerTagis set to an empty string'', the<nav>container will be removed totally.Example:
The rendered TOC component with default options looks like:
<template>
+ <!-- container -->
+ <nav class="vuepress-toc">
+ <!-- list -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link -->
+ <RouteLink class="vuepress-toc-link" to="#foo">Foo</RouteLink>
+ </li>
+ <!-- item with children -->
+ <li class="vuepress-toc-item">
+ <!-- link (children active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar">Bar</RouteLink>
+ <!-- list (children) -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link (active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar-child">
+ Bar Child
+ </RouteLink>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </nav>
+</template>
+该插件会提供一个目录 (table-of-contents, TOC) 组件。
使用方法
npm i -D @vuepress/plugin-toc@next
+import { tocPlugin } from '@vuepress/plugin-toc'
+
+export default {
+ plugins: [
+ tocPlugin({
+ // 配置项
+ }),
+ ],
+}
+与 Markdown 目录语法的区别
`,5),y=p(`<!-- Markdown 目录语法 -->
+
+[[toc]]
+
+<!-- Vue 目录组件 -->
+<Toc />
+在 Build 模式中，它们都可以被正确地预渲染。然而，它们之间存在一些区别。
Markdown 语法 [[toc]] 仅能在 Markdown 文件中使用。它是由 markdown-it 解析的，生成的目录是静态内容。
组件 <Toc/> 既可以用在 Markdown 文件中，也可以用在 Vue 文件中。它是由 Vue 加载的，生成的目录是一个 Vue 组件。
因此，该插件对于主题开发者来说更为有用。
配置项
componentName
类型：
string默认值：
'Toc'详情：
指定目录组件的名称。
defaultPropsOptions
类型：
Partial<TocPropsOptions>默认值：
{}详情：
覆盖组件 options Prop 的默认值。
组件 Props
目录组件可以通过 Props 来进行自定义。
<template>
+ <Toc :headers="headers" :options="options" />
+</template>
+headers
- 类型：
PageHeader[]
interface PageHeader {
+ level: number
+ title: string
+ slug: string
+ children: PageHeader[]
+}
+详情：
指定要渲染的标题数组。
如果该 Prop 没有被设置，默认会使用当前页面的标题。
options
- 类型：
Partial<TocPropsOptions>
interface TocPropsOptions {
+ containerTag: string
+ containerClass: string
+ listClass: string
+ itemClass: string
+ linkTag: 'a' | 'RouterLink' | 'RouteLink'
+ linkClass: string
+ linkActiveClass: string
+ linkChildrenActiveClass: string
+}
+默认值：
下列默认值可以用过 defaultPropsOptions 来覆盖：
const defaultOptions = {
+ containerTag: 'nav',
+ containerClass: 'vuepress-toc',
+ listClass: 'vuepress-toc-list',
+ itemClass: 'vuepress-toc-item',
+ linkTag: 'RouteLink',
+ linkClass: 'vuepress-toc-link',
+ linkActiveClass: 'active',
+ linkChildrenActiveClass: 'active',
+}
+详情：
自定义目录组件。
如果
containerTag设置为空字符串''，那么最外层的<nav>Container 会被完全移除。示例：
使用默认 options 的目录组件的渲染结果类似以下结构：
<template>
+ <!-- container -->
+ <nav class="vuepress-toc">
+ <!-- list -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link -->
+ <RouteLink class="vuepress-toc-link" to="#foo">Foo</RouteLink>
+ </li>
+ <!-- item with children -->
+ <li class="vuepress-toc-item">
+ <!-- link (children active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar">Bar</RouteLink>
+ <!-- list (children) -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link (active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar-child">
+ Bar Child
+ </RouteLink>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </nav>
+</template>
+
active-header-links
This plugin will listen to page scroll event. When the page scrolls to a certain header anchor, this plugin will change the route hash to that header anchor if there is a corresponding header link.
This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
Usage
npm i -D @vuepress/plugin-active-header-links@next
+import { activeHeaderLinksPlugin } from '@vuepress/plugin-active-header-links'
+
+export default {
+ plugins: [
+ activeHeaderLinksPlugin({
+ // options
+ }),
+ ],
+}
+Options
headerLinkSelector
Type:
stringDefault:
'a.sidebar-item'Details:
Selector of header link.
If a header anchor does not have a corresponding header link, this plugin won't change the route hash to that anchor when scrolling to it.
headerAnchorSelector
Type:
stringDefault:
'.header-anchor'Details:
Selector of header anchor.
You don't need to specify this option unless you have changed the
permalinkClassoption of markdown-it-anchor via markdown.anchor.Also see:
delay
Type:
numberDefault:
200Details:
The delay of the debounced scroll event listener.
offset
Type:
numberDefault:
5Details:
Even if you click the link of the header anchor directly, the
scrollTopmight not be exactly equal tooffsetTopof the header anchor, so we add an offset to avoid the error.
back-to-top
This plugin will add a back to top button to your site. The button will be displayed in the bottom right corner of the page when scrolling down. By clicking the button, the page will scroll to the top.
This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-back-to-top@next
+import { backToTopPlugin } from '@vuepress/plugin-back-to-top'
+
+export default {
+ plugins: [backToTopPlugin()],
+}
+Options
threshold
- Type:
number - Default:
100 - Details: Scroll threshold distance to display back to top button (in pixels)
progress
- Type:
boolean - Default:
true - Details: Whether display progress bar around icon
Styles
You can customize the style of the back to top button via CSS variables:
:root {
+ --back-to-top-z-index: 5;
+ --back-to-top-icon: url("back-to-top.svg");
+ --back-to-top-bg-color: #fff;
+ --back-to-top-color: #3eaf7c;
+ --back-to-top-color-hover: #71cda3;
+ --back-to-top-shadow: rgb(0 0 0 / 20%);
+}
+baidu-analytics
Integrate Baidu Analytics into VuePress.
Usage
npm i -D @vuepress/plugin-baidu-analytics@next
+import { baiduAnalyticsPlugin } from '@vuepress/plugin-baidu-analytics'
+
+export default {
+ plugins: [
+ baiduAnalyticsPlugin({
+ // options
+ }),
+ ],
+}
+Reporting Events
After using this plugin, the global hmt array is available on the window object, and you can use it for custom events reporting.
Options
id
Type:
stringDetails: The ID of Baidu Analytics, which is the query of
hm.jsURL.
Config
Plugin Options
getInfo
Type:
(page: Page) => Record<string, unknown>Required: No
Reference:
Details:
Function getting article info.
Article info will be injected in route meta so that they will be available later in client composables.
filter
Type:
(page: Page) => booleanDefault:
(page) => Boolean(page.filePathRelative) && !page.frontmatter.homeReference:
Details:
Page filter, determine whether a page should be included.
By default, all the pages generated from Markdown files but not homepage will be included as articles.
category
- Type:
BlogCategoryOptions[] - Required: No
- Reference:
- Details: Blog category config, see Blog Category Config
type
- Type:
BlogTypeOptions[] - Required: No
- Reference:
- Details: Blog type config, see Blog Type Config
slugify
- Type:
(name: string) => string - Default:
(name) => name.replace(/ _/g, '-').replace(/[:?*|\\/<>]/g, "").toLowerCase() - Details: Slugify function, used to convert key name which they are register in routes.
excerpt
- Type:
boolean - Default:
true - Reference:
- Details: Whether generate excerpt for page.
excerptSeparator
- Type:
string - Default:
<!-- more --> - Reference:
- Details: Separator used to split excerpt from page content.
excerptLength
Type:
numberDefault:
300Reference:
Details:
Length of excerpt when auto generating.
TIP
Excerpt length will be the minimal possible length reaching this value.
You can set it to
0to disable auto excerpt generation.
excerptFilter
Type:
(page: Page) => booleanDefault:
filteroptionReference:
Details:
Page filter, determine whether the plugin should generate excerpt for it.
TIP
You should use this to skip pages that you don't need to generate excerpt for. E.g.: If users set
excerptordescriptionin frontmatter, you may want to use them directly.
isCustomElement
Type:
(tagName: string) => booleanDefault:
() => falseReference:
Details:
Tags which is considered as custom elements.
This is used to determine whether a tag is a custom element since all unknown tags are removed in excerpt.
metaScope
Type:
stringDefault:
"_blog"Details:
Key used when injecting info to route meta.
TIP
Setting to an empty key will inject to route meta directly instead of a field.
hotReload
Type:
booleanDefault: Whether using
--debugflagDetails:
Whether enable hotReload in devServer.
To theme developers
It's disabled by default because it does have performance impact in sites with a lot of categories and types. And it can slow down hotReload speed when editing Markdown.
If users are adding or organizing your categories or tags, you may tell them to enable this, for the rest it's better to keep it disabled.
Also, you can try to detect number of pages in users project and decide whether to enable it.
Blog Category Config
Blog category config should be an array, while each item is controlling a "category" rule.
interface BlogCategoryOptions {
+ /**
+ * Unique category name
+ */
+ key: string
+
+ /**
+ * Function getting category from page
+ */
+ getter: (page: Page) => string[]
+
+ /**
+ * A custom function to sort the pages
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * Path pattern of page to be registered
+ *
+ * @description `:key` will be replaced by the "slugify" result of the original key
+ *
+ * @default `/:key/`
+ */
+ path?: string
+
+ /**
+ * Page layout name
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Frontmatter
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+
+ /**
+ * Item page path pattern or custom function to be registered
+ *
+ * @description When filling in a string, `:key` and `:name` will be replaced by the "slugify" result of the original key and name
+ *
+ * @default `/:key/:name/`
+ */
+ itemPath?: string | ((name: string) => string)
+
+ /**
+ * Item page layout name
+ *
+ * @default 'Layout'
+ */
+ itemLayout?: string
+
+ /**
+ * Items Frontmatter
+ */
+ itemFrontmatter?: (name: string, localePath: string) => Record<string, string>
+}
+Blog Type Config
Blog type config should be an array, while each item is controlling a "type" rule.
interface BlogTypeOptions {
+ /**
+ * Unique type name
+ */
+ key: string
+
+ /**
+ * A filter function to determine whether a page should be the type
+ */
+ filter: (page: Page) => boolean
+
+ /**
+ * A custom function to sort the pages
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * Page path to be registered
+ *
+ * @default '/:key/'
+ */
+ path?: string
+
+ /**
+ * Layout name
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Frontmatter
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+}
+Composition API
You can import the following API from @vuepress/plugin-blog/client.
Blog category
const useBlogCategory: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogCategoryData<T>> +Argument
keyshould be the category unique key.If no key is passed, the plugin will try to use the key in current path.
Blog category
const useBlogType: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogTypeData<T>> +Argument
keyshould be the type unique key.If no key is passed, the plugin will try to use the key in current path.
Returning values are:
interface Article<T extends Record<string, unknown> = Record<string, unknown>> {
+ /** Article path */
+ path: string
+ /** Article info */
+ info: T
+}
+
+interface BlogCategoryData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** Category path */
+ path: string
+
+ /**
+ * Only available when current route matches an item path
+ */
+ currentItems?: Article<T>[]
+
+ /** Category map */
+ map: {
+ /** Unique key under current category */
+ [key: string]: {
+ /** Category path of the key */
+ path: string
+ /** Category items of the key */
+ items: Article<T>[]
+ }
+ }
+}
+
+interface BlogTypeData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** Type path */
+ path: string
+
+ /** Items under current type */
+ items: Article<T>[]
+}
+With @vuepress/plugin-blog, you can easily bring blog feature into your theme.
Collecting Articles
The plugin filters all pages using filter option to drop pages you don't want.
By default, all pages generating from Markdown files but not homepage are considered as articles.
You can fully customize pages to collect through option filter, which accepts a function (page: Page) => boolean.
Gathering Info
You should set getInfo option with a function accepting Page as argument and returning an object containing the info you want.
The plugin will collect all the info you want and write them to routeMeta field of each page, so you will be able to get this information through Composition API later.
Demo
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ filter: ({ filePathRelative, frontmatter }) => {
+ // drop those pages which is NOT generated from file
+ if (!filePathRelative) return false
+
+ // drop those pages in `archives` directory
+ if (filePathRelative.startsWith('archives/')) return false
+
+ // drop those pages which do not use default layout
+ if (frontmatter.home || frontmatter.layout) return false
+
+ return true
+ },
+
+ getInfo: ({ frontmatter, git = {}, data = {} }) => {
+ // getting page info
+ const info: Record<string, any> = {
+ author: frontmatter.author || '',
+ categories: frontmatter.categories || [],
+ date: frontmatter.date || git.createdTime || null,
+ tags: frontmatter.tags || [],
+ excerpt: data.excerpt || '',
+ }
+
+ return info
+ },
+ }),
+ // other plugins ...
+ ],
+}
+Customizing Categories and Types
Basically, you would want 2 types of collection in your blog:
Category:
"Category" means grouping articles with their labels.
For example, each article may have their "categories" and "tags".
Type:
"Type" means identifying articles with conditions.
For example, you may want to describe some of your articles as diary.
After understanding description of these 2 types, you can set category and type options, each accepts an array, and each element represents a configuration.
Let's start with 2 examples here.
Imagine you are setting tags for each articles with tag field in page frontmatter. You want a tag mapping page in /tag/ with TagMap layout, and group each tag list with tagName in /tag/tagName with TagList layout, you probably need a configuration like this:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // other options ...
+ category: [
+ {
+ key: 'tag',
+ getter: ({ frontmatter }) => frontmatter.tag || [],
+ path: '/tag/',
+ layout: 'TagMap',
+ frontmatter: () => ({ title: 'Tag page' }),
+ itemPath: '/tag/:name/',
+ itemLayout: 'TagList',
+ itemFrontmatter: (name) => ({ title: `Tag ${name}` }),
+ },
+ ],
+ }),
+ // other plugins ...
+ ],
+}
+Also, you may want to star some of your articles, and display them to visitors. When you are setting star: true in frontmatter to mark them, you probably need a configuration like this to display them in /star/ path with StarList layout:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // other options ...
+ type: [
+ {
+ key: 'star',
+ filter: ({ frontmatter }) => frontmatter.star,
+ path: '/star/',
+ layout: 'StarList',
+ frontmatter: () => ({ title: 'Star page' }),
+ },
+ ],
+ }),
+ // other plugins ...
+ ],
+}
+See, setting these 2 types is easy. For full options, please see Category Config and Type Config.
Using Composition API in Client-side
When generating each page, the plugin will set following information under frontmatter.blog:
interface BlogFrontmatterOptions {
+ /** Current type of the page */
+ type: 'category' | 'type'
+ /** Unique key under current category or tag */
+ key: string
+ /**
+ * Current category name
+ *
+ * @description Only available in category item page
+ */
+ name?: string
+}
+So you can invoke useBlogCategory() and useBlogType() directly, and the result will be the category or type bind to current route.
Also, you can pass key you want as argument, then you will get information bind to that key.
So with node side settings above, you can get information about "tag" and "star" in client side:
TagMap layout:
<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+import { RouteLink } from 'vuepress/client'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+
+<template>
+ <div>
+ <h1>Tag page</h1>
+ <ul>
+ <li v-for="({ items, path }, name) in categoryMap.map">
+ <RouteLink :key="name" :to="path" class="category">
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </li>
+ </ul>
+ </div>
+</template>
+TagList layout:
<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+
+<template>
+ <div>
+ <h1>Tag page</h1>
+ <div class="category-wrapper">
+ <RouteLink
+ v-for="({ items, path }, name) in categoryMap.map"
+ :key="name"
+ :to="path"
+ class="category"
+ >
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </div>
+ <div class="article-wrapper" v-if="categoryMap.currentItems">
+ <div v-if="!categoryMap.currentItems.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in categoryMap.currentItems"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline
+ ? `${new Date(info.date).toLocaleDateString()}: `
+ : '') + info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author"
+ >Author: {{ info.author }}</span
+ >
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag"
+ >Tag: {{ info.tag.join(', ') }}</span
+ >
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+ </div>
+</template>
+StarList layout:
<script setup lang="ts">
+import { useBlogType } from '@vuepress/plugin-blog/client'
+import { RouteLink } from 'vuepress/client'
+
+import ArticleList from '../components/ArticleList.vue'
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+
+const stars = useBlogType('star')
+</script>
+
+<template>
+ <div class="article-wrapper" v-if="stars.items">
+ <div v-if="!stars.items.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in stars.items"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline ? `${new Date(info.date).toLocaleDateString()}: ` : '') +
+ info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author">Author: {{ info.author }}</span>
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag">Tag: {{ info.tag.join(', ') }}</span>
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+</template>
+For return types, please see Composition API Return Types.
I18n Support
This plugin adds native i18n support, so your settings will be automatically applied to each language.
For example, if user has the following locales' config, and you are setting the "star" example above:
export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+}
+Then /zh/star/ and /star/ will both be available, and only articles under the correct locale will appear.
Generating Excerpt
This plugin provides a built-in excerpt generator, which can be enabled by setting excerpt option to true.
Excerpt introduction
An excerpt is an HTML fragment that is used to display a short description of an article in the blog list, so the excerpt has the following restrictions:
- It doesn't support any unknown tags (including all Vue components) and Vue syntax, so these contents will be removed when generating. If you have custom components (non-Vue components), set
isCustomElementoption. - Since the snippet is an HTML fragment, you will not be able to import any images via relative paths or aliases, they will be removed directly. If you want to keep images, please use absolute path based on
.vuepress/publicor full URL to ensure they can be accessed in other places.
The excerpt generator will try to find a valid excerpt separator from markdown contents, if it finds one, it will use content before the separator. The separator is default <!-- more -->, and you can customize it by setting excerptSeparator option.
If it cannot find a valid separator, it will parse content from the beginning of markdown file, and stop till its length reaches a preset value. The value is default 300, and you can customize it by setting excerptLength option.
To choose which page should generate excerpt, you can use excerptFilter option.
Example
Normally you may want to use frontmatter.description if users set them, so you can let filter function return false if frontmatter.description is not empty.
+
+
+
diff --git a/plugins/catalog.html b/plugins/catalog.html
new file mode 100644
index 0000000000..2bef58ca21
--- /dev/null
+++ b/plugins/catalog.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+
+
catalog
The plugin can automatically generate catalog pages and provide catalog components.
Usage
npm i -D @vuepress/plugin-catalog@next
+import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ plugins: [
+ catalogPlugin({
+ // Your options
+ }),
+ ],
+}
+First, you should set catalog info in routeMeta:
import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ extendsPage: (page) => {
+ // set catalog info in routeMeta
+ page.routeMeta = {
+ // catalog title
+ title: page.title,
+ // ... other information
+ }
+ },
+}
+You can then import defineCatalogInfoGetter from @vuepress/plugin-catalog/client and use it in client config file to extract catalog info from meta.
import { defineCatalogInfoGetter } from '@vuepress/plugin-catalog/client'
+
+export default {
+ setup: () => {
+ defineCatalogInfoGetter((meta) =>
+ meta.title ? { title: meta.title } : null,
+ )
+ },
+}
+Catalog info should contains:
title: catalog titleorder: catalog order (optional)content: catalog content component (optional)
Sorting with order
The plugin will sort pages by order in the following way:
// order positive numbers from small to large
+Project with order 1
+Project with order 2
+...
+Project with order 10
+...
+// Project without order
+Project without order
+Project without order
+...
+// order negative numbers from small to large
+Project with order -10
+// ...
+Project with order -2
+Project with order -1
+Options
level Built-in component only
- Type:
1 | 2 | 3 - Default:
3 - Details: Max depth of catalog items.
index Built-in component only
- Type:
boolean - Default:
false - Details: Whether show index for catalog
frontmatter
Type:
(path: string) => Record<string, any>Required: No
Details: Frontmatter getter for the generated page.
Example:
import { catalogPlugin } from '@vuepress/plugin-catalog' + +export default { + plugins: [ + catalogPlugin({ + frontmatter: (path) => ({ + // frontmatter you want + // you may customize title, author. time, etc. + }), + }), + ], +} +
exclude
Type:
(RegExp | string)[]Default:
[]Details:
Catalog page path to be excluded during generation.
"/foo/"means only exclude catalog page generation at/foo/folder./^\/foo\//means exclude catalog page generation at/foo/folder and its subfolders.
404 pages will be automatically excluded.
component
- Type:
string - Required: No
- Details: Component name to use as catalog.
locales
Type:
CatalogPluginLocaleConfiginterface CatalogPluginLocaleData { + /** + * Catalog title + */ + title: string + + /** + * Empty hint + */ + empty: string +} + +interface CatalogPluginLocaleConfig { + [localePath: string]: CatalogPluginLocaleData +} +Required: No
Details: Locales config for catalog component.
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Client options
defineCatalogInfoGetter
interface CatalogInfo {
+ /** Catalog title */
+ title: string
+ /** Catalog order */
+ order?: number
+ /** Catalog content */
+ content?: Component
+}
+
+type CatalogInfoGetter = (meta: Record<string, unknown>) => CatalogInfo | null
+
+const defineCatalogInfoGetter: (options: CatalogInfoGetter) => void
+Customize how to extract catalog info from meta.
Components
Catalog
Details:
The plugin will globally register a
<Catalog />component by default (unless you set thecomponentoption).You can use
<Catalog />in the theme layout or directly in the Markdown file.The component supports four props:
level: Change the display depth (maximum support 3 levels), default is3.base: Display catalog of the specified folder, default is the current folder directory.index: Add an index number to the directory item, default is no number.hideHeading: Hide the component title, default is to display theCatalogtitle.
Styles
You can customize the style of catalog via CSS variables:
:root {
+ --catalog-bg-color: #fff;
+ --catalog-bg-secondary-color: #f8f8f8;
+ --catalog-border-color: #e5e5e5;
+ --catalog-active-color: #3eaf7c;
+ --catalog-hover-color: #71cda3;
+}
+container
Register markdown custom containers in your VuePress site.
This plugin simplifies the use of markdown-it-container, but also retains its original capabilities.
The Custom Containers of default theme is powered by this plugin.
Usage
npm i -D @vuepress/plugin-container@next
+import { containerPlugin } from '@vuepress/plugin-container'
+
+export default {
+ plugins: [
+ containerPlugin({
+ // options
+ }),
+ ],
+}
+Container Syntax
::: <type> [info]
+[content]
+:::
+- The
typeis required and should be specified via type option. - The
infois optional, and the default value can be specified viadefaultInfoin locales option. - The
contentcan be any valid markdown content.
TIP
This plugin can be used multiple times to support different types of containers.
Options
type
Type:
stringDetails:
The type of the container.
It will be used as the
nameparam of markdown-it-container.
locales
Type:
Record<string, { defaultInfo: string }>Details:
The default
infoof the container in different locales.If this option is not specified, the default
infowill fallback to the uppercase of the type option.Example:
export default {
+ plugins: [
+ containerPlugin({
+ type: 'tip',
+ locales: {
+ '/': {
+ defaultInfo: 'TIP',
+ },
+ '/zh/': {
+ defaultInfo: '提示',
+ },
+ },
+ }),
+ ],
+}
+- Also see:
before
Type:
(info: string) => stringDefault:
(info: string): string =>
+ `<div class="custom-container ${type}">${info ? `<p class="custom-container-title">${info}</p>` : ''}\n`
+Details:
A function to render the starting tag of the container.
The first param is the
infopart of container syntax.This option will not take effect if you don't specify the after option.
after
Type:
(info: string) => stringDefault:
(): string => '</div>\n'
+Details:
A function to render the ending tag of the container.
The first param is the
infopart of container syntax.This option will not take effect if you don't specify the before option.
render
- Type:
type MarkdownItContainerRenderFunction = (
+ tokens: Token[],
+ index: number,
+ options: any,
+ env: MarkdownEnv,
+ self: Renderer,
+) => string
+Details:
The
renderoption of markdown-it-container.This plugin uses a default
renderfunction. If you specify this option, the defaultrenderfunction will be replaced, and the locales, before and after options will be ignored.
validate
Type:
(params: string) => booleanDetails:
The
validateoption of markdown-it-container.
marker
Type:
stringDetails:
The
markeroption of markdown-it-container.
copy-code
This plugin will automatically add a copy button to the top right corner of each code block on PC devices.
The default selector matches @vuepress/theme-default, so you might need to change it when integrating your own theme.
Usage
npm i -D @vuepress/plugin-copy-code@next
+import { copyCodePlugin } from '@vuepress/plugin-copy-code'
+
+export default {
+ plugins: [
+ copyCodePlugin({
+ // options
+ }),
+ ],
+}
+Options
selector
Type:
string | string[]Default:
'.theme-default-content div[class*="language-"] pre'Details:
Code block selector
showInMobile
Type:
booleanDefault:
falseDetails:
Whether to display copy button on the mobile device
duration
Type:
numberDefault:
2000Details:
Hint display time, setting it to
0will disable the hint.
delay
Type:
numberDefault:
800Details:
The delay of registering copy code buttons, in ms.
If the theme you are using has a switching animation, it is recommended to configure this option to
Switch animation duration + 200.
locales
Type:
CopyCodePluginLocaleConfiginterface CopyCodePluginLocaleData { + /** + * Copy text + */ + copy: string + + /** + * Copied text + */ + copied: string +} + +interface CopyCodePluginLocaleConfig { + [localePath: string]: CopyCodePluginLocaleData +} +Required: No
Details:
Locales config for copy code plugin.
Example:
import { copyCodePlugin } from '@vuepress/plugin-copy-code' + +export default { + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + copyCodePlugin({ + locales: { + '/': { + // Override copy button label text + copy: 'Copy Codes from code block', + }, + + '/xx/': { + // Complete locale config for `mm-NN` language here + }, + }, + }), + ], +} +
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Styles
You can customize the icon of the copy button via CSS variables:
:root {
+ --code-copy-icon: url("copy-button.svg");
+ --code-copied-icon: url("copied-button.svg");
+ --copy-code-color: #9e9e9e;
+ --copy-code-hover: rgb(0 0 0 / 50%);
+}
+copyright
This plugin can automatically append copyright information when visitors copy content from your site, and can also prohibit site copying or selection.
Usage
npm i -D @vuepress/plugin-copyright@next
+import { copyrightPlugin } from '@vuepress/plugin-copyright'
+
+export default {
+ plugins: [
+ copyrightPlugin({
+ // options
+ }),
+ ],
+}
+Enabling Copyright
This plugin is disabled globally by default, you can:
- Manually enable it by setting
copy: truein page frontmatter - Set
global: truein plugin options to enable it globally, and setcopy: falsein page frontmatter to disable it.
To avoid disturbing visitors, copyright information will be appended only when the copied content length is greater than 100. Set triggerLength in plugin options if you want to change this threshold, or via copy.triggerLength in page frontmatter.
You can set default author and license information via author and license in plugin options.
If your site have different authors and license in different pages, you can set authorGetter and licenseGetter with function (page: Page) => string that takes the current page object as parameter and returns the corresponding information.
The plugin will generate copyright information from author, license, and page link via template by default, and append it when copying. If you think that this is not flexible enough, you can set copyrightGetter option to return a completely customized information with Page object or return null to use the default template.
Disable Copy and Selection
If you want to prevent users copying long content, you can set maxLength in plugin options to customize this limit, or via copy.maxLength in page frontmatter.
- If you don't want users to copy your entire site or specific page text, you can set
disableCopyin plugin options orcopy.disableCopyin page frontmatter, the latter has higher priority. - If you don't want users to select your entire site or specific page text, you can set
disableSelectionin plugin options orcopy.disableSelectionin page frontmatter. This option has higher priority.
Options
author
- Type:
string - Details: Default author Information
license
- Type:
string - Details: Default license Information
authorGetter
- Type:
(page: Page) => string | null - Details: Author getter
licenseGetter
- Type:
(page: Page) => string | null - Details: License getter
copyrightGetter
- Type:
(page: Page) => string | null - Details: Copyright getter
triggerLength
- Type:
number - Default:
100 - Details: Min content length triggering copyright append
maxLength
- Type:
number - Default:
0 - Details: Max content length which allows to copy,
0means no limit.
global
- Type:
boolean - Default:
false - Details: Whether enable globally.
disableCopy
- Type:
boolean - Default:
false - Details: Disable copy
disableSelection
- Type:
boolean - Default:
false - Details: Disable selection
canonical
- Type:
string - Details: Canonical deploy location.
Example
If you are deploying same content under https://myblog.com and https://blog.com/username/, you may want to prefer one site as reference link.
- If you prefer the first one, you should set
canonicaltohttps://myblog.com - If you prefer the second one, you should set
canonicaltohttps://blog.com/username/
So copyright message triggered on another site also points to your preferred site.
locales
Type:
CopyrightPluginLocaleConfiginterface CopyrightPluginLocaleData { + /** + * Author text + * + * @description `:author` will be replaced by author + */ + author: string + + /** + * License text + * + * @description `:license` will be replaced by current license + */ + license: string + + /** + * Link text + * + * @description `:link` will be replaced by current page link + */ + link: string +} + +interface CopyrightPluginLocaleConfig { + [localePath: string]: CopyrightPluginLocaleData +} +Details: Locale config for copyright plugin.
Example:
import { copyrightPlugin } from '@vuepress/plugin-copyright' + +export default { + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + copyrightPlugin({ + locales: { + '/': { + // Override link text + link: 'Original posted at :link', + }, + + '/xx/': { + // Complete locale config for `mm-NN` language here + }, + }, + }), + ], +} +
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Frontmatter
copy.triggerLength
- Type:
number - Default:
100 - Details: Min content length triggering copyright append
copy.maxLength
- Type:
number - Default:
0 - Details: Max content length which allows to copy,
0means no limit.
copy.disableCopy
- Type:
boolean - Default:
false - Details: Disable copy
copy.disableSelection
- Type:
boolean - Default:
false - Details: Disable selection
docsearch
Integrate Algolia DocSearch into VuePress, which can provide search to your documentation site.
TIP
Default theme will add DocSearch to the navbar once you configure this plugin correctly.
This plugin may not be used directly in other themes, so you'd better refer to the documentation of your theme for more details.
Usage
npm i -D @vuepress/plugin-docsearch@next
+import { docsearchPlugin } from '@vuepress/plugin-docsearch'
+
+export default {
+ plugins: [
+ docsearchPlugin({
+ // options
+ }),
+ ],
+}
+Get Search Index
You need to submit the URL of your site to join the DocSearch program. The DocSearch team will send apiKey and indexName to your email once the index is generated. Then you can configure this plugin to enable DocSearch in VuePress.
Alternatively, you can run your own crawler to generate the index, and then use your own appId, apiKey and indexName to configure this plugin.
Official crawler config
new Crawler({
+ appId: 'YOUR_APP_ID',
+ apiKey: 'YOUR_API_KEY',
+ rateLimit: 8,
+ startUrls: [
+ // These are urls which algolia start to craw
+ // If your site is divided in to mutiple parts,
+ // you may want to set mutiple entry links
+ 'https://YOUR_WEBSITE_URL/',
+ ],
+ sitemaps: [
+ // if you are using sitemap plugins (e.g.: @vuepress-plugin/sitemap), you may provide one
+ 'https://YOUR_WEBSITE_URL/sitemap.xml',
+ ],
+ ignoreCanonicalTo: false,
+ exclusionPatterns: [
+ // You can use this to stop algolia crawing some paths
+ ],
+ discoveryPatterns: [
+ // These are urls which algolia looking for,
+ 'https://YOUR_WEBSITE_URL/**',
+ ],
+ // Crawler schedule, set it according to your docs update frequency
+ schedule: 'at 02:00 every 1 day',
+ actions: [
+ // you may have mutiple actions, especially when you are deploying mutiple docs under one domain
+ {
+ // name the index with name you like
+ indexName: 'YOUR_INDEX_NAME',
+ // paths where the index take effect
+ pathsToMatch: ['https://YOUR_WEBSITE_URL/**'],
+ // controls how algolia extracts records from your site
+ recordExtractor: ({ $, helpers }) => {
+ // options for @vuepress/theme-default
+ return helpers.docsearch({
+ recordProps: {
+ lvl0: {
+ selectors: '.sidebar-heading.active',
+ defaultValue: 'Documentation',
+ },
+ lvl1: '.theme-default-content h1',
+ lvl2: '.theme-default-content h2',
+ lvl3: '.theme-default-content h3',
+ lvl4: '.theme-default-content h4',
+ lvl5: '.theme-default-content h5',
+ lvl6: '.theme-default-content h6',
+ content: '.theme-default-content p, .theme-default-content li',
+ },
+ indexHeadings: true,
+ })
+ },
+ },
+ ],
+ initialIndexSettings: {
+ // controls how index are initialized
+ // only has effects before index are initialize
+ // you may need to delete your index and recraw after modification
+ YOUR_INDEX_NAME: {
+ attributesForFaceting: ['type', 'lang'],
+ attributesToRetrieve: ['hierarchy', 'content', 'anchor', 'url'],
+ attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'],
+ attributesToSnippet: ['content:10'],
+ camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'],
+ searchableAttributes: [
+ 'unordered(hierarchy_radio_camel.lvl0)',
+ 'unordered(hierarchy_radio.lvl0)',
+ 'unordered(hierarchy_radio_camel.lvl1)',
+ 'unordered(hierarchy_radio.lvl1)',
+ 'unordered(hierarchy_radio_camel.lvl2)',
+ 'unordered(hierarchy_radio.lvl2)',
+ 'unordered(hierarchy_radio_camel.lvl3)',
+ 'unordered(hierarchy_radio.lvl3)',
+ 'unordered(hierarchy_radio_camel.lvl4)',
+ 'unordered(hierarchy_radio.lvl4)',
+ 'unordered(hierarchy_radio_camel.lvl5)',
+ 'unordered(hierarchy_radio.lvl5)',
+ 'unordered(hierarchy_radio_camel.lvl6)',
+ 'unordered(hierarchy_radio.lvl6)',
+ 'unordered(hierarchy_camel.lvl0)',
+ 'unordered(hierarchy.lvl0)',
+ 'unordered(hierarchy_camel.lvl1)',
+ 'unordered(hierarchy.lvl1)',
+ 'unordered(hierarchy_camel.lvl2)',
+ 'unordered(hierarchy.lvl2)',
+ 'unordered(hierarchy_camel.lvl3)',
+ 'unordered(hierarchy.lvl3)',
+ 'unordered(hierarchy_camel.lvl4)',
+ 'unordered(hierarchy.lvl4)',
+ 'unordered(hierarchy_camel.lvl5)',
+ 'unordered(hierarchy.lvl5)',
+ 'unordered(hierarchy_camel.lvl6)',
+ 'unordered(hierarchy.lvl6)',
+ 'content',
+ ],
+ distinct: true,
+ attributeForDistinct: 'url',
+ customRanking: [
+ 'desc(weight.pageRank)',
+ 'desc(weight.level)',
+ 'asc(weight.position)',
+ ],
+ ranking: [
+ 'words',
+ 'filters',
+ 'typo',
+ 'attribute',
+ 'proximity',
+ 'exact',
+ 'custom',
+ ],
+ highlightPreTag: '<span class="algolia-docsearch-suggestion--highlight">',
+ highlightPostTag: '</span>',
+ minWordSizefor1Typo: 3,
+ minWordSizefor2Typos: 7,
+ allowTyposOnNumericTokens: false,
+ minProximity: 1,
+ ignorePlurals: true,
+ advancedSyntax: true,
+ attributeCriteriaComputedByMinProximity: true,
+ removeWordsIfNoResults: 'allOptional',
+ },
+ },
+})
+The above recordProps is the configuration used for the default theme. You can modify them according to the theme you are using.
Notice that the initialIndexSettings.YOUR_INDEX_NAME.attributesForFaceting fields must include 'lang' to make this plugin work properly.
TIP
If you are not using default theme, or you meet any problems when using docsearch, you can also check the above example crawler config, and ahead to Algolia Crawler, and edit your config with 'Editor' panel in project sidebar.
Options
apiKey
Type:
stringRequired:
trueDetails:
The
apiKeythat you received from the DocSearch team, or generated by yourself.Also see:
indexName
Type:
stringRequired:
trueDetails:
The
indexNamethat you received from the DocSearch team, or generated by yourself.Also see:
appId
Type:
stringRequired:
trueDetails:
It defines your own application ID.
Also see:
searchParameters
Type:
SearchParametersDetails:
Parameters of Algolia Search API.
Also see:
placeholder
Type:
stringDefault:
'Search docs'Details:
The placeholder attribute of the search input.
Also see:
disableUserPersonalization
Type:
booleanDefault:
falseDetails:
Whether to disable all personalized features: recent searches, favorite searches, etc.
Also see:
initialQuery
Type:
stringDetails:
The initial query when the modal opens.
Also see:
translations
Type:
Partial<DocSearchTranslations>Details:
Allow replacing the default text in the DocSearch button or modal.
Also see:
locales
Type:
Record<string, DocsearchPluginOptions>Details:
Options of this plugin in different locales.
All other options of this plugin are acceptable in locale config.
Example:
export default {
+ plugins: [
+ docsearchPlugin({
+ appId: '<APP_ID>',
+ apiKey: '<API_KEY>',
+ indexName: '<INDEX_NAME>',
+ locales: {
+ '/': {
+ placeholder: 'Search Documentation',
+ translations: {
+ button: {
+ buttonText: 'Search Documentation',
+ },
+ },
+ },
+ '/zh/': {
+ placeholder: '搜索文档',
+ translations: {
+ button: {
+ buttonText: '搜索文档',
+ },
+ },
+ },
+ },
+ }),
+ ],
+}
+- Also see:
indexBase
Type:
stringDefault: base
Details:
The base path of the search index.
If you are deploying your site to multiple domains, you don't need to submit all of them to DocSearch and generate search index separately. You could choose one of the domains as the index domain, and only submit the index domain to Docsearch for crawling search index. Then, you could reuse the search index across all deployments.
However, if the base of your deployments are different for different domains, you need to set the option to the base of your index domain, so that other deployments could reuse the search index correctly.
injectStyles
Type:
booleanDefault:
trueDetails:
Whether to inject the default styles of DocSearch or not.
If you think the default styles of DocSearch is not compatible with your site, you can try to override the default styles, or set this option to
falseto totally exclude the default styles.When this option is disabled, you need to import your own styles for DocSearch. Also notice that all styles customization in Styles section would be unavailable.
Styles
You can customize styles via CSS variables that provided by @docsearch/css:
:root {
+ --docsearch-primary-color: rgb(84, 104, 255);
+ --docsearch-text-color: rgb(28, 30, 33);
+ --docsearch-spacing: 12px;
+ --docsearch-icon-stroke-width: 1.4;
+ --docsearch-highlight-color: var(--docsearch-primary-color);
+ --docsearch-muted-color: rgb(150, 159, 175);
+ --docsearch-container-background: rgba(101, 108, 133, 0.8);
+ --docsearch-logo-color: rgba(84, 104, 255);
+
+ /* modal */
+ --docsearch-modal-width: 560px;
+ --docsearch-modal-height: 600px;
+ --docsearch-modal-background: rgb(245, 246, 247);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 rgba(255, 255, 255, 0.5), 0 3px
+ 8px 0 rgba(85, 90, 100, 1);
+
+ /* searchbox */
+ --docsearch-searchbox-height: 56px;
+ --docsearch-searchbox-background: rgb(235, 237, 240);
+ --docsearch-searchbox-focus-background: #fff;
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--docsearch-primary-color);
+
+ /* hit */
+ --docsearch-hit-height: 56px;
+ --docsearch-hit-color: rgb(68, 73, 80);
+ --docsearch-hit-active-color: #fff;
+ --docsearch-hit-background: #fff;
+ --docsearch-hit-shadow: 0 1px 3px 0 rgb(212, 217, 225);
+
+ /* key */
+ --docsearch-key-gradient: linear-gradient(
+ -225deg,
+ rgb(213, 219, 228) 0%,
+ rgb(248, 248, 248) 100%
+ );
+ --docsearch-key-shadow: inset 0 -2px 0 0 rgb(205, 205, 230), inset 0 0 1px 1px
+ #fff, 0 1px 2px 1px rgba(30, 35, 90, 0.4);
+
+ /* footer */
+ --docsearch-footer-height: 44px;
+ --docsearch-footer-background: #fff;
+ --docsearch-footer-shadow: 0 -1px 0 0 rgb(224, 227, 232), 0 -3px 6px 0 rgba(69, 98, 155, 0.12);
+}
+Components
Docsearch
Details:
This plugin will register a
<Docsearch />component globally, and you can use it without any props.Put this component to where you want to place the docsearch button. For example, default theme puts this component to the end of the navbar.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
external-link-icon
This plugin will add an icon to the external link in your markdown content, i.e.
This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-external-link-icon@next
+import { externalLinkIconPlugin } from '@vuepress/plugin-external-link-icon'
+
+export default {
+ plugins: [
+ externalLinkIconPlugin({
+ // options
+ }),
+ ],
+}
+Options
locales
Type:
Record<string, { openInNewWindow: string }>Details:
The a11y text of the external link icon in different locales.
If this option is not specified, it will fallback to default text.
Example:
export default {
+ plugins: [
+ externalLinkIconPlugin({
+ locales: {
+ '/': {
+ openInNewWindow: 'open in new window',
+ },
+ '/zh/': {
+ openInNewWindow: '在新窗口打开',
+ },
+ },
+ }),
+ ],
+}
+- Also see:
Frontmatter
externalLinkIcon
Type:
booleanDetails:
Whether to append an external link icon to external links in current page.
Styles
You can customize the style of the external link icon via CSS variables:
:root {
+ --external-link-icon-color: #aaa;
+}
+Components
ExternalLinkIcon
Details:
This plugin will register a
<ExternalLinkIcon />component globally, and you can use it without any props.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
Channel Config
The channel plugin option is used to config the feed channel.
channel.title
- Type:
string - Default:
SiteConfig.title
Channel title
channel.link
- Type:
string - Default: Deployment link (generated by
options.hostnameandcontext.base)
Channel address
channel.description
- Type:
string - Default:
SiteConfig.description
Channel description
channel.language
Type:
stringDefault:
siteConfig.locales['/'].lang- If the above is not provided, fall back to
"en-US"
The language of the channel
channel.copyright
Type:
stringDefault:
- Try to read the
author.namein channel options, and fall back toCopyright by $author
- Try to read the
Recommended to set manually: Yes
Channel copyright information
channel.pubDate
- Type:
string(must be a valid Date ISOString) - Default: time when the plugin is called each time
- Recommended to set manually: Yes
Publish date of the Channel
channel.lastUpdated
- Type:
string(must be a valid Date ISOString) - Default: time when the plugin is called each time
Last update time of channel content
channel.ttl
- Type:
number - Recommended to set manually: Yes
The effective time of the content. It's the time to keep the cache after request without making new requests.
channel.image
- Type:
string - Recommended to set manually: Yes
A picture presenting the channel. A square picture with a size not smaller than 512×512 is recommended.
channel.icon
- Type:
string - Recommended to set manually: Yes
An icon representing a channel, a square picture, with not less than 128×128 in size, and transparent background color is recommended.
channel.author
- Type:
FeedAuthor - Recommended to set manually: Yes
The author of the channel.
FeedAuthor format
interface FeedAuthor {
+ /** Author name */
+ name: string
+ /** Author's email */
+ email?: string
+ /** Author's site */
+ url?: string
+ /**
+ * Author's avatar address
+ *
+ * Square, preferably not less than 128×128 with transparent background
+ */
+ avatar?: string
+}
+channel.hub
- Type:
string
Link to Websub. Websub requires a server backend, which is inconsistent with VuePress, so ignore it if there is no special need.
WebSub
For details, see Websub.
Plugin Config
hostname
- Type:
string - Required: Yes
The domain name of the deployment site.
atom
- Type:
boolean - Default:
false
Whether to output Atom syntax files.
json
- Type:
boolean - Default:
false
Whether output JSON syntax files.
rss
- Type:
boolean - Default:
false
Whether to output RSS syntax files.
image
- Type:
string
A large image/icon of the feed, probably used as banner.
icon
- Type:
string
A small icon of the feed, probably used as favicon.
count
- Type:
number - Default:
100
Set the maximum number of items in the feed. After all pages are sorted, the first count items will be intercepted.
If your site has a lot of articles, you may consider this option to reduce feed file size.
preservedElements
- Type:
(RegExp | string)[] | (tagName: string) => boolean
Custom element or component which should be preserved in feed.
By default, all unknown tags will be removed.
filter
Type:
(page: Page)=> booleanDefault:
;({ frontmatter, filePathRelative }: Page): boolean => + !( + frontmatter.home || + !filePathRelative || + frontmatter.article === false || + frontmatter.feed === false + ) +
A custom filter function, used to filter feed items.
sorter
Type:
(pageA: Page, pageB: Page)=> numberDefault:
// dateSorter is from @vuepress/helper +;(pageA: Page, pageB: Page): number => + dateSorter( + pageA.data.git?.createdTime + ? new Date(pageA.data.git?.createdTime) + : pageA.frontmatter.date, + pageB.data.git?.createdTime + ? new Date(pageB.data.git?.createdTime) + : pageB.frontmatter.date, + ) +
Custom sorter function for feed items.
The default sorting behavior is by file adding time coming from git (needs @vuepress/plugin-git).
TIP
You should enable @vuepress/plugin-git to get the newest created pages as feed items. Otherwise, the feed items will be sorted by the default order of pages in VuePress.
channel
channel option is used to config Feed Channels.
For available options, please see Config → Channel
devServer
- Type:
boolean - Default:
false
Whether enabled in devServer.
TIP
For performance reasons, we do not provide hot reload. Reboot your devServer to sync your changes.
devHostname
- Type:
string - Default:
"http://localhost:${port}"
Hostname to use in devServer
atomOutputFilename
- Type:
string - Default:
"atom.xml"
Atom syntax output filename, relative to dest folder.
atomXslTemplate
- Type:
string - Default: Content of
@vuepress/plugin-feed/templates/atom.xsl
Atom xsl template file content.
atomXslFilename
- Type:
string - Default:
"atom.xsl"
Atom xsl filename, relative to dest folder.
jsonOutputFilename
- Type:
string - Default:
"feed.json"
JSON syntax output filename, relative to dest folder.
rssOutputFilename
- Type:
string - Default:
"rss.xml"
RSS syntax output filename, relative to dest folder.
rssXslTemplate
- Type:
string - Default: Content of
@vuepress/plugin-feed/templates/rss.xsl
RSS xsl template file content.
rssXslFilename
- Type:
string - Default:
"rss.xsl"
RSS syntax xsl filename, relative to dest folder.
getter
Feed generation controller, see Feed Getter.
The plugin has a built-in getter, only set this if you want full control of feed generation.
locales
- Type:
Record<string, BaseFeedOptions>
You can use it to specific options for each locale.
Any options above are supported except hostname.
Frontmatter Config
You can control each feed item generation by setting page frontmatter.
Additions and Removals
By default, all articles are added to the feed stream. Set feed: false in frontmatter to remove a page from feed.
Frontmatter Information
title
- Type:
string
Automatically generated by VuePress, defaults to the h1 content of the page
description
- Type:
string
Description of the page
date
- Type:
Date
Date when the page was published
article
- Type:
boolean
Whether the page is an article
If this is set to
false, the page will not be included in the final feed.
copyright
- Type:
string
Page copyright information
cover / image / banner
- Type:
string
Image used as page cover , should be full link or absolute link.
Frontmatter Options
feed.title
- Type:
string
The title of the feed item
feed.description
- Type:
string
Description of the feed item
feed.content
- Type:
string
The content of the feed item
feed.author
- Type:
FeedAuthor[] | FeedAuthor
The author of the feed item
FeedAuthor format
interface FeedAuthor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.contributor
- Type:
FeedContributor[] | FeedContributor
Contributors to feed item
FeedContributor format
interface FeedContributor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.guid
- Type:
string
The identifier of feed item, used to identify the feed item.
You should ensure every feed has a unique guid.
Feed Getter
You can take full control of feed items generation by setting getter in the plugin options.
getter.title
- Type:
(page: Page) => string
Item title getter
getter.link
- Type:
(page: Page) => string
Item link getter
getter.description
- Type:
(page: Page) => string | undefined
Item description getter
TIP
Due to Atom support HTML in summary, so you can return HTML content here if possible, but the content must start with mark html:.
getter.content
- Type:
(page: Page) => string
Item content getter
getter.author
- Type:
(page: Page) => FeedAuthor[]
Item author getter.
The getter should return an empty array when author information is missing.
FeedAuthor format
interface FeedAuthor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.category
- Type:
(page: Page) => FeedCategory[] | undefined
Item category getter.
FeedCategory format
interface FeedCategory {
+ /**
+ * Category Name
+ */
+ name: string
+
+ /**
+ * A string that identifies a categorization taxonomy
+ *
+ * @description rss format only
+ */
+ domain?: string
+
+ /**
+ * the categorization scheme via a URI
+ *
+ * @description atom format only
+ */
+ scheme?: string
+}
+getter.enclosure
- Type:
(page: Page) => FeedEnclosure | undefined
Item enclosure getter.
FeedEnclosure format
interface FeedEnclosure {
+ /**
+ * Enclosure link
+ */
+ url: string
+
+ /**
+ * what its type is
+ *
+ * @description should be a standard MIME Type, rss format only
+ */
+ Type: string
+
+ /**
+ * Size in bytes
+ *
+ * @description rss format only
+ */
+ length?: number
+}
+getter.publishDate
- Type:
(page: Page) => Date | undefined
Item release date getter
getter.lastUpdateDate
- Type:
(page: Page) => Date
Item last update date getter
getter.image
- Type:
(page: Page) => string
Item Image Getter
Ensure it's returning a full URL
getter.contributor
- Type:
(page: Page) => FeedContributor[]
Item Contributor Getter
The getter should return an empty array when contributor information is missing.
FeedContributor format
interface FeedContributor {
+ /**
+ * Author name
+ */
+ name?: string
+
+ /**
+ * Author email
+ */
+ email?: string
+
+ /**
+ * Author site
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * Author avatar
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.copyright
- Type:
(page: Page) => string | undefined
Item copyright getter
Guide
Usage
The plugin can generate feed files in the following three formats for you:
- Atom 1.0
- JSON 1.1
- RSS 2.0
Please set atom, json or rss to true in the plugin options according to the formats you want to generate.
To correctly generate feed links, you need to set hostname in the plugin options,
Readable Preview
When you open the feed file in browser, we magically convert atom and rss feed xml to human readable html via xsl template. Check atom and rss feed of this site as an example!
If you want to preview your feed in devServer, set devServer: true in plugin options. You may also need to set devHostname if you are not using the default http://localhost:{port}.
Channel settings
You can customize the feed channel information by setting the channel option.
We recommend the following settings:
- Convert the date of creating the feed to ISOString and write it into
channel.pubDate - The update period of the content set in
channel.ttl(unit: minutes) - Set copyright information via
channel.copyright - Set the channel author via
channel.author.
For detailed options and their default values, see Channel Config
Feed Generation
By default, all articles are added to the feed stream.
You can set feed and other options in page frontmatter to control contents of feed item. See Frontmatter Config for how they are converted.
You can take full control of feed items generation by configuring the getter in the plugin options. For detailed options and their default values, see Configuration → Feed Getter.
I18n Config
The plugin generates separate feeds for each language.
You can provide different settings for different languages via locales in the plugin options.
+
+
+
diff --git a/plugins/git.html b/plugins/git.html
new file mode 100644
index 0000000000..1957251271
--- /dev/null
+++ b/plugins/git.html
@@ -0,0 +1,66 @@
+
+
+
+
+
+
+
+
+
git
This plugin will collect git information of your pages, including the created and updated time, the contributors, etc.
The lastUpdated and contributors of default theme is powered by this plugin.
This plugin is mainly used to develop themes. You won't need to use it directly in most cases.
Usage
npm i -D @vuepress/plugin-git@next
+import { gitPlugin } from '@vuepress/plugin-git'
+
+export default {
+ plugins: [
+ gitPlugin({
+ // options
+ }),
+ ],
+}
+Git Repository
This plugin requires your project to be inside a Git Repository, so that it can collect information from the commit history.
You should ensure all commits are available when building your site. For example, CI workflows usually clone your repository with --depth 1 to avoid fetching all commits, so you should disable the behavior to make this plugin work properly in CI.
WARNING
This plugin will significantly slow down the speed of data preparation, especially when you have a lot of pages. You can consider disabling this plugin in dev mode to get better development experience.
Options
createdTime
Type:
booleanDefault:
trueDetails:
Whether to collect page created time or not.
updatedTime
Type:
booleanDefault:
trueDetails:
Whether to collect page updated time or not.
contributors
Type:
booleanDefault:
trueDetails:
Whether to collect page contributors or not.
Frontmatter
gitInclude
Type:
string[]Details:
An array of relative paths to be included when calculating page data.
Example:
---
+gitInclude:
+ - relative/path/to/file1
+ - relative/path/to/file2
+---
+Page Data
This plugin will add a git field to page data.
After using this plugin, you can get the collected git information in page data:
import type { GitPluginPageData } from '@vuepress/plugin-git'
+import { usePageData } from 'vuepress/client'
+
+export default {
+ setup() {
+ const page = usePageData<GitPluginPageData>()
+ console.log(page.value.git)
+ },
+}
+git.createdTime
Type:
numberDetails:
Unix timestamp in milliseconds of the first commit of the page.
This attribute would take the minimum of the first commit timestamps of the current page and the files listed in gitInclude.
git.updatedTime
Type:
numberDetails:
Unix timestamp in milliseconds of the last commit of the page.
This attribute would take the maximum of the last commit timestamps of the current page and the files listed in gitInclude.
git.contributors
- Type:
GitContributor[]
interface GitContributor {
+ name: string
+ email: string
+ commits: number
+}
+Details:
The contributors information of the page.
This attribute would also include contributors to the files listed in gitInclude.
google-analytics
Integrate Google Analytics into VuePress.
This plugin will import gtag.js for Google Analytics 4.
Usage
npm i -D @vuepress/plugin-google-analytics@next
+import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics'
+
+export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ // options
+ }),
+ ],
+}
+Reporting Events
Google Analytics will automatically collect some events, such as page_view, first_visit, etc.
So if you only want to collect some basic data of your site, you don't need to do anything else except setting the Measurement ID correctly.
After using this plugin, the global gtag() function is available on the window object, and you can use it for custom events reporting.
Options
id
Type:
stringDetails:
The Measurement ID of Google Analytics 4, which should start with
'G-'.You can follow the instructions here to find your Measurement ID. Notice the difference between Google Analytics 4 Measurement ID (i.e. "G-" ID) and Universal Analytics Tracking ID (i.e. "UA-" ID).
Example:
export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ }),
+ ],
+}
+debug
Type:
booleanDetails:
Set to
trueto enable sending events to DebugView. See more information on DebugView.Example:
export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ debug: true,
+ }),
+ ],
+}
+
+
+
+
diff --git a/plugins/medium-zoom.html b/plugins/medium-zoom.html
new file mode 100644
index 0000000000..fecf867706
--- /dev/null
+++ b/plugins/medium-zoom.html
@@ -0,0 +1,67 @@
+
+
+
+
+
+
+
+
+
medium-zoom
Integrate medium-zoom into VuePress, which can provide the ability to zoom images.
This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-medium-zoom@next
+import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom'
+
+export default {
+ plugins: [
+ mediumZoomPlugin({
+ // options
+ }),
+ ],
+}
+Options
selector
Type:
stringDefault:
':not(a) > img'Details:
Selector of zoomable images.
By default this plugin will make all images zoomable except those inside
<a>tags.
delay
Type:
numberDefault:
500Details:
Delay in milliseconds.
After navigating to a new page, this plugin will make images zoomable with a delay.
zoomOptions
Type:
ObjectDetails:
Options for medium-zoom.
Also see:
Styles
You can customize most of the zoom styles via zoomOptions, while this plugin also provides some CSS variables for additional customization:
:root {
+ --medium-zoom-z-index: 100;
+ --medium-zoom-bg-color: #ffffff;
+ --medium-zoom-opacity: 1;
+}
+Composition API
useMediumZoom
Details:
Returns the
Zoominstance that used by this plugin, so that you can use the instance methods directly.This plugin will make images zoomable after navigating to current page. But if you are going to add new images dynamically, you may need this method to make those new images zoomable, too.
This plugin adds an extra
refreshmethod on theZoominstance, which will callzoom.detach()thenzoom.attach()with the selector as the default parameter. It will help you to refresh the zoomable images for current page.Example:
import { nextTick } from 'vue'
+import { useMediumZoom } from '@vuepress/plugin-medium-zoom/client'
+
+export default {
+ setup() {
+ const zoom = useMediumZoom()
+
+ // ... do something to add new images in current page
+
+ // then you may need to call `refresh` manually to make those new images zoomable
+ nextTick(() => {
+ zoom.refresh()
+ })
+ },
+}
+nprogress Plugin
Integrate nprogress into VuePress, which can provide a progress bar when navigating to another page.
This plugin has been integrated into the default theme.
Usage
npm i -D @vuepress/plugin-nprogress@next
+import { nprogressPlugin } from '@vuepress/plugin-nprogress'
+
+export default {
+ plugins: [nprogressPlugin()],
+}
+Styles
You can customize the style of the progress bar via CSS variables:
:root {
+ --nprogress-color: #29d;
+ --nprogress-z-index: 1031;
+}
+palette
Provide palette support for your theme.
This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
For theme authors, this plugin will help you to provide styles customization for users.
Usage
npm i -D @vuepress/plugin-palette@next
+import { palettePlugin } from '@vuepress/plugin-palette'
+
+export default {
+ plugins: [
+ palettePlugin({
+ // options
+ }),
+ ],
+}
+Palette and Style
This plugin will provide a @vuepress/plugin-palette/palette (palette file) and a @vuepress/plugin-palette/style (style file) to be imported in your theme styles.
The palette file is used for defining style variables, so it's likely to be imported at the beginning of your theme styles. For example, users can define CSS variables, SASS variables, LESS variables or Stylus variables in the palette, and then you can use those variables in your theme styles.
The style file is used for overriding the default styles or adding extra styles, so it's likely to be imported at the end of your theme styles.
Usage
Use this plugin in your theme, assuming you are using SASS:
export default {
+ // ...
+ plugins: [palettePlugin({ preset: 'sass' })],
+}
+Usage of Palette
Import the plugin's palette file where your theme needs to use the corresponding variables, such as in the Layout.vue file:
<template>
+ <h1 class="palette-title">Hello, Palette!</h1>
+</template>
+
+<style lang="scss">
+/* import variables from the plugin's palette file */
+@import '@vuepress/plugin-palette/palette';
+
+/* set default value for variables */
+$color: red !default;
+
+/* use variables in your styles */
+.palette-title {
+ color: $color;
+}
+</style>
+Then users can customize variables in .vuepress/styles/palette.scss:
$color: green;
+Usage of Style
Import the plugin's style file after your theme's styles, for example, in the clientConfigFile:
// import your theme's style file
+import 'path/to/your/theme/style'
+// import the plugin's style file
+import '@vuepress/plugin-palette/style'
+Then users can add extra styles in .vuepress/styles/index.scss and override the default styles of your theme:
h1 {
+ font-size: 2.5rem;
+}
+Options
preset
Type:
'css' | 'sass' | 'less' | 'stylus'Default:
'css'Details:
Set preset for other options.
If you don't need advanced customization of the plugin, it's recommended to only set this option and omit other options.
userPaletteFile
Type:
stringDefault:
- css:
'.vuepress/styles/palette.css' - sass:
'.vuepress/styles/palette.scss' - less:
'.vuepress/styles/palette.less' - stylus:
'.vuepress/styles/palette.styl'
- css:
Details:
File path of the user palette file, relative to source directory.
The default value depends on the preset option.
The file is where users define style variables, and it's recommended to keep the default file path as a convention.
tempPaletteFile
Type:
stringDefault:
- css:
'styles/palette.css' - sass:
'styles/palette.scss' - less:
'styles/palette.less' - stylus:
'styles/palette.styl'
- css:
Details:
File path of the generated palette temp file, relative to temp directory.
The default value depends on the preset option.
You should import the palette file via
'@vuepress/plugin-palette/palette'alias, so you don't need to change this option in most cases.
userStyleFile
Type:
stringDefault:
- css:
'.vuepress/styles/index.css' - sass:
'.vuepress/styles/index.scss' - less:
'.vuepress/styles/index.less' - stylus:
'.vuepress/styles/index.styl'
- css:
Details:
File path of the user style file, relative to source directory.
The default value depends on the preset option.
The file is where users override default styles or add extra styles, and it's recommended to keep the default file path as a convention.
tempStyleFile
Type:
stringDefault:
- css:
'styles/index.css' - sass:
'styles/index.scss' - less:
'styles/index.less' - stylus:
'styles/index.styl'
- css:
Details:
File path of the generated style temp file, relative to temp directory.
The default value depends on the preset option.
You should import the style file via
'@vuepress/plugin-palette/style'alias, so you don't need to change this option in most cases.
importCode
Type:
(filePath: string) => stringDefault:
- css:
(filePath) => `@import '${filePath}';\n` - sass:
(filePath) => `@forward 'file:///${filePath}';\n` - less:
(filePath) => `@import '${filePath}';\n` - stylus:
(filePath) => `@require '${filePath}';\n`
- css:
Details:
Function to generate import code.
The default value depends on the preset option.
This option is used for generating tempPaletteFile and tempStyleFile, and you don't need to change this option in most cases.
photo-swipe
This plugin will make the pictures in the body of the page enter the preview mode when clicked.
Usage
npm i -D @vuepress/plugin-photo-swipe@next
+import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe'
+
+export default {
+ plugins: [
+ photoSwipePlugin({
+ // options
+ }),
+ ],
+}
+In preview mode, you can:
- Swipe left and right to preview other pictures on the page in order
- View the description of the picture
- Zoom in and zoom out the picture
- View pictures in full screen
- Download pictures
- Share pictures
TIP
- Besides clicking "×" in the upper right corner to exit the preview mode, scrolling up and down more than a certain distance will also exit preview mode.
- On mobile devices, or using the PC trackpad, you can use pan and zoom gestures to pan and zoom in the preview mode.
Options
selector
- Type:
string | string[] - Default:
".theme-default-content :not(a) > img:not([no-view])" - Details: Image selector
scrollToClose
- Type:
boolean - Default:
true - Details: Whether close the current image when scrolling.
delay
Type:
numberDefault:
800Details:
The delay of operating dom, in ms.
TIP
If the theme you are using has a switching animation, it is recommended to configure this option to
Switch animation duration + 200.
locales
Type:
PhotoSwipePluginLocaleConfiginterface PhotoSwipePluginLocaleData { + /** + * Close button label text + */ + close: string + + /** + * Full screen button label text + */ + fullscreen: string + + /** + * Share button label text + */ + share: string + + /** + * Zoom button label text + */ + zoom: string + + /** + * Previous image button label text + */ + prev: string + + /** + * Next image button label text + */ + next: string + + /** + * Share button config + */ + buttons: PhotoSwipeDefaultUI.ShareButtonData[] +} + +interface PhotoSwipePluginLocaleConfig { + [localePath: string]: PhotoSwipePluginLocaleData +} +Details: Locales config for photo-swipe plugin.
Example:
import { defineUserConfig } from 'vuepress' +import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe' + +export default defineUserConfig({ + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + photoSwipePlugin({ + locales: { + '/': { + // Override share label text + share: 'Share with friends', + }, + + '/xx/': { + // Complete locale config for `mm-NN` language here + }, + }, + }), + ], +}) +
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Frontmatter
- Type:
string | false - Details:
Image selector for the current page, or false to disable photo-swipe in current page.
Client Config
definePhotoSwipeConfig
Options passed to photo-swipe
import { definePhotoSwipeConfig } from '@vuepress/plugin-photo-swipe/client'
+
+definePhotoSwipeConfig({
+ // set photoswipe options here
+})
+
+export default {}
+API
You can also call photoswipe with apis.
createPhotoSwipe allows you to programmatically view images links with PhotoSwipe:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue';
+import { createPhotoSwipe } from "@vuepress/plugin-photo-swipe/client";
+
+let state: PhotoSwipeState | null = null;
+
+const openPhotoSwipe = (index: number) => {
+ state?.open(index - 1);
+};
+
+onMounted(async () => {
+ // create a new photoswipe instance with image links
+ state= await createPhotoSwipe(
+ [
+ 'https://exmaple.com/image1.png'
+ 'https://exmaple.com/image2.png'
+ 'https://exmaple.com/image3.png'
+ ],
+ {
+ // photoswipe options
+ }
+ );
+});
+
+onUnmounted(() => {
+ state?.destroy()
+})
+</script>
+
+<template>
+ <button v-for="i in 3" @click="openPhotoSwipe(i)">open photo {{ i }}</button>
+</template>
+registerPhotoSwipe allows you to register photoswipe for the given image elements:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue'
+import { registerPhotoSwipe } from '@vuepress/plugin-photo-swipe/client'
+
+let destroy: () => void | null = null
+
+onMounted(async () => {
+ await nextTick()
+
+ const images = Array.from(document.querySelectorAll('img'))
+
+ // create a new photoswipe instance on image elements
+ state = await registerPhotoSwipe(images, {
+ // photoswipe options
+ })
+})
+
+onUnmounted(() => {
+ destroy?.()
+})
+</script>
+Styles
You can customize the style via CSS variables:
:root {
+ --photo-swipe-bullet: #fff;
+ --photo-swipe-bullet-active: #3eaf7c;
+}
+prismjs
This plugin will enable syntax highlighting for markdown code fence with Prism.js.
This plugin has been integrated into the default theme.
Notice that this plugin would only tokenize the code fence without adding styles. When using it with a custom theme, you may need to choose and import Prism.js style theme yourself.
Usage
npm i -D @vuepress/plugin-prismjs@next
+import { prismjsPlugin } from '@vuepress/plugin-prismjs'
+
+export default {
+ plugins: [
+ prismjsPlugin({
+ // options
+ }),
+ ],
+}
+Options
preloadLanguages
Type:
string[]Default:
['markdown', 'jsdoc', 'yaml']Details:
Languages to preload.
By default, languages will be loaded on demand when parsing markdown files.
However, Prism.js has some potential issues about loading languages dynamically. To avoid them, you can preload languages via this option.
Config
Options
showInstall
- Type:
boolean - Default:
false - Details: Whether display install button when Service Worker is first registered successfully.
manifest
Type:
AppManifestDetails:
You can fill with an object which will be parsed to manifest.webmanifest.
TIP
Some options have their fallback if you don't set them.
- name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - short_name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - description:
siteConfig.description||siteConfig.locales['/'].description||"A site built with vuepress" - lang:
siteConfig.locales['/'].lang||"en-US" - start_url:
context.base - scope:
context.base - display:
"standalone" - theme_color:
"#46bd87" - background_color:
"#ffffff" - orientation:
"portrait-primary" - prefer_related_applications:
false
- name:
Reference:
favicon
Type:
stringDetails:
Link of favicon.ico.
WARNING
We recommend you to set favicon for your site.
themeColor
Type:
stringDefault:
"#46bd87"Details:
Theme Color of the pwa.
cacheHTML
Type:
booleanDefault:
falseDetails:
Whether cache HTML files besides home page and 404 page.
cacheImage
Type:
booleanDefault:
falseDetails:
Whether cache pictures
maxSize
Type:
numberDefault:
2048Details:
Max size allowed to be cached, with KB unit
WARNING
This option has the highest priority, and any files exceeding this value will be excluded.
So if you generate very large HTML or JS files, please consider increasing this value, otherwise your PWA may not work normally in offline mode.
maxImageSize
Type:
numberDefault:
1024Details: Max picture size allowed to be cached, with KB unit
The value must not be greater than maxSize option
update
Type:
"disabled" | "available" | "hint" | "force"Default:
"available"Details: Control logic when new content is found.
"disabled": Do nothing even when new service worker is available. After new service work succeeds installing and starts waiting, it will control page and provide new content in next visit."available": Only display update popup when the new service worker is available"hint": Display a hint to let user choose to refresh immediatelyThis is helpful when you want users to see new docs immediately.
TIP
If users choose to refresh, the current service worker will be unregister, and request will start coming to web. Later the new service worker will start installing and control current page after installed.
"force": unregister current service worker immediately then refresh to get new contentDANGER
Although this ensures users are viewing the latest content, it may affect viewing experiences.
TIP
How docs are updated is controlled by a previous version, so the current option only effect next update from this version.
apple
Special settings for better supporting Safari, ignoring these options are safe.
apple.icon
- Type:
string - Details: Icon link used by Safari.
apple.statusBarColor
- Type:
"black" | "white" - Default:
"black" - Details: Status bar color for Safari
apple.maskIcon
- Type:
string - Details: Safari mask icon
msTile
Special settings for Microsoft tiles, ignoring these options are safe.
msTile.image
- Type:
string - Details: Tile image
msTile.color
- Type:
string - Default value:
themeColor - Details: Tile color
foundComponent
- Type:
string - Default:
"PwaFoundPopup" - Details: Path of custom hint popup component.
readyComponent
- Type:
string - Default:
"PwaReadyPopup" - Details: Path of custom update popup component.
appendBase
- Type:
boolean - Default:
false - Details: Whether append base to all absolute links in options.
generateSwConfig
Details:
Options passed to
workbox-build, for details, see Workbox documentation
locales
Type:
PwaPluginLocaleConfiginterface PwaPluginLocaleData { + /** + * Install button text + */ + install: string + + /** + * iOS install hint text + */ + iOSInstall: string + + /** + * Cancel button text + */ + cancel: string + + /** + * Close button text + */ + close: string + + /** + * Previous image text + */ + prevImage: string + + /** + * Next image text + */ + nextImage: string + + /** + * Install explain text + */ + explain: string + + /** + * Description label text + */ + desc: string + + /** + * Feature label text + */ + feature: string + + /** + * Update hint text + */ + hint: string + + /** + * Update available text + */ + update: string +} + +interface PwaPluginLocaleConfig { + [localePath: string]: PwaPluginLocaleData +} +Details: Locales config for pwa plugin.
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Composition API
usePwaEvent
Details:
Returns the event emitter of this plugin.
You can add listener function to events that provided by register-service-worker.
Example:
import { usePwaEvent } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+ event.on('ready', (registration) => {
+ console.log('Service worker is active.')
+ })
+ },
+}
+Utilities
forceUpdate
Details:
Force update the page when an update is found.
Example:
import { forceUpdate } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ forceUpdate()
+ })
+ },
+}
+registerSW
Details:
Register service worker manually.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| serviceWorkerPath | string | Path of the service worker |
| hooks | object | Hooks of service worker |
| showStatus | boolean | Log service worker status in console |
interface Hooks {
+ registrationOptions?: RegistrationOptions
+ ready?: (registration: ServiceWorkerRegistration) => void
+ registered?: (registration: ServiceWorkerRegistration) => void
+ cached?: (registration: ServiceWorkerRegistration) => void
+ updated?: (registration: ServiceWorkerRegistration) => void
+ updatefound?: (registration: ServiceWorkerRegistration) => void
+ offline?: () => void
+ error?: (error: Error) => void
+}
+- Example:
import { registerSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ registerSW('/service-worker.js', {
+ ready(registration) {
+ console.log('Service worker is active.')
+ },
+ })
+ })
+ },
+}
+skipWaiting
Details:
Activate the waiting service worker.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| registration | ServiceWorkerRegistration | The registration of the service worker you want activate |
- Example:
import { usePwaEvent, skipWaiting } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+
+ event.on('updated', (registration) => {
+ console.log('The waiting service worker is available.')
+ // activate the waiting service worker
+ skipWaiting(registration)
+ })
+ },
+}
+unregisterSW
Details:
Unregister service worker manually.
Example:
import { unregisterSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ unregisterSW()
+ })
+ },
+}
+Styles
You can customize the style via CSS variables:
:root {
+ --pwa-z-index: 10;
+ --pwa-color: #2c3e50;
+ --pwa-bg-color: #ffffff;
+ --pwa-border-color: #3eaf7c;
+ --pwa-shadow-color: rgb(0 0 0 / 15%);
+ --pwa-btn-text-color: #ffffff;
+ --pwa-btn-bg-color: #3eaf7c;
+ --pwa-btn-hover-bg-color: #4abf8a;
+ --pwa-content-color: #333;
+ --pwa-content-light-color: #666;
+}
+Guide
Intro
Make your VuePress site a Progressive Web Application (PWA)[1].
This plugin uses workbox-build to generate service worker file, and uses register-service-worker to register service worker.
WARNING
If you enabled this plugin once and you want to disable it, you might need `@vuepress/plugin-remove-pwa to remove the existing service worker.
A PWA uses a Service Worker [2] (SW for short) to cache and proxy site content.
Web App Manifests
To make your website fully compliant with PWA, a Web app manifests [3] file is needed, and your pwa should satisfy the installability [4] specification.
You can set manifest option to customize the manifest file, or provide a manifest.webmanifest or manifest.json in public folder. The former has higher priority.
The plugin will automatically generate manifest.webmanifest for you and add manifest link declaration in each page, while you should still at least set a valid icon through manifest.icons or other icon related options in the PWA plugin.
WARNING
The installability [4:1] specification requires at least one valid icon to be declared in the manifest.
So if you do not configure manifest.icons, visitors can only enjoy the offline accessibility brought by the Service Worker cache, while cannot install your site as a PWA.
Besides the plugin does not process anything in the manifest by default, but outputs them as-is. This means that if you plan to deploy to a subdirectory, you should append the URL prefix to manifest Urls yourself. If everything you need is all under base directory, you can set appendBase: true in plugin options to let the plugin append base to any links in manifest.
Cache Control
To better control what the Service Worker can pre-cache, the plugin provides related options for cache control.
Default cache
By default, the plugin will pre-cache all js css files, and only homepage and 404 html are cached. The plugin will also cache font files (woff, woff2, eot, ttf, otf) and SVG icons.
Image Cache
If your site has only a few important images, and want them displayed in offline mode, you can cache site images by setting cacheImage: true .
We recognize images by file extension. Any files ending with .png, .jpg, .jpeg, .gif, .bmp, .webp will be regarded as images.
HTML Cache
If you have small sites, and would like to make document fully offline available, you can set cacheHTML to true to cache all HTML files.
Why only home and 404 page been cached by default?
Though VuePress generates HTML files through SSG[5] for all pages, these files are mainly used for SEO[6] and allow you to directly configure the backend without SPA[7] Visit any link.
VuePress is essentially an SPA. This means that you only need to cache the home page and enter from the home page to access all pages normally. Therefore, not caching other HTML by default can effectively reduce the cache size (40% smaller in size) and speed up the SW update speed.
But this also has the disadvantage. If the user enters the site directly from a non-home page, the HTML file for the first page still needs to be loaded from the internet. Also, in offline environment, users can only enter through the homepage and then navigate to the corresponding page by themselves. If they directly access a link, an inaccessible prompt will appear.
Size Control
To prevent large files from being included in the pre-cache list, any files > 2 MB or images > 1 MB will be omitted. You can customize these limits with maxSize and maxImageSize options (in KB unit).
Update Control
We provide the update option to control how users receive updates.
The default value of the update option is "available", which means that when new content available, the new SW will be installed and its resources will be fetched silently in the background. A pop-up window appears once the new SW is ready, and users can choose whether to refresh immediately to view new content. This means users are reading old content before a new SW is ready.
If your project is still in building stage, and you want to alert the user that he may be reading outdated content, you can set this to "hint". This allows users to be notified that new content has been published within seconds after visiting docs. But the negative effect of this is that if the user chooses to update before the new SW is ready, he will need to get all the resources of the page from the internet before the new SW installs and controls the page.
If your docs are stable, or you're hosting a blog and don't care much about users receiving the latest version right away, you can set this to "disabled", which means that the new SW will be installed completely silently in the background and start waiting, when all pages controlled by old SW are all closed, the new SW will start to take control and provide users with new content during next visit. This setting can prevent users from being disturbed during the visit.
To speed up user access under weak or no network conditions through SW, but also want users to always access new content, you can set this option to "force". This means any old SW will be removed as soon as a new SW is detected, and all pages are refreshed to ensure the user is browsing the latest content. The biggest disadvantage is that all users will experience unexpected sudden refresh within seconds after reentering an updated site.
Popups
When new content is detected (new SW detected), a update found popup appears; and when the new content is ready, an update ready popup appears.
If you are not satisfied with the default popup content, you can use your own component. Import PwaFoundPopup or PwaReadyPopup from @vuepress/plugin-pwa/client and use its slot to customize the popup content, then pass the component path to foundComponent or readyComponent option:
<script setup lang="ts">
+import { PwaFoundPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaFoundPopup v-slot="{ found, refresh }">
+ <div v-if="found">
+ New content is found.
+ <button @click="refresh">Refresh</button>
+ </div>
+ </PwaFoundPopup>
+</template>
+<script setup lang="ts">
+import { PwaReadyPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaReadyPopup v-slot="{ isReady, reload }">
+ <div v-if="isReady">
+ New content is ready.
+ <button @click="reload">Apply</button>
+ </div>
+ </PwaReadyPopup>
+</template>
+Other Options
The plugin also provides other PWA-related options, such as Microsoft tile icon and color settings, Apple icon and so on. If you are an advanced user, you can also set generateSwConfig to configure workbox-build. Check Plugin options for more details.
Further Reading
For more details, please see:
PWA introduction
PWA, full name Progressive Web app. PWA standard is stipulated by W3C.
It allows sites to install the site as an App on supported platform through a browser that supports this feature.
See https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps for details. ↩︎
Service Worker Introduction
The Service Worker will get and cache all the files registered in it during the registration process.
After the registration complete, the Service Worker is activated, and starts to proxy and control all your requests.
Whenever you want to initiate an access request through the browser, the Service Worker will check whether it exists in its own cache list, if it exists, it will directly return the cached result, otherwise it will call its own fetch method to get it. You can use a custom fetch method to fully control the result of the request for resources in the web page, such as providing a fallback web page when offline.
Every time the user reopens the site, the Service Worker will request to the link when it was registered. If a new version of Service Worker is detected, it will update itself and start caching the list of resources registered in the new Service Worker . After the content update is successfully obtained, the Service Worker will trigger the
updateevent. The user can be notified through this event, for example, a pop-up window will be displayed in the lower right corner, prompting the user that new content is available and allowing the user to trigger an update.
Manifest File
The manifest file uses the JSON format and is responsible for declaring various information of the PWA, such as name, description, icon, and shortcut actions.
In order for your site to be registered as a PWA, you need to meet the basic specifications of the manifest to make the browser consider the site as an installable PWA and allow users to install it.
↩︎TIP
For Manifest standards and specifications, please see MDN Web app manifests and W3C Manifest.
Installable
To let the site be registered as a PWA, the site needs to successfully register a valid service worker by itself, and declare a valid manifest file with its link in meta tag.
The manifest file should contain at least
name(orshort_name)iconsstart_url.On safari, the maximum cache size of the service worker is 50 MB. ↩︎ ↩︎
SSG: Static Site Generation, ↩︎
SEO: Search Engine Optimization. ↩︎
SPA: Single Page Application, most of them only have the homepage, and use history mode to handle routing instead of actually navigating between pages. ↩︎
+
+
+
diff --git a/plugins/reading-time.html b/plugins/reading-time.html
new file mode 100644
index 0000000000..eab67d1a5d
--- /dev/null
+++ b/plugins/reading-time.html
@@ -0,0 +1,131 @@
+
+
+
+
+
+
+
+
+
reading-time
This plugin will generate word count and estimated reading time for each page.
Usage
npm i -D @vuepress/plugin-reading-time@next
+import { readingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default {
+ plugins: [
+ readingTimePlugin({
+ // options
+ }),
+ ],
+}
+The plugin will inject reading time information into the readingTime of the page data, where:
readingTime.minutes: estimated reading time (minutes)numberreadingTime.words: word countnumber
Getting data on Node Side
For any page, you can get estimated reading time and word count from page.data.readingTime:
page.data.readingTime // { minutes: 3.2, words: 934 }
+You can access it for further processing in the extendsPage lifecycle and other lifecycle:
export default {
+ // ...
+ extendsPage: (page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ },
+
+ onInitialized: (app) => {
+ app.pages.map((page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ })
+ },
+}
+Getting data on Client Side
You can import useReadingTimeData and useReadingTimeLocale from @vuepress/plugin-reading-time/client to get the reading time data and locale data of the current page:
<script setup lang="ts">
+import {
+ useReadingTimeData,
+ useReadingTimeLocale,
+} from '@vuepress/plugin-reading-time/client'
+
+const readingTimeData = useReadingTimeData() // { minutes: 1.1, words: 100 }
+const readingTimeLocale = useReadingTimeLocale() // { time: "1 minute", words: "100 words" }
+</script>
+Options
wordPerMinute
- Type:
number - Default:
300 - Details: Reading speed (words per minute)
locales
Type:
ReadingTimePluginLocaleConfiginterface ReadingTimePluginLocaleData { + /** + * Word template, `$word` will be automatically replaced by actual words + */ + word: string + + /** + * Text for less than one minute + */ + less1Minute: string + + /** + * Time template + */ + time: string +} + +interface ReadingTimePluginLocaleConfig { + [localePath: string]: ReadingTimePluginLocaleData +} +Required: No
Details:
Locales config for reading-time plugin.
Built-in Supported Languages
- Simplified Chinese (zh-CN)
- Traditional Chinese (zh-TW)
- English (United States) (en-US)
- German (de-DE)
- German (Australia) (de-AT)
- Russian (ru-RU)
- Ukrainian (uk-UA)
- Vietnamese (vi-VN)
- Portuguese (Brazil) (pt-BR)
- Polish (pl-PL)
- French (fr-FR)
- Spanish (es-ES)
- Slovak (sk-SK)
- Japanese (ja-JP)
- Turkish (tr-TR)
- Korean (ko-KR)
- Finnish (fi-FI)
- Indonesian (id-ID)
- Dutch (nl-NL)
Client API
You can import and use these APIs from @vuepress/plugin-reading-time/client:
These APIs won't throw even you disable the plugin.
useReadingTimeData
interface ReadingTime {
+ /** Expect reading time in minute unit */
+ minutes: number
+ /** Words count of content */
+ words: number
+}
+
+const useReadingTimeData: () => ComputedRef<ReadingTime | null>
+null is returned when the plugin is disabled.
useReadingTimeLocale
interface ReadingTimeLocale {
+ /** Expect reading time text in locale */
+ time: string
+ /** Word count text in locale */
+ words: string
+}
+
+const useReadingTimeLocale: () => ComputedRef<ReadingTimeLocale>
+Advanced Usage
This plugin is targeting plugin and theme developers mostly, so we provide a "Use API":
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ useReadingTimePlugin(app, {
+ // your options
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+Why you should use "Use API"
- When you register a plugin multiple times, vuepress will gives you warning about that telling you only the first one takes effect. The
useReadingTimePluginautomatically detects if the plugin is registered and avoid registering multiple times. - If you access reading time data in
extendsPagelifecycle, then@vuepress/plugin-reading-timemust be called before your theme or plugin, otherwise you will getundefinedforpage.data.readingTime. TheuseReadingTimePluginensures that@vuepress/plugin-reading-timeis called before your theme or plugin.
We also provides a removeReadingTimePlugin api to remove the plugin.You can use this to ensure your call take effect or clear the plugin:
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ // this removes any existing reading time plugin at this time
+ removeReadingTimePlugin(app)
+
+ // so this will take effect even if there is a reading time plugin registered before
+ useReadingTimePlugin(app, {
+ // your options
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+redirect
This plugin can automatically handle redirects for your site.
Usage
npm i -D @vuepress/plugin-redirect@next
+import { redirectPlugin } from '@vuepress/plugin-redirect'
+
+export default {
+ plugins: [
+ redirectPlugin({
+ // options
+ }),
+ ],
+}
+Control Page Redirection
If you change the address of an existing page, you can use the redirectFrom option in Frontmatter to redirect to the address of this page, which ensures that users are redirected to the new address when they visit the old link.
If you need to redirect an existing page to a new page, you can use the redirectTo option in Frontmatter to set the address to redirect to. This way the page will redirect to the new address when accessed.
You can also set config with a redirect map in plugin options, see config for more details.
Auto Locales
The plugin can automatically redirect non-multilingual links to the multilingual pages the user needs based on the user's language preference.
To achieve this, you need to leave the default language directory (/) blank and set autoLocale: true in plugin options. The plugin will automatically redirect to the correct page according to the user's language.
I.E.: you need to set the following directory structure:
.
+├── en
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+├── zh
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+└── other_languages
+ ├── ...
+ ├── page.md
+ └── README.md
+And set locales in theme options with:
export default {
+ locales: {
+ '/en/': {
+ lang: 'en-US',
+ // ...
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ // ...
+ },
+ // other languages
+ },
+ // ...
+}
+So when a user accesses / or /page.html, they are automatically redirected to /en/ /en/page.html and /en/ /en/page.html based on current browser language.
Customizing fallback behavior
Sometimes, users may add more than one language to the system settings. By default, when a site supports a preferred language, but the page not exists for the preferred language, the plugin attempts to match the alternate language set by the user.
If you don't need to fall back to the user's alternate language, but directly match the user's preferred language, set localeFallback: false in the plugin options.
Customizing missing behavior
Sometimes, when a user visits a page, the document does not yet contain the language version the user needs (a common case is that the current page has not been localized in the relevant language), so the plugin needs to perform a default action, which you can customize by defaultBehavior in the plugin options:
"defaultLocale": Redirect to default language or first available language page (default behavior)"homepage": redirect to the home page in the current language (only available if the document contains the user's language)"404": Redirect to page 404 in current language (only available if the document contains the user's language)
Customizing default locale path
You can customize the default locale path by setting defaultLocale in the plugin options. By default, the plugin uses the first locale key in locales as the default language.
Automatically switch languages
The plugin supports automatically switching the link to the multilingual page that the user needs according to the user's language preference when opening a multilingual document. In order to achieve this, you need to set switchLocale in the plugin options, which can be the following two values:
direct: switch directly to the user language preference page without askingmodal: When the user's language preference is different from the current page language, show a modal asking whether to switch language
Customizing Locale Settings
By default, the plugin generates a locale setting by reading locale path and lang from the site's locales option. Sometimes, you may want multiple languages to hit the same path, in which case you should set localeConfig in plugin options.
For example, you might want all English users to match to /en/ and Chinese Traditional users to /zh/, then you can set:
redirect({
+ localeConfig: {
+ '/en/': ['en-US', 'en-UK', 'en'],
+ '/zh/': ['zh-CN', 'zh-TW', 'zh'],
+ },
+})
+Redirecting Sites
Sometimes you may change base or use new domain for your site, so you may want the original site automatically redirects to the new one.
To solve this, the plugin provide vp-redirect cli.
Usage:
+ $ vp-redirect generate [sourceDir]
+
+Options:
+ --hostname <hostname> Hostname to redirect to (E.g.: https://new.example.com/) (default: /)
+ -c, --config <config> Set path to config file
+ -o, --output <output> Set the output directory (default: .vuepress/redirect)
+ --cache <cache> Set the directory of the cache files
+ -t, --temp <temp> Set the directory of the temporary files
+ --clean-cache Clean the cache files before generation
+ --clean-temp Clean the temporary files before generation
+ -h, --help Display this message
+You need to pass in VuePress project source dir and also set the hostname option. The redirect helper cli will initialize your VuePress project to get pages, then generate and output the redirect html files to the output directory.
By default, the plugin will output to .vuepress/redirect directory under source directory. And you should upload it to your original site to provide redirection.
Options
config
Type:
Record<string, string> | ((app: App) => Record<string, string>)Details: Redirect map.
Example:
When base is set to
/base/:- redirect
/base/foo.htmlto/base/bar.html /base/baz.htmltohttps://example.com/qux.html.
redirect({ + config: { + '/foo.html': '/bar.html', + '/baz.html': 'https://example.com/qux.html', + }, +}) +Redirect post folder to posts folder:
redirect({ + hostname: 'https://example.com', + config: (app) => + Object.fromEntries( + app.pages + .filter(({ path }) => path.startsWith('/posts/')) + .map(({ path }) => [path.replace(/^\/posts\//, '/post/'), path]), + ), +}) +- redirect
autoLocale
- Type:
boolean - Default:
false - Details: Whether enable locales redirection.
switchLocale
Type:
"direct" | "modal" | falseDefault:
falseDetails:
Whether switch to a new locale based on user preference.
"direct": redirect to the new locale directly without asking"modal": show a modal to let user choose whether to switch to the new locale
localeConfig
Type:
Record<string, string | string[]>Details: Locale language config
localeFallback
- Type:
boolean - Default:
true - Details: Whether fallback to other locales user defined
defaultBehavior
- Type:
"defaultLocale" | "homepage" | "404" - Default:
"defaultLocale" - Details: Behavior when a locale version is not available for current link.
defaultLocale
- Type:
string - Default: the first locale
- Details: Default locale path.
Frontmatter
redirectFrom
- Type:
string | string[] - Details: The link which this page redirects from.
redirectTo
- Type:
string - Details: The link which this page redirects to.
Styles
You can customize the style of the redirect popup via CSS variables:
:root {
+ --redirect-z-index: 1499;
+ --redirect-bg-color: #fff;
+ --redirect-bg-color-light: #f3f4f5;
+ --redirect-bg-color-lighter: #eeeeee;
+ --redirect-text-color: #2c3e50;
+ --redirect-primary-bg-color: #3eaf7c;
+ --redirect-primary-hover-bg-color: #4abf8a;
+ --redirect-primary-text-color: #fff;
+}
+register-components
Register Vue components from component files or directory automatically.
Usage
npm i -D @vuepress/plugin-register-components@next
+import { registerComponentsPlugin } from '@vuepress/plugin-register-components'
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ // options
+ }),
+ ],
+}
+Options
components
Type:
Record<string, string>Default:
{}Details:
An object that defines name of components and their corresponding file path.
The key will be used as the component name, and the value is an absolute path of the component file.
If the component name from this option conflicts with componentsDir option, this option will have a higher priority.
Example:
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ components: {
+ FooBar: path.resolve(__dirname, './components/FooBar.vue'),
+ },
+ }),
+ ],
+}
+componentsDir
Type:
string | nullDefault:
nullDetails:
Absolute path to the components directory.
Files in this directory which are matched with componentsPatterns will be registered as Vue components automatically.
Example:
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ componentsDir: path.resolve(__dirname, './components'),
+ }),
+ ],
+}
+Components directory:
components
+├─ FooBar.vue
+└─ Baz.vue
+Components will be registered like this:
import { defineAsyncComponent } from 'vue'
+
+app.component(
+ 'FooBar',
+ defineAsyncComponent(() => import('/path/to/components/FooBar.vue')),
+)
+
+app.component(
+ 'Baz',
+ defineAsyncComponent(() => import('/path/to/components/Baz.vue')),
+)
+componentsPatterns
Type:
string[]Default:
['**/*.vue']Details:
Patterns to match component files using globby.
The patterns are relative to componentsDir.
getComponentName
Type:
(filename: string) => stringDefault:
(filename) => path.trimExt(filename.replace(/\/|\\/g, '-'))Details:
A function to get component name from the filename.
It will only take effect on the files in the componentsDir which are matched with the componentsPatterns.
Notice that the
filenameis a filepath relative to componentsDir.
remove-pwa
This plugin removes any related service worker from your VuePress site, so that users can still get updates if you removed any PWA plugin after enabling it.
Why this plugin is needed if you used PWA plugin once?
PWA plugins like @vuepress/plugin-pwa register service worker to your site, which will cache your site and make it available offline.
However, if you remove pwa plugin, the old service worker will still be there, but they can never get an update because they can never found a new service worker to update to. So users will stay with the old version of your site.
To solve this problem:
- A new service worker with empty contents shall be generated in the original place.
- The new service worker shall attempt to remove contents that old service worker cached, then it should unregister itself.
Usage
npm i -D @vuepress/plugin-remove-pwa@next
+import { removePwaPlugin } from '@vuepress/plugin-remove-pwa'
+
+export default {
+ plugins: [
+ removePwaPlugin({
+ // options
+ }),
+ ],
+}
+Options
cachePrefix
- Type:
string - Default:
'workbox' - Details: The cache prefix for the service worker.
swLocation
- Type:
string - Default:
'service-worker.js' - Details: The location of the old service worker.
rtl
This plugin will set direction to rtl on configured locales.
Usage
npm i -D @vuepress/plugin-rtl@next
+import { rtlPlugin } from '@vuepress/plugin-rtl'
+
+export default {
+ plugins: [
+ rtlPlugin({
+ // options
+ locales: ['/ar/'],
+ }),
+ ],
+}
+Options
locales
- Type:
string[] - Default:
['/'] - Details: Locale path to enable rtl.
selector
Type:
SelectorOptionsinterface SelectorOptions { + [element: string]: { + [attrs: string]: string + } +} +Default:
{ 'html': { dir: 'rtl' } }Details:
Selector to enable rtl.
The default settings mean that the
dirattribute of thehtmlelement will be set tortlin rtl locales.
search
Provide local search to your documentation site.
TIP
Default theme will add search box to the navbar once you configure this plugin correctly.
This plugin may not be used directly in other themes, so you'd better refer to the documentation of your theme for more details.
Usage
npm i -D @vuepress/plugin-search@next
+import { searchPlugin } from '@vuepress/plugin-search'
+
+export default {
+ plugins: [
+ searchPlugin({
+ // options
+ }),
+ ],
+}
+Local Search Index
This plugin will generate search index from your pages locally, and load the search index file when users enter your site. In other words, this is a lightweight built-in search which does not require any external requests.
However, when your site has a large number of pages, the size of search index file would be very large, which could slow down the page loading speed. In this case, we recommend you to use a more professional solution - docsearch.
Options
locales
Type:
Record<string, { placeholder: string }>Details:
The text of the search box in different locales.
If this option is not specified, it will fallback to default text.
Example:
export default {
+ plugins: [
+ searchPlugin({
+ locales: {
+ '/': {
+ placeholder: 'Search',
+ },
+ '/zh/': {
+ placeholder: '搜索',
+ },
+ },
+ }),
+ ],
+}
+- Also see:
hotKeys
- Type:
(string | HotKeyOptions)[]
export interface HotKeyOptions {
+ /**
+ * Value of `event.key` to trigger the hot key
+ */
+ key: string;
+ /**
+ * Whether to press `event.altKey` at the same time
+ *
+ * @default false
+ */
+ alt?: boolean;
+ /**
+ * Whether to press `event.ctrlKey` at the same time
+ *
+ * @default false
+ */
+ ctrl?: boolean;
+ /**
+ * Whether to press `event.shiftKey` at the same time
+ *
+ * @default false
+ */
+ shift?: boolean;
+}
+Default:
['s', '/']Details:
Specify the event.key of the hotkeys.
When hotkeys are pressed, the search box input will be focused.
Set to an empty array to disable hotkeys.
maxSuggestions
Type:
numberDefault:
5Details:
Specify the maximum number of search results.
isSearchable
Type:
(page: Page) => booleanDefault:
() => trueDetails:
A function to determine whether a page should be included in the search index.
- Return
trueto include the page. - Return
falseto exclude the page.
- Return
Example:
export default {
+ plugins: [
+ searchPlugin({
+ // exclude the homepage
+ isSearchable: (page) => page.path !== '/',
+ }),
+ ],
+}
+getExtraFields
Type:
(page: Page) => string[]Default:
() => []Details:
A function to add extra fields to the search index of a page.
By default, this plugin will use page title and headers as the search index. This option could help you to add more searchable fields.
Example:
export default {
+ plugins: [
+ searchPlugin({
+ // allow searching the `tags` frontmatter
+ getExtraFields: (page) => page.frontmatter.tags ?? [],
+ }),
+ ],
+}
+Styles
You can customize the style of the search box via CSS variables:
:root {
+ --search-bg-color: #ffffff;
+ --search-accent-color: #3eaf7c;
+ --search-text-color: #2c3e50;
+ --search-border-color: #eaecef;
+ --search-item-text-color: #5d81a5;
+ --search-item-focus-bg-color: #f3f4f5;
+ --search-input-width: 8rem;
+ --search-result-width: 20rem;
+}
+Components
SearchBox
Details:
This plugin will register a
<SearchBox />component globally, and you can use it without any props.Put this component to where you want to place the search box. For example, default theme puts this component to the end of the navbar.
TIP
This component is mainly used for theme development. You don't need to use it directly in most cases.
Config
hostname
Type:
stringRequired: Yes
Details:
Deploy hostname.
author
Type:
Authortype AuthorName = string + +interface AuthorInfo { + /** + * Author name + */ + name: string + + /** + * Author website + */ + url?: string + + /** + * Author email + */ + email?: string +} + +type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[] +Required: No
Details:
Default author.
autoDescription
Type:
booleanDefault:
trueDetails:
Whether generate description automatically
canonical
Type:
string | ((page: Page) => string | null)Details:
Canonical link
fallBackImage
Type:
stringDetails:
Fallback Image link when no image are found
restrictions
Type:
stringDetails:
The age rating of the content, the format is
[int]+, such as"13+".
twitterID
Type:
stringDetails:
Fill in your twitter username.
isArticle
Type:
(page: Page) => booleanDetails:
Use this option to judge whether the page is an article.
ogp
Type:
function ogp( + /** OGP info inferred by plugin */ + ogp: SeoContent, + /** Page Object */ + page: Page, + /** VuePress App */ + app: App, +): SeoContent +Required: No
Details:
Custom OPG Generator.
You can use this options to edit OGP tags.
jsonLd
Type:
function jsonLd( + /** JSON-LD Object inferred by plugin */ + jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema, + /** Page Object */ + page: Page, + /** VuePress App */ + app: App, +): ArticleSchema | BlogPostingSchema | WebPageSchema +Required: No
Details:
Custom JSON-LD Generator.
You can use this options to edit JSON-LD properties.
customHead
Type:
function customHead( + /** Head tag config */ + head: HeadConfig[], + /** Page Object */ + page: Page, + /** VuePress App */ + app: App, +): void +Required: No
Details:
You can use this options to edit tags injected to
<head>.
Guide
This plugin will make your site fully support Open Content Protocol OGP and JSON-LD 1.1 to enhance the SEO of the site.
Out of Box
The plugin works out of the box. Without any config, it will extract information from the page content as much as possible to complete the necessary tags required by OGP and JSON-LD.
By default, the plugin will read the site config and page frontmatter to automatically generate tags as much as possible. Such as site name, page title, page type, writing date, last update date, and article tags are all automatically generated.
The following are the <meta> tags and their values that will be injected into <head> by default:
Default OGP Generation
The following are the <meta> tags and their value injected into <head> by default to satisfy OGP:
| Meta Name | Value |
|---|---|
og:url | options.hostname + path |
og:site_name | siteConfig.title |
og:title | page.title |
og:description | page.frontmatter.description || auto generated (when autoDescription is true in plugin options) |
og:type | "article" |
og:image | options.hostname + page.frontmatter.image ||first image in page || fallbackImage in plugin options |
og:updated_time | page.git.updatedTime |
og:locale | page.lang |
og:locale:alternate | Other languages in siteData.locales |
twitter:card | "summary_large_image" (only available when image found) |
twitter:image:alt | page.title (only available when image found) |
article:author | page.frontmatter.author || options.author |
article:tag | page.frontmatter.tags || page.frontmatter.tag |
article:published_time | page.frontmatter.date || page.git.createdTime |
article:modified_time | page.git.updatedTime |
Default JSON-LD Generation
| Property Name | Value |
|---|---|
@context | "https://schema.org" |
@type | "NewsArticle" |
headline | page.title |
image | image in page || options.hostname + page.frontmatter.image || siteFavIcon in plugin options |
datePublished | page.frontmatter.date || page.git.createdTime |
dateModified | page.git.updatedTime |
author | page.frontmatter.author || options.author |
Setting Tags Directly
You can configure the head option in the page's frontmatter to add specific tags to the page <head> to enhance SEO. For example:
---
+head:
+ - - meta
+ - name: keywords
+ content: SEO plugin
+---
+Will automatically inject <meta name="keywords" content="SEO plugin" />.
Customize Generation
The plugin also gives you full control over the build logic.
Page Type
For most pages, there are basically only two types: articles and website, so the plugin provides the isArticle option to allow you to provide logic for identifying articles.
The option accepts a function in the format (page: Page) => boolean, by default all non-home pages generated from Markdown files are treated as articles.
TIP
If a page does fit into the "unpopular" genre like books, music, etc., you can handle them by setting the three options below.
OGP
You can use the plugin options ogp to pass in a function to modify the default OGP object to your needs and return it.
function ogp(
+ /** OGP Object inferred by plugin */
+ ogp: SeoContent,
+ /** Page Object */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): SeoContent
+For detailed parameter structure, see Config.
For example, if you are using a third-party theme and set a banner in frontmatter for each article according to the theme requirements, then you can pass in the following ogp:
seoPlugin({
+ ogp: (ogp, page) => ({
+ ...ogp,
+ 'og:image': page.frontmatter.banner || ogp['og:image'],
+ }),
+})
+JSON-LD
Like OGP, you can use the plugin options jsonLd to pass in a function to modify the default JSON-LD object to your needs and return it.
function jsonLd(
+ /** JSON-LD Object inferred by plugin */
+ jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema,
+ /** Page Object */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): ArticleSchema | BlogPostingSchema | WebPageSchema
+Canonical Link
If you are deploying your content to different sites, or same content under different URLs, you may need to set canonical option to provide a "Canonical Link" for your page. You can either set a string which will be appended before page route link, or adding a custom function (page: Page) => string | null to return a canonical link if necessary.
Example
If your sites are deployed under docs directory in example.com, but available in:
http://example.com/docs/xxxhttps://example.com/docs/xxxhttp://www.example.com/docs/xxxhttps://www.example.com/docs/xxx(primary)
To let search engine results always be the primary choice, you may need to set canonical to https://www.example.com/docs/, so that search engine will know that the fourth URL is preferred to be indexed.
Customize head Tags
Sometimes you may need to fit other protocols or provide the corresponding SEO tags in the format provided by other search engines. In this case, you can use the customHead option, whose type is:
function customHead(
+ /** Head tag config */
+ head: HeadConfig[],
+ /** Page Object */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): void
+You should modify the head array in this function directly.
SEO Introduction
Search engine optimization (SEO) is the process of improving the quality and quantity of site traffic to a site or a web page from search engines. SEO targets unpaid traffic (known as "natural" or "organic" results) rather than direct traffic or paid traffic. Unpaid traffic may originate from different kinds of searches, including image search, video search, academic search, news search, and industry-specific vertical search engines.
As an internet marketing strategy, SEO considers how search engines work, the computer-programmed algorithms that dictate search engine behavior, what people search for, the actual search terms or keywords typed into search engines, and which search engines are preferred by their targeted audience. SEO is performed because a site will receive more visitors from a search engine when sites rank higher on the search engine results page (SERP). These visitors can then potentially be converted into customers.
Related Documents
Open Content Protocol OGP (Open Graph Protocol)
This plugin perfectly supports this protocol and will automatically generate
<meta>tags that conform to the protocol.This plugin will generate "NewsArticle" scheme for article pages.
RDFa mainly marks HTML structure. This is what the plugin cannot support. uses this feature to pass Google's rich media structure test. You can consider using it.
Schema definition site for structural markup
Related Tools
You can use Google Rich Media Structure Test Tool to test this site.
+
+
+
diff --git a/plugins/shiki.html b/plugins/shiki.html
new file mode 100644
index 0000000000..ff06661648
--- /dev/null
+++ b/plugins/shiki.html
@@ -0,0 +1,48 @@
+
+
+
+
+
+
+
+
+
shiki
This plugin will enable syntax highlighting for markdown code fence with Shiki.
TIP
Shiki is the syntax highlighter being used by VSCode. It has higher fidelity, but it could be slower than Prism.js, especially when you have a lot of code blocks.
You could consider disabling this plugin in dev mode to get better development experience.
Usage
npm i -D @vuepress/plugin-shiki@next
+import { shikiPlugin } from '@vuepress/plugin-shiki'
+
+export default {
+ plugins: [
+ shikiPlugin({
+ // options
+ langs: ['ts', 'json', 'vue', 'md', 'bash', 'diff'],
+ }),
+ ],
+}
+Options
langs
Type:
ShikiLang[]Details:
Languages of code blocks to be parsed by Shiki.
This option will be forwarded to
getHighlighter()method of Shiki.You'd better provide the languages list you are using explicitly, otherwise Shiki will load all languages and can affect performance.
Also see:
theme
Type:
ShikiThemeDefault:
'nord'Details:
Theme of Shiki.
This option will be forwarded to
codeToHtml()method of Shiki.Also see:
themes
Type:
Record<'dark' | 'light', ShikiTheme>Details:
Dark / Light Dual themes of Shiki.
This option will be forwarded to
codeToHtml()method of Shiki.Also see:
Config
hostname
Type:
stringRequired: Yes
Details:
The domain name where the current site is deployed, the plugin needs this option to work.
extraUrls
Type:
string[]Details:
Extra link to be included.
If you have some links not including in VuePress Router (normally in public directory or generated by other tools directly), you may need this option.
Example:
['/about.html', '/api/']
excludePaths
Type:
string[]Default:
['/404.html']Details:
Urls excluding from sitemap, starting with absolute path.
By default, all the urls generated by VuePress (excluding 404 page) will be added into sitemap.
devServer
Type:
booleanDefault:
falseDetails:
Whether enabled in devServer.
TIP
For performance reasons, we do not provide hot reload. Reboot your devServer to sync your changes.
devHostname
Type:
stringDefault:
"http://localhost:${port}"Details:
Hostname to use in devServer
sitemapFilename
Type:
stringDefault value:
"sitemap.xml"Details:
The output filename, relative to output directory.
sitemapXSLFilename
Type:
stringDefault value:
"sitemap.xsl"Details:
Output xsl filename, relative to dest folder.
sitemapXSLTemplate
Type:
stringDefault value:
"@vuepress/plugin-sitemap/templates/sitemap.xsl"Details:
XSL content used as template.
changefreq
Type:
"always" | "hourly" | "daily" | "weekly" |"monthly" | "yearly" | "never"Default value:
"daily"Details:
Page default update frequency, will be overridden by sitemap.changefreq in Frontmatter.
priority
Type:
numberDefault:
0.5Details:
Page priority, from
0to1.
modifyTimeGetter
Type:
(page: Page, app: App) => stringDetails:
Last modify time getter. By default, the plugin will use the timestamp generated by git plugin.
Frontmatter
sitemap
Type:
SitemapFrontmatterOptions | falseDetails:
falsemeans exclude the page from sitemap.
sitemap.changefreq
Type:
"always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"Default:
"daily"Details:
Page default update frequency. This will override changefreq in Plugin Options.
sitemap.priority
Type:
numberDefault:
0.5Details:
Page priority, range from
0to1.
Guide
This plugin will automatically generate a Sitemap for your site. To let this plugin work, you need to pass the deployed domain name to the hostname option of the plugin. If you want to preview in devServer, set devServer options.
The plugin will automatically generate the last update time of the page based on the Git timestamp of the page, and will also declare the alternative links of the page in other languages according to the locales' config.
Control Sitemap Link
By default, all site links except 404 page will be added to the Sitemap.
To add other pages to the Sitemap outside the VuePress project page, please turn them into an array and pass to the extraUrls plugin option.
If you don't want certain pages to appear in the sitemap, you can turn their paths into an array and pass to the excludePaths plugin option, or set sitemap to false in the frontmatter of the corresponding page.
Output Location
You can also control the output link through the sitemapFilename option of the plugin, the link is relative to output directory. By default, the plugin will use sitemap.xml.
Change Frequency
The default update cycle of the page is daily (every day). To modify the entire page cycle, please set changefreq in the plugin options. You can also set sitemap.changefreq in the frontmatter of the page. Note that page has a higher priority.
The legal frequencies are:
"always""hourly""daily""weekly""monthly""yearly""never"
Priority
You can set priority in the plugin to provide a default value. At the same time you can set the priority for each page through sitemap.priority in frontmatter. Acceptable values are floating point numbers from 0 to 1.
Modify Time
You can use option modifyTimeGetter to return a time in ISO string format, which is generated by the Git plugin by default.
The following is an example based on the last modification time of a file.
// Based on file last modified time
+({
+ modifyTimeGetter: (page, app) =>
+ fs.statSync(app.dir.source(page.filePathRelative)).mtime.toISOString();
+})
+Sitemap Intro
Sitemaps provide SEO (Search Engine Optimization):
- Provide search engine spiders with links of the entire site;
- Provide some links for search engine spiders to dynamic pages or pages that are difficult to reach by other methods;
- If a visitor attempts to access a URL that does not exist within the site's domain, the visitor will be directed to a "file not found" error page, and the sitemap can be used as a navigation page.
A sitemap enhances SEO by making all pages findable.
Most search engines only follow a limited number of links within a page, so when the site is very large, a sitemap becomes essential to make everything on the site accessible to search engines and visitors.
Sitemaps is a protocol for site administrators to publish pages that can be crawled on a site to search engine spiders. The content of sitemap files must follow the definition in XML format. Each URL can contain the update period and last update time, the priority of the URL across the site. This allows search engines to crawl site content better and more efficiently.
Together with robots.txt
Sitemap is basically used by search engines, when using this plugin, you'd better ensure that you have a valid robots.txt in the .vuepress/public directory to allow search engines spiders to visit your site. The simplest robots.txt is as follows (allow all search engines to access all paths)
User-agent: *
+
+Allow: /
+
+
+
+
diff --git a/plugins/theme-data.html b/plugins/theme-data.html
new file mode 100644
index 0000000000..0af0c994af
--- /dev/null
+++ b/plugins/theme-data.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+
+
theme-data
Provide client data for your theme, with VuePress i18n support.
This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
For theme authors, this plugin will help you to use the same i18n mechanism as VuePress and the default theme. But if you don't want to provide i18n support, or you want to implement in your own way, you don't need this plugin.
Usage
npm i -D @vuepress/plugin-theme-data@next
+import { themeDataPlugin } from '@vuepress/plugin-theme-data'
+
+export default {
+ plugins: [
+ themeDataPlugin({
+ // options
+ }),
+ ],
+}
+Options
themeData
Type:
ThemeDataDefault:
{}Details:
The theme data object that you want to use in client side.
You can provide theme data in Node side via this option, and use it in client side via useThemeData and useThemeLocaleData.
Example:
export default {
+ plugins: [
+ themeDataPlugin({
+ themeData: {
+ foo: 'foo',
+ locales: {
+ '/zh/': {
+ foo: 'zh-foo',
+ },
+ },
+ },
+ }),
+ ],
+}
+WARNING
The theme data object will be processed by JSON.stringify() before forwarding to client side, so you should ensure that you are providing a JSON-friendly object.
Composition API
useThemeData
Details:
Returns the theme data ref object.
The value is provided by themeData option.
Example:
import { useThemeData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeData = useThemeData<MyThemeData>()
+ console.log(themeData.value)
+ },
+}
+useThemeLocaleData
Details:
Returns the theme data ref object in current locale.
The properties of current locale has been merged into the root-level properties.
Example:
import { useThemeLocaleData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeLocaleData = useThemeLocaleData<MyThemeData>()
+ console.log(themeLocaleData.value)
+ },
+}
+toc
This plugin will provide a table-of-contents (TOC) component.
Usage
npm i -D @vuepress/plugin-toc@next
+import { tocPlugin } from '@vuepress/plugin-toc'
+
+export default {
+ plugins: [
+ tocPlugin({
+ // options
+ }),
+ ],
+}
+Differences with Markdown TOC Syntax
Similar to the Table of Contents Markdown Syntax, the TOC component that provided by this plugin could be used in your markdown content directly:
<!-- markdown toc syntax -->
+
+[[toc]]
+
+<!-- vue toc component -->
+<Toc />
+Both of them can be pre-rendered correctly in build mode. However, there are some differences between them.
The markdown syntax [[toc]] could only be used in markdown files. It is parsed by markdown-it, and the generated TOC is static content.
The component <Toc/> could be used in both markdown files and vue files. It is loaded by vue, and the generated TOC is a vue component.
This plugin could work together with @vuepress/plugin-active-header-links by setting the headerLinkSelector to match the linkClass option. When the page scroll to a certain header anchor, this corresponding link will be added linkActiveClass class name.
Therefore, this plugin is more useful for theme developers.
Options
componentName
Type:
stringDefault:
'Toc'Details:
Specify the name of the TOC component.
defaultPropsOptions
Type:
Partial<TocPropsOptions>Default:
{}Details:
Override the default values of the component options prop.
Component Props
The TOC component also accepts props for customization.
<template>
+ <Toc :headers="headers" :options="options" />
+</template>
+headers
- Type:
PageHeader[]
interface PageHeader {
+ level: number
+ title: string
+ slug: string
+ children: PageHeader[]
+}
+Details:
Specify the headers array to render.
If this prop is not specified, the headers of current page will be used.
options
- Type:
Partial<TocPropsOptions>
interface TocPropsOptions {
+ containerTag: string
+ containerClass: string
+ listClass: string
+ itemClass: string
+ linkTag: 'a' | 'RouterLink' | 'RouteLink'
+ linkClass: string
+ linkActiveClass: string
+ linkChildrenActiveClass: string
+}
+Default:
Following default values can be overridden by defaultPropsOptions.
const defaultOptions = {
+ containerTag: 'nav',
+ containerClass: 'vuepress-toc',
+ listClass: 'vuepress-toc-list',
+ itemClass: 'vuepress-toc-item',
+ linkTag: 'RouteLink',
+ linkClass: 'vuepress-toc-link',
+ linkActiveClass: 'active',
+ linkChildrenActiveClass: 'active',
+}
+Details:
Customize the TOC component.
If the
containerTagis set to an empty string'', the<nav>container will be removed totally.Example:
The rendered TOC component with default options looks like:
<template>
+ <!-- container -->
+ <nav class="vuepress-toc">
+ <!-- list -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link -->
+ <RouteLink class="vuepress-toc-link" to="#foo">Foo</RouteLink>
+ </li>
+ <!-- item with children -->
+ <li class="vuepress-toc-item">
+ <!-- link (children active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar">Bar</RouteLink>
+ <!-- list (children) -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link (active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar-child">
+ Bar Child
+ </RouteLink>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </nav>
+</template>
+Built-in Components
Badge badge
Props:
- type
- Type:
'tip' | 'warning' | 'danger' - Default:
'tip'
- Type:
- text
- Type:
string - Default:
''
- Type:
- vertical
- Type:
'top' | 'middle' | 'bottom' | undefined - Default:
undefined
- Type:
- type
Example:
Input
- VuePress - <Badge type="tip" text="v2" vertical="top" />
+- VuePress - <Badge type="warning" text="v2" vertical="middle" />
+- VuePress - <Badge type="danger" text="v2" vertical="bottom" />
+Output
- VuePress - v2
- VuePress - v2
- VuePress - v2
CodeGroup
Details:
Wrapper of the CodeGroupItem components.
CodeGroupItem
Props:
- title
- Type:
string - Required:
true
- Type:
- active
- Type:
boolean - Default:
false
- Type:
- title
Details:
This component must be placed inside a CodeGroup component.
Use the
activeprop to set the initial active item, or the first item will be activated by default.Example:
Input
<CodeGroup>
+ <CodeGroupItem title="pnpm">
+
+```bash:no-line-numbers
+pnpm install
+```
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="yarn">
+
+```bash:no-line-numbers
+yarn install
+```
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="npm" active>
+
+```bash:no-line-numbers
+npm install
+```
+
+ </CodeGroupItem>
+</CodeGroup>
+Output
pnpm install
+yarn install
+npm install
+WARNING
You must add an empty line between the starting tag of <CodeGroupItem> and the code fence, otherwise the code fence will not be parsed correctly by Markdown.
All content must be valid Markdown first, and then a Vue SFC.
Learn more: Cookbook > Markdown and Vue SFC
Alternatively, you can use the custom containers.
Config
Basic Config
hostname
Type:
stringDetails:
Hostname to be deployed, e.g.:
https://example.com
locales
Type:
{ [path: string]: Partial<DefaultThemeLocaleData> }Default:
{}Details:
Specify locales for i18n support.
All the options inside the Locale Config section can be used in locales.
This option will only take effect in default theme, so don't confuse with
localesin Site Config.Also see:
Locale Config
Config of this section can be used as normal config, and can also be used in the locales option.
colorMode
Type:
'auto' | 'light' | 'dark'Default:
'auto'Details:
Default color mode.
If set to
'auto', the initial color mode will be automatically set according to prefers-color-scheme.Also see:
colorModeSwitch
Type:
booleanDefault:
trueDetails:
Enable color mode switching or not.
If set to
true, a button to switch color mode will be displayed in the navbar.Also see:
home
Type:
stringDefault:
/Details:
Specify the path of the homepage.
This will be used for:
- the logo link of the navbar
- the back to home link of the 404 page
navbar
Type:
false | (NavbarItem | NavbarGroup | string)[]Default:
[]Details:
Configuration of navbar.
Set to
falseto disable navbar.To configure the navbar items, you can set it to a navbar array, each item of which could be a
NavbarItemobject, aNavbarGroupobject, or a string:- A
NavbarItemobject should have atextfield and alinkfield, could have an optionalactiveMatchfield. - A
NavbarGroupobject should have atextfield and achildrenfield. Thechildrenfield should be a navbar array, too. - A string should be the path to the target page file. It will be converted to a
NavbarItemobject, using the page title astext, and the page route path aslink.
- A
Example 1:
export default {
+ theme: defaultTheme({
+ navbar: [
+ // NavbarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ },
+ // NavbarGroup
+ {
+ text: 'Group',
+ children: ['/group/foo.md', '/group/bar.md'],
+ },
+ // string - page file path
+ '/bar/README.md',
+ ],
+ }),
+}
+- Example 2:
export default {
+ theme: defaultTheme({
+ navbar: [
+ // nested group - max depth is 2
+ {
+ text: 'Group',
+ children: [
+ {
+ text: 'SubGroup',
+ children: ['/group/sub/foo.md', '/group/sub/bar.md'],
+ },
+ ],
+ },
+ // control when should the item be active
+ {
+ text: 'Group 2',
+ children: [
+ {
+ text: 'Always active',
+ link: '/',
+ // this item will always be active
+ activeMatch: '/',
+ },
+ {
+ text: 'Active on /foo/',
+ link: '/not-foo/',
+ // this item will be active when current route path starts with /foo/
+ // regular expression is supported
+ activeMatch: '^/foo/',
+ },
+ ],
+ },
+ ],
+ }),
+}
+logo
Type:
null | stringDetails:
Specify the url of logo image.
The logo image will be displayed at the left end of the navbar.
Set to
nullto disable logo.Example:
export default {
+ theme: defaultTheme({
+ // public file path
+ logo: '/hero.png',
+ // url
+ logo: 'https://vuejs.org/images/logo.png',
+ }),
+}
+- Also see:
logoDark
Type:
null | stringDetails:
Specify the url of logo image to be used in dark mode.
You can make use of this option if you want to use different logo config in dark mode.
Set to
nullto disable logo in dark mode. Omit this option to use logo in dark mode.Also see:
logoAlt
Type:
null | stringDetails:
Specify the alt text of the logo image.
If not specified, defaults to be the same as the site title.
repo
Type:
stringDetails:
Specify the repository url of your project.
This will be used as the link of the repository link, which will be displayed as the last item of the navbar.
export default {
+ theme: defaultTheme({
+ // If you set it in the form of `organization/repository`
+ // we will take it as a GitHub repo
+ repo: 'vuejs/vuepress',
+ // You can also set it to a URL directly
+ repo: 'https://gitlab.com/foo/bar',
+ }),
+}
+sidebar
Type:
false | 'auto' | SidebarConfigArray | SidebarConfigObjectDefault:
'auto'Details:
Configuration of sidebar.
You can override this global option via sidebar frontmatter in your pages.
Set to
falseto disable sidebar.If you set it to
'auto', the sidebar will be automatically generated from the page headers.To configure the sidebar items manually, you can set this option to a sidebar array, each item of which could be a
SidebarItemobject or a string:- A
SidebarItemobject should have atextfield, could have an optionallinkfield, an optionalchildrenfield and an optionalcollapsiblefield. Thechildrenfield should be a sidebar array. Thecollapsiblefield controls whether the item is collapsible. - A string should be the path to the target page file. It will be converted to a
SidebarItemobject, whosetextis the page title,linkis the page route path, andchildrenis automatically generated from the page headers.
If you want to set different sidebar for different sub paths, you can set this option to a sidebar object:
- The key should be the path prefix.
- The value should be a sidebar array or set to
'heading'to automatically generate the sidebar from the page headers for just the corresponding path.
- A
Example 1:
export default {
+ theme: defaultTheme({
+ // sidebar array
+ // all pages will use the same sidebar
+ sidebar: [
+ // SidebarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ children: [
+ // SidebarItem
+ {
+ text: 'github',
+ link: 'https://github.com',
+ children: [],
+ },
+ // string - page file path
+ '/foo/bar.md',
+ ],
+ },
+ // string - page file path
+ '/bar/README.md',
+ ],
+ }),
+}
+- Example 2:
export default {
+ theme: defaultTheme({
+ // sidebar object
+ // pages under different sub paths will use different sidebar
+ sidebar: {
+ '/guide/': [
+ {
+ text: 'Guide',
+ children: ['/guide/introduction.md', '/guide/getting-started.md'],
+ },
+ ],
+ '/reference/': 'heading',
+ },
+ }),
+}
+- Example 3:
export default {
+ theme: defaultTheme({
+ // collapsible sidebar
+ sidebar: {
+ '/reference/': [
+ {
+ text: 'VuePress Reference',
+ collapsible: true,
+ children: ['/reference/cli.md', '/reference/config.md'],
+ },
+ {
+ text: 'Bundlers Reference',
+ collapsible: true,
+ children: [
+ '/reference/bundler/vite.md',
+ '/reference/bundler/webpack.md',
+ ],
+ },
+ ],
+ },
+ }),
+}
+sidebarDepth
Type:
numberDefault:
2Details:
Set the maximum depth of the sidebar children which are automatically generated from the page headers.
- Set to
0to disable all levels of headers. - Set to
1to include<h2>headers. - Set to
2to include<h2>and<h3>headers. - ...
The max value depends on which levels of headers you have extracted via markdown.headers.level.
The default value of
markdown.headers.levelis[2, 3], so the default max value ofsidebarDepthis2.You can override this global option via sidebarDepth frontmatter in your pages.
- Set to
editLink
Type:
booleanDefault:
trueDetails:
Enable the edit this page link or not.
You can override this global option via editLink frontmatter in your pages.
editLinkPattern
Type:
stringDetails:
Specify the pattern of the edit this page link.
This will be used for generating the edit this page link.
If you don't set this option, the pattern will be inferred from the docsRepo option. But if your documentation repository is not hosted on a common platform, for example, GitHub, GitLab, Bitbucket, Gitee, etc., you have to set this option explicitly to make the edit this page link work.
Usage:
Pattern Description :repoThe docs repo url, i.e. docsRepo :branchThe docs repo branch, i.e. docsBranch :pathThe path of the page source file, i.e. docsDir joins the relative path of the page file Example:
export default {
+ theme: defaultTheme({
+ docsRepo: 'https://gitlab.com/owner/name',
+ docsBranch: 'master',
+ docsDir: 'docs',
+ editLinkPattern: ':repo/-/edit/:branch/:path',
+ }),
+}
+The generated link will look like 'https://gitlab.com/owner/name/-/edit/master/docs/path/to/file.md'.
docsRepo
Type:
stringDetails:
Specify the repository url of your documentation source files.
This will be used for generating the edit this page link.
If you don't set this option, it will use the repo option by default. But if your documentation source files are in a different repository, you will need to set this option.
docsBranch
Type:
stringDefault:
'main'Details:
Specify the repository branch of your documentation source files.
This will be used for generating the edit this page link.
docsDir
Type:
stringDefault:
''Details:
Specify the directory of your documentation source files in the repository.
This will be used for generating the edit this page link.
lastUpdated
Type:
booleanDefault:
trueDetails:
Enable the last updated timestamp or not.
You can override this global option via lastUpdated frontmatter in your pages. Notice that if you have already set this option to
false, this feature will be disabled totally and could not be enabled in locales nor page frontmatter.
contributors
Type:
booleanDefault:
trueDetails:
Enable the contributors list or not.
You can override this global option via contributors frontmatter in your pages. Notice that if you have already set this option to
false, this feature will be disabled totally and could not be enabled in locales nor page frontmatter.
Extending
VuePress default theme is widely used by users, so it is designed to be extendable, allowing users to make their own customization with ease.
Layout Slots
Default theme's Layout provides some slots:
navbarnavbar-beforenavbar-aftersidebarsidebar-topsidebar-bottompagepage-toppage-bottompage-content-toppage-content-bottom
With the help of them, you can add or replace content easily. Here comes an example to introduce how to extend default theme with layout slots.
Firstly, create a client config file .vuepress/client.ts:
import { defineClientConfig } from 'vuepress/client'
+import Layout from './layouts/Layout.vue'
+
+export default defineClientConfig({
+ layouts: {
+ Layout,
+ },
+})
+Next, create the .vuepress/layouts/Layout.vue, and make use of the slots that provided by the Layout of default theme:
<script setup>
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+</script>
+
+<template>
+ <ParentLayout>
+ <template #page-bottom>
+ <div class="my-footer">This is my custom page footer</div>
+ </template>
+ </ParentLayout>
+</template>
+
+<style lang="css">
+.my-footer {
+ text-align: center;
+}
+</style>
+Then the default Layout layout has been overridden by your own local layout, which will add a custom footer to every normal pages in default theme (excluding homepage):
Components Replacement
The layout slots are useful, but sometimes you might find it's not flexible enough. Default theme also provides the ability to replace a single component.
Default theme has registered alias for every non-global components with a @theme prefix. For example, the alias of HomeFooter.vue is @theme/HomeFooter.vue.
Then, if you want to replace the HomeFooter.vue component, just override the alias in your config file .vuepress/config.ts:
import { defaultTheme } from '@vuepress/theme-default'
+import { getDirname, path } from 'vuepress/utils'
+import { defineUserConfig } from 'vuepress'
+
+const __dirname = getDirname(import.meta.url)
+
+export default defineUserConfig({
+ theme: defaultTheme(),
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+})
+Developing a Child Theme
Instead of extending the default theme directly in .vuepress/config.ts and .vuepress/client.ts, you can also develop your own theme extending the default theme:
import { defaultTheme, type DefaultThemeOptions } from '@vuepress/theme-default'
+import type { Theme } from 'vuepress/core'
+import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export const childTheme = (options: DefaultThemeOptions): Theme => {
+ return {
+ name: 'vuepress-theme-child',
+ extends: defaultTheme(options),
+
+ // override layouts in child theme's client config file
+ // notice that you would build ts to js before publishing to npm,
+ // so this should be the path to the js file
+ clientConfigFile: path.resolve(__dirname, './client.js'),
+
+ // override component alias
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+ }
+}
+Frontmatter
All Pages
Frontmatter in this section will take effect in all types of pages.
externalLinkIcon
Type:
booleanDetails:
Provided by @vuepress/plugin-external-link-icon.
Also see:
navbar
Type:
booleanDetails:
Show navbar on this page or not.
If you disable navbar in theme config, this frontmatter will not take effect.
Also see:
pageClass
Type:
stringDetails:
Add extra class name to this page.
Example:
---
+pageClass: custom-page-class
+---
+Then you can customize styles of this page in .vuepress/styles/index.scss file:
.theme-container.custom-page-class {
+ /* page styles */
+}
+- Also see:
Home Page
Frontmatter in this section will only take effect in home pages.
home
Type:
booleanDetails:
Specify whether the page is homepage or a normal page.
If you don't set this frontmatter or set it to
false, the page would be a normal page.Example:
---
+home: true
+---
+heroImage
Type:
stringDetails:
Specify the url of the hero image.
Example:
---
+# public file path
+heroImage: /images/hero.png
+# url
+heroImage: https://vuejs.org/images/logo.png
+---
+- Also see:
heroImageDark
Type:
stringDetails:
Specify the url of hero image to be used in dark mode.
You can make use of this option if you want to use different heroImage config in dark mode.
Also see:
heroAlt
Type:
stringDetails:
Specify the
altattribute of the hero image.This will fallback to the heroText.
heroHeight
Type:
numberDefault:
280Details:
Specify the
heightattribute of the hero<img>tag.You may need to reduce this value if the height of your hero image is less than the default value.
Notice that the height is also constrained by CSS. This attribute is to reduce Cumulative Layout Shift (CLS) that caused by the loading of the hero image.
heroText
Type:
string | nullDetails:
Specify the the hero text.
This will fallback to the site title.
Set to
nullto disable hero text.
tagline
Type:
string | nullDetails:
Specify the the tagline.
This will fallback to the site description.
Set to
nullto disable tagline.
actions
- Type:
Array<{
+ text: string
+ link: string
+ type?: 'primary' | 'secondary'
+}>
+Details:
Configuration of the action buttons.
Example:
---
+actions:
+ - text: Get Started
+ link: /guide/getting-started.html
+ type: primary
+ - text: Introduction
+ link: /guide/introduction.html
+ type: secondary
+---
+features
- Type:
Array<{
+ title: string
+ details: string
+}>
+Details:
Configuration of the features list.
Example:
---
+features:
+ - title: Simplicity First
+ details: Minimal setup with markdown-centered project structure helps you focus on writing.
+ - title: Vue-Powered
+ details: Enjoy the dev experience of Vue, use Vue components in markdown, and develop custom themes with Vue.
+ - title: Performant
+ details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
+---
+footer
Type:
stringDetails:
Specify the content of the footer.
footerHtml
Type:
booleanDetails:
Allow HTML in footer or not.
If you set it to
true, the footer will be treated as HTML code.
Normal Page
Frontmatter in this section will only take effect in normal pages.
editLink
Type:
booleanDetails:
Enable the edit this page link in this page or not.
Also see:
editLinkPattern
Type:
stringDetails:
Specify the pattern of the edit this page link of this page.
Also see:
lastUpdated
Type:
booleanDetails:
Enable the last updated timestamp in this page or not.
Also see:
contributors
Type:
booleanDetails:
Enable the contributors list in this page or not.
Also see:
sidebar
Type:
false | 'auto' | SidebarConfigArray | SidebarConfigObjectDetails:
Configure the sidebar of this page.
Also see:
sidebarDepth
Type:
numberDetails:
Configure the sidebar depth of this page.
Also see:
prev
Type:
NavLink | stringDetails:
Specify the link of the previous page.
If you don't set this frontmatter, the link will be inferred from the sidebar config.
To configure the prev link manually, you can set this frontmatter to a
NavLinkobject or a string:- A
NavLinkobject should have atextfield and alinkfield. - A string should be the path to the target page file. It will be converted to a
NavLinkobject, whosetextis the page title, andlinkis the page route path.
- A
Example:
---
+# NavLink
+prev:
+ text: Get Started
+ link: /guide/getting-started.html
+
+# NavLink - external url
+prev:
+ text: GitHub
+ link: https://github.com
+
+# string - page file path
+prev: /guide/getting-started.md
+
+# string - page file relative path
+prev: ../../guide/getting-started.md
+---
+next
Type:
NavLink | stringDetails:
Specify the link of the next page.
If you don't set this frontmatter, the link will be inferred from the sidebar config.
The type is the same as prev frontmatter.
theme-default
Usage
Install @vuepress/theme-default :
npm install @vuepress/theme-default@next
+import { defaultTheme } from '@vuepress/theme-default'
+
+export default {
+ theme: defaultTheme({
+ // set theme config here
+ }),
+}
+Locale Config
These options configure locale-related texts.
If your site is served in a different language besides English, you should set these options per locale to provide translations.
repoLabel
Type:
stringDetails:
Specify the repository label of your project.
This will be used as the text of the repository link, which will be displayed as the last item of the navbar.
If you don't set this option explicitly, it will be automatically inferred from the repo option.
selectLanguageText
Type:
stringDetails:
Specify the text of the select language menu.
The select language menu will appear next to the repository button in the navbar when you set multiple locales in your site config.
selectLanguageAriaLabel
Type:
stringDetails:
Specify the
aria-labelattribute of the select language menu.This is mainly for a11y purpose.
selectLanguageName
Type:
stringDetails:
Specify the name of the language of a locale.
This option will only take effect inside the locales of your theme config. It will be used as the language name of the locale, which will be displayed in the select language menu.
Example:
export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+ theme: defaultTheme({
+ locales: {
+ '/': {
+ selectLanguageName: 'English',
+ },
+ '/zh/': {
+ selectLanguageName: '简体中文',
+ },
+ },
+ }),
+}
+navbarLabel
Type:
null | stringDetails:
aria-labelvalue for main navigation in navbar.
pageNavbarLabel
Type:
null | stringDetails:
aria-labelvalue for next/previous page navigation.
editLinkText
Type:
stringDefault:
'Edit this page'Details:
Specify the text of the edit this page link.
lastUpdatedText
Type:
stringDefault:
'Last Updated'Details:
Specify the text of the last updated timestamp label.
contributorsText
Type:
stringDefault:
'Contributors'Details:
Specify the text of the contributors list label.
tip
Type:
stringDefault:
'TIP'Details:
Specify the default title of the tip custom containers.
warning
Type:
stringDefault:
'WARNING'Details:
Specify the default title of the warning custom containers.
danger
Type:
stringDefault:
'DANGER'Details:
Specify the default title of the danger custom containers.
notFound
Type:
string[]Default:
['Not Found']Details:
Specify the messages of the 404 page.
The message will be randomly picked from the array when users enter the 404 page.
backToHome
Type:
stringDefault:
'Back to home'Details:
Specify the text of the back to home link in the 404 page.
openInNewWindow
Type:
stringDefault:
'open in new window'Details:
Specify the
sr-onlytext of the ExternalLinkIcon.This is mainly for a11y purpose.
Also see:
toggleColorMode
Type:
stringDefault:
'toggle color mode'Details:
Title text for the color mode toggle button.
This is mainly for a11y purpose.
Also see:
toggleSidebar
Type:
stringDefault:
'toggle sidebar'Details:
Title text for sidebar toggle button.
This is mainly for a11y purpose.
Markdown
Custom Containers
Usage:
::: <type> [title] +[content] +::: +The
typeis required, and thetitleandcontentare optional.Supported
type:tipwarningdangerdetails- Alias of CodeGroup and CodeGroupItem:
code-groupcode-group-item
Example 1 (default title):
Input
::: tip
+This is a tip
+:::
+
+::: warning
+This is a warning
+:::
+
+::: danger
+This is a dangerous warning
+:::
+
+::: details
+This is a details block
+:::
+Output
TIP
This is a tip
WARNING
This is a warning
DANGER
This is a dangerous warning
This is a details block
- Example 2 (custom title):
Input
::: danger STOP
+Danger zone, do not proceed
+:::
+
+::: details Click me to view the code
+
+```ts
+console.log('Hello, VuePress!')
+```
+
+:::
+Output
STOP
Danger zone, do not proceed
Click me to view the code
console.log('Hello, VuePress!')
+- Example 3 (code group alias):
Input
:::: code-group
+::: code-group-item FOO
+
+```ts
+const foo = 'foo'
+```
+
+:::
+
+::: code-group-item BAR
+
+```ts
+const bar = 'bar'
+```
+
+:::
+::::
+Output
const foo = 'foo'
+const bar = 'bar'
+Plugins Config
You can configure the plugins that used by default theme with themePlugins.
Default theme is using some plugins by default. You can disable a plugin if you really do not want to use it. Make sure you understand what the plugin is for before disabling it.
import { defaultTheme } from '@vuepress/theme-default'
+
+export default {
+ theme: defaultTheme({
+ themePlugins: {
+ // customize theme plugins here
+ },
+ }),
+}
+themePlugins.activeHeaderLinks
Type:
booleanDefault:
trueDetails:
Enable @vuepress/plugin-active-header-links or not.
themePlugins.backToTop
Type:
BackToTopPluginOptions | booleanDefault:
trueDetails:
Enable @vuepress/plugin-back-to-top or not.
Object value is supported as plugin options.
themePlugins.container
Type:
Record<ContainerType, boolean>Details:
Enable custom containers that powered by @vuepress/plugin-container or not.
ContainerTypetype is:tipwarningdangerdetailscodeGroupcodeGroupItem
Also see:
themePlugins.externalLinkIcon
Type:
booleanDefault:
trueDetails:
Enable @vuepress/plugin-external-link-icon or not.
themePlugins.copyCode
Type:
CopyCodePluginOptions | booleanDefault:
trueDetails:
Enable @vuepress/plugin-copy-code or not.
Object value is supported as plugin options.
themePlugins.git
Type:
booleanDefault:
trueDetails:
Enable @vuepress/plugin-git or not.
themePlugins.mediumZoom
Type:
booleanDefault:
trueDetails:
Enable @vuepress/plugin-medium-zoom or not.
themePlugins.nprogress
Type:
booleanDefault:
trueDetails:
Enable @vuepress/plugin-nprogress or not.
themePlugins.seo
Type:
SeoPluginOptions | booleanDefault:
trueDetails:
Enable @vuepress/plugin-seo or not.
Object value is supported as plugin options.
themePlugins.sitemap
Type:
SitemapPluginOptions | booleanDefault:
trueDetails:
Enable @vuepress/plugin-sitemap or not.
Object value is supported as plugin options.
Styles
The default theme uses SASS as the CSS pre-processor.
Users can customize style variables via a palette file, and add extra styles via a style file.
Palette File
The path of the palette file is .vuepress/styles/palette.scss.
You can make use of it to override predefined SASS variables of the default theme.
Click to expand SASS variables
// responsive breakpoints
+$MQNarrow: 959px !default;
+$MQMobile: 719px !default;
+$MQMobileNarrow: 419px !default;
+Style File
The path of the style file is .vuepress/styles/index.scss.
You can add extra styles here, or override the default styles:
:root {
+ scroll-behavior: smooth;
+}
+You can also make use of it to override predefined CSS variables of the default theme.
Click to expand CSS variables
:root {
+ // brand colors
+ --c-brand: #3eaf7c;
+ --c-brand-light: #4abf8a;
+
+ // background colors
+ --c-bg: #ffffff;
+ --c-bg-light: #f3f4f5;
+ --c-bg-lighter: #eeeeee;
+ --c-bg-dark: #ebebec;
+ --c-bg-darker: #e6e6e6;
+ --c-bg-navbar: var(--c-bg);
+ --c-bg-sidebar: var(--c-bg);
+ --c-bg-arrow: #cccccc;
+
+ // text colors
+ --c-text: #2c3e50;
+ --c-text-accent: var(--c-brand);
+ --c-text-light: #3a5169;
+ --c-text-lighter: #4e6e8e;
+ --c-text-lightest: #6a8bad;
+ --c-text-quote: #999999;
+
+ // border colors
+ --c-border: #eaecef;
+ --c-border-dark: #dfe2e5;
+
+ // custom container colors
+ --c-tip: #42b983;
+ --c-tip-bg: var(--c-bg-light);
+ --c-tip-title: var(--c-text);
+ --c-tip-text: var(--c-text);
+ --c-tip-text-accent: var(--c-text-accent);
+ --c-warning: #ffc310;
+ --c-warning-bg: #fffae3;
+ --c-warning-bg-light: #fff3ba;
+ --c-warning-bg-lighter: #fff0b0;
+ --c-warning-border-dark: #f7dc91;
+ --c-warning-details-bg: #fff5ca;
+ --c-warning-title: #f1b300;
+ --c-warning-text: #746000;
+ --c-warning-text-accent: #edb100;
+ --c-warning-text-light: #c1971c;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #f11e37;
+ --c-danger-bg: #ffe0e0;
+ --c-danger-bg-light: #ffcfde;
+ --c-danger-bg-lighter: #ffc9c9;
+ --c-danger-border-dark: #f1abab;
+ --c-danger-details-bg: #ffd4d4;
+ --c-danger-title: #ed1e2c;
+ --c-danger-text: #660000;
+ --c-danger-text-accent: #bd1a1a;
+ --c-danger-text-light: #b5474d;
+ --c-danger-text-quote: #c15b5b;
+ --c-details-bg: #eeeeee;
+
+ // badge component colors
+ --c-badge-tip: var(--c-tip);
+ --c-badge-warning: #ecc808;
+ --c-badge-warning-text: var(--c-bg);
+ --c-badge-danger: #dc2626;
+ --c-badge-danger-text: var(--c-bg);
+
+ // code group colors
+ --c-code-group-tab-title: rgba(255, 255, 255, 0.9);
+ --c-code-group-tab-bg: var(--code-bg-color);
+ --c-code-group-tab-outline: var(var(--c-code-group-tab-title));
+ --c-code-group-tab-active-border: var(--c-brand);
+
+ // transition vars
+ --t-color: 0.3s ease;
+ --t-transform: 0.3s ease;
+
+ // code blocks vars
+ --code-bg-color: #282c34;
+ --code-hl-bg-color: rgba(0, 0, 0, 0.66);
+ --code-ln-color: #9e9e9e;
+ --code-ln-wrapper-width: 3.5rem;
+
+ // font vars
+ --font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
+ Ubuntu, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
+ --font-family-code: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
+
+ // layout vars
+ --navbar-height: 3.6rem;
+ --navbar-padding-v: 0.7rem;
+ --navbar-padding-h: 1.5rem;
+ --sidebar-width: 20rem;
+ --sidebar-width-mobile: calc(var(--sidebar-width) * 0.82);
+ --content-width: 740px;
+ --homepage-width: 960px;
+}
+
+// plugin-back-to-top
+.vp-back-to-top-button {
+ --back-to-top-color: var(--c-brand);
+ --back-to-top-color-hover: var(--c-brand-light);
+ --back-to-top-bg-color: var(--c-bg);
+}
+
+// plugin-catalog
+.vp-catalog-wrapper {
+ --catalog-bg-color: var(--c-bg);
+ --catalog-bg-secondary-color: var(--c-bg-dark);
+ --catalog-border-color: var(--c-border);
+ --catalog-active-color: var(--c-brand);
+ --catalog-hover-color: var(--c-brand-light);
+}
+
+// plugin-docsearch
+.DocSearch {
+ --docsearch-primary-color: var(--c-brand);
+ --docsearch-text-color: var(--c-text);
+ --docsearch-highlight-color: var(--c-brand);
+ --docsearch-muted-color: var(--c-text-quote);
+ --docsearch-container-background: rgba(9, 10, 17, 0.8);
+ --docsearch-modal-background: var(--c-bg-light);
+ --docsearch-searchbox-background: var(--c-bg-lighter);
+ --docsearch-searchbox-focus-background: var(--c-bg);
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--c-brand);
+ --docsearch-hit-color: var(--c-text-light);
+ --docsearch-hit-active-color: var(--c-bg);
+ --docsearch-hit-background: var(--c-bg);
+ --docsearch-hit-shadow: 0 1px 3px 0 var(--c-border-dark);
+ --docsearch-footer-background: var(--c-bg);
+}
+
+// plugin-external-link-icon
+.external-link-icon {
+ --external-link-icon-color: var(--c-text-quote);
+}
+
+// plugin-medium-zoom
+.medium-zoom-overlay {
+ --medium-zoom-bg-color: var(--c-bg);
+}
+
+// plugin-nprogress
+#nprogress {
+ --nprogress-color: var(--c-brand);
+}
+
+// plugin-photo-swipe
+body {
+ --photo-swipe-bullet: var(--c-bg);
+ --photo-swipe-bullet-active: var(--c-brand);
+}
+
+// plugin-pwa-popup
+html {
+ --pwa-text-color: var(--c-text);
+ --pwa-bg-color: var(--c-bg);
+ --pwa-border-color: var(--c-brand);
+ --pwa-btn-text-color: var(--c-bg);
+ --pwa-btn-bg-color: var(--c-brand);
+ --pwa-btn-hover-bg-color: var(--c-brand-light);
+}
+
+html.dark {
+ --pwa-shadow-color: rgb(0 0 0 / 30%);
+ --pwa-content-color: #ccc;
+ --pwa-content-light-color: #999;
+}
+
+// plugin-redirect
+.language-modal-mask {
+ --redirect-bg-color: var(--c-bg);
+ --redirect-bg-color-light: var(--c-bg-light);
+ --redirect-bg-color-lighter: var(--c-bg-lighter);
+ --redirect-text-color: var(--c-text);
+ --redirect-primary-bg-color: var(--c-brand);
+ --redirect-primary-hover-bg-color: var(--c-brand-light);
+ --redirect-primary-text-color: var(--c-bg);
+}
+
+// plugin-search
+.search-box {
+ --search-bg-color: var(--c-bg);
+ --search-accent-color: var(--c-brand);
+ --search-text-color: var(--c-text);
+ --search-border-color: var(--c-border);
+
+ --search-item-text-color: var(--c-text-lighter);
+ --search-item-focus-bg-color: var(--c-bg-light);
+}
+Click to expand dark mode CSS variables
html.dark {
+ // brand colors
+ --c-brand: #3aa675;
+ --c-brand-light: #349469;
+
+ // background colors
+ --c-bg: #22272e;
+ --c-bg-light: #2b313a;
+ --c-bg-lighter: #262c34;
+ --c-bg-dark: #343b44;
+ --c-bg-darker: #37404c;
+
+ // text colors
+ --c-text: #adbac7;
+ --c-text-light: #96a7b7;
+ --c-text-lighter: #8b9eb0;
+ --c-text-lightest: #8094a8;
+
+ // border colors
+ --c-border: #3e4c5a;
+ --c-border-dark: #34404c;
+
+ // custom container colors
+ --c-tip: #318a62;
+ --c-warning: #e0ad15;
+ --c-warning-bg: #2d2f2d;
+ --c-warning-bg-light: #423e2a;
+ --c-warning-bg-lighter: #44442f;
+ --c-warning-border-dark: #957c35;
+ --c-warning-details-bg: #39392d;
+ --c-warning-title: #fdca31;
+ --c-warning-text: #d8d96d;
+ --c-warning-text-accent: #ffbf00;
+ --c-warning-text-light: #ddb84b;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #fc1e38;
+ --c-danger-bg: #39232c;
+ --c-danger-bg-light: #4b2b35;
+ --c-danger-bg-lighter: #553040;
+ --c-danger-border-dark: #a25151;
+ --c-danger-details-bg: #482936;
+ --c-danger-title: #fc2d3b;
+ --c-danger-text: #ea9ca0;
+ --c-danger-text-accent: #fd3636;
+ --c-danger-text-light: #d9777c;
+ --c-danger-text-quote: #d56b6b;
+ --c-details-bg: #323843;
+
+ // badge component colors
+ --c-badge-warning: var(--c-warning);
+ --c-badge-warning-text: #3c2e05;
+ --c-badge-danger: var(--c-danger);
+ --c-badge-danger-text: #401416;
+
+ // code blocks vars
+ --code-hl-bg-color: #363b46;
+}
+
+// plugin-docsearch
+html.dark .DocSearch {
+ --docsearch-logo-color: var(--c-text);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309;
+ --docsearch-key-shadow: inset 0 -2px 0 0 #282d55, inset 0 0 1px 1px #51577d,
+ 0 2px 2px 0 rgba(3, 4, 9, 0.3);
+ --docsearch-key-gradient: linear-gradient(-225deg, #444950, #1c1e21);
+ --docsearch-footer-shadow: inset 0 1px 0 0 rgba(73, 76, 106, 0.5),
+ 0 -4px 8px 0 rgba(0, 0, 0, 0.2);
+}
+Themes
Catalog
Client Related
Composables APIs
hasGlobalComponent
Check whether a component is registered globally.
TIP
- Local import of the component does not affect the result.
- When calling outside
setupscope, you need to pass theappinstance as the second parameter.
export const hasGlobalComponent: (name: string, app?: App) => boolean
+Example
// if you globally register `<my-component>`
+hasGlobalComponent('MyComponent') // true
+hasGlobalComponent('my-component') // true
+
+hasGlobalComponent('MyComponent2') // false
+useLocaleConfig
Get current locale config from locales settings.
export const useLocaleConfig: <T extends LocaleData>(
+ localesConfig: RequiredLocaleConfig<T>,
+) => ComputedRef<T>
+Example
const localesCOnfig = {
+ '/': 'Title',
+ '/zh/': '标题',
+}
+
+const locale = useLocaleConfig(localesConfig)
+
+// under `/page`
+locale.value // 'Title'
+
+// under `/zh/page`
+locale.value // '标题'
+@vuepress/helper
This package is a helper utility for VuePress developers.
@vuepress/helper: Node.js side helper utilities.@vuepress/helper/client: Client side helper utilities.@vuepress/helper/shared: Utilities that are both available at Node.js side or Client.
Bundler Related
Bundler function is for appending or modifying bundler options in theme and plugins.
All functions should be called in extendsBundlerOptions lifecycle hook.
TIP
We are omitting that in examples. The actual code should be like this:
// import functions you need
+import { addCustomElement } from '@vuepress/helper'
+
+export const yourPlugin = {
+ // ...
+ extendsBundlerOptions: (bundlerOptions, app) => {
+ // add them here
+ addCustomElement(bundlerOptions, app, 'my-custom-element')
+ },
+}
+Common methods
getBundlerName
Get current bundler name.
export const getBundlerName: (app: App) => string
+Example
// @vuepress/bundler-vite
+getBundleName(app) === 'vite' // true
+// @vuepress/bundler-webpack
+getBundleName(app) === 'webpack' // true
+addCustomElement
Add a custom element declaration to the current bundler.
/**
+ * Add tags as customElement
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param customElements tags recognized as custom element
+ */
+export const addCustomElement = (
+ bundlerOptions: unknown,
+ app: App,
+ customElement: string[] | string | RegExp
+) => void;
+Example
import { addCustomElement } from '@vuepress/helper'
+
+addCustomElement(bundlerConfig, app, 'my-custom-element')
+addCustomElement(bundlerOptions, app, [
+ 'custom-element1',
+ 'custom-element2',
+ // all tags start with `math-`
+ /^math-/,
+])
+customizeDevServer
Provides contents for specific path in dev server.
export interface DevServerOptions {
+ /**
+ * Path to be responded
+ */
+ path: string;
+ /**
+ * Respond function
+ */
+ response: (request?: IncomingMessage) => Promise<string | Buffer>;
+
+ /**
+ * error msg
+ */
+ errMsg?: string;
+}
+
+/**
+ * Handle specific path when running VuePress Dev Server
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param path Path to be responded
+ * @param response respond function
+ * @param errMsg error msg
+ */
+export const customizeDevServer: (
+ bundlerOptions: unknown,
+ app: App,
+ {
+ errMsg:"The server encountered an error",
+ response: responseHandler,
+ path,
+ }: CustomServerOptions
+) => void;
+Example
import { useCustomDevServer } from '@vuepress/helper'
+
+// handle `/api/` path
+useCustomDevServer(bundlerOptions, app, {
+ path: '/api/',
+ response: async () => getData(),
+ errMsg: 'Unexpected api error',
+})
+Vite Related
addViteOptimizeDepsInclude
Add modules to Vite
optimizeDeps.includelistTIP
If a package meets one of the following conditions, you should consider adding it here.
- It's in CJS format
- It's dependencies include CJS package
- It's dynamically imported via
import()
addViteOptimizeDepsExclude
Add modules to Vite
optimizeDeps.excludelistIf a package and its dependencies are all pure ESM packages, you should consider adding it here.
addViteSsrExternal
Add modules to Vite
ssr.externallistIf a package is a pure ESM package and does not use aliases or define variables, you should consider adding it here.
addViteSsrNoExternal
Add modules to Vite
ssr.noExternallistIf an alias or define is used within a package, you must add it here.
/** + * Add modules to Vite `optimizeDeps.include` list + */ +export const addViteOptimizeDepsInclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite `optimizeDeps.exclude` list + */ +export const addViteOptimizeDepsExclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite `ssr.external` list + */ +export const addViteSsrExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite `ssr.noExternal` list + */ +export const addViteSsrNoExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void +Examples
import { + addViteOptimizeDepsInclude, + addViteOptimizeDepsExclude, + addViteSsrExternal, + addViteSsrNoExternal, +} from '@vuepress/helper' + +addViteOptimizeDepsInclude(bundlerOptions, app, ['vue', 'vue-router']) +addViteOptimizeDepsExclude(bundlerOptions, app, 'packageA') +addViteSsrNoExternal(bundlerOptions, app, ['vue', 'vue-router']) +addViteSsrExternal(bundlerOptions, app, 'packageA') +addViteConfig
A function for you to add vite config
export const addViteConfig: ( + bundlerOptions: unknown, + app: App, + config: Record<string, unknown>, +) => void +Example
import { addViteConfig } from '@vuepress/helper' + +addViteConfig(bundlerOptions, app, { + build: { + charset: 'utf8', + }, +}) +mergeViteConfig
A function for you to merge vite config.
WARNING
Your users may choose to use other bundler so it's pretty bad to declare vite as deps!
export const mergeViteConfig: ( + defaults: Record<string, any>, + overrides: Record<string, any>, +) => Record<string, any> +Example
import { mergeViteConfig } from '@vuepress/helper' + +config.viteOptions = mergeViteConfig(config.viteOptions, { + build: { + charset: 'utf8', + }, +}) +
Webpack Related
chainWebpack
Chain webpack config.
export const chainWebpack: ( + bundlerOptions: unknown, + app: App, + chainWebpack: ( + config: WebpackChainConfig, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +Example
import { chainWebpack } from '@vuepress/helper' + +chainWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +configWebpack
Config Webpack
export const configWebpack: ( + bundlerOptions: unknown, + app: App, + configureWebpack: ( + config: WebpackConfiguration, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +Example
import { configWebpack } from '@vuepress/helper' + +configWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +
Page Related
These functions generate common information for your pages.
getPageExcerpt
Get the excerpt of the page.
export interface PageExcerptOptions {
+ /**
+ * Excerpt separator
+ *
+ * @default "<!-- more -->"
+ */
+ separator?: string
+
+ /**
+ * Length of excerpt
+ *
+ * @description Excerpt length will be the minimal possible length reaching this value
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * Tags which is considered as custom elements
+ *
+ * @description This is used to determine whether a tag is a custom element since all unknown tags are removed in excerpt.
+ */
+ isCustomElement?: (tagName: string) => boolean
+
+ /**
+ * Whether keep page title (first h1) in excerpt
+ *
+ * @default false
+ */
+ keepPageTitle?: boolean
+
+ /**
+ * Whether preserve tags like line numbers and highlight lines for code blocks
+ *
+ * @default false
+ */
+ keepFenceDom?: boolean
+}
+
+export const getPageExcerpt: (
+ app: App,
+ page: Page,
+ options?: PageExcerptOptions,
+) => string
+getPageText
Get plain text of the page.
export interface PageTextOptions {
+ /**
+ * Whether convert text to single line content
+ *
+ * @default false
+ */
+ singleLine?: boolean
+
+ /**
+ * Length of text
+ *
+ * @description Text length will be the minimal possible length reaching this value
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * Tags to be removed
+ *
+ * @description Table and code blocks are removed by default.
+ *
+ * @default ['table', 'pre']
+ */
+ removedTags?: string[]
+}
+
+export const getPageText: (
+ app: App,
+ page: Page,
+ options?: PageTextOptions,
+) => string
+Shared Methods
The following functions are available on both Node.js and Client.
Data Related
Encode/decode and zip/unzip data.
This is useful in markdown plugins when you want to encode string content and pass it to the component through props.
You may simply achieve this with encodeURIComponent and decodeURIComponent, but it can be very large if the content contains lots of special characters.
So we provide encodeData and decodeData to zip and encode content.
export const encodeData: (
+ data: string,
+ level: DeflateOptions['level'] = 6,
+) => string
+
+export const decodeData: (compressed: string) => string
+const content = `
+{
+ "type": "bar",
+ "data": {
+ "labels": ["Red", "Blue", "Yellow", "Green", "Purple", "Orange"],
+ "datasets": [
+ {
+ "label": "# of Votes",
+ "data": [12, 19, 3, 5, 2, 3],
+ "backgroundColor": [
+ "rgba(255, 99, 132, 0.2)",
+ "rgba(54, 162, 235, 0.2)",
+ "rgba(255, 206, 86, 0.2)",
+ "rgba(75, 192, 192, 0.2)",
+ "rgba(153, 102, 255, 0.2)",
+ "rgba(255, 159, 64, 0.2)"
+ ],
+ "borderColor": [
+ "rgba(255, 99, 132, 1)",
+ "rgba(54, 162, 235, 1)",
+ "rgba(255, 206, 86, 1)",
+ "rgba(75, 192, 192, 1)",
+ "rgba(153, 102, 255, 1)",
+ "rgba(255, 159, 64, 1)"
+ ],
+ "borderWidth": 1
+ }
+ ]
+ },
+ "options": {
+ "scales": {
+ "y": {
+ "beginAtZero": true
+ }
+ }
+ }
+}
+`
+
+const prop = encodeData(content) // "eJyNUsFOwzAMve8rrHABKZqWlg5WxAE4cARxAMHEIV1NmQhNlaaCCe3fcdKtW0sLWGpjxy/v+UV512mlcIyfhTa2hHP4GgHYVYExsEQaxqlMpZWxbwAomaAqY5izO0wZB3apKnTrIyqlP1x2bRBzl9xWplC+eWNkniF7dmw1X4nWsfgaNtwNP2kfgH6Be22x9CPUUQ8yFwEHMeMQcog4UBFuiF0kcvGWGV3l6ZVW2uw0XDCTJfIwiOjYjAhESIcn4+BoT2MLio6pP6V+EBJ6AOSZgsmUwyl9A6ATwoiZn3lYTkTkRkycnuP8TU9ENPqUxuuA9i9BmxTNPy9A/G2/F9I23wtpW++FdIwPKzW2W5Afph+WqX2NQWz313XicT7XhV3qnB5f/ejKhVTYVACrXUqUmC3zC/uERsdgTYUdVr/Qb302+gZxe7S/"
+
+decodeData(prop) // will be the original content
+
+// if you use `encodeURIComponent`, it will be much longer
+encodeURIComponent(content) // '%0A%7B%0A%20%20%22type%22%3A%20%22bar%22%2C%0A%20%20%22data%22%3A%20%7B%0A%20%20%20%20%22labels%22%3A%20%5B%22Red%22%2C%20%22Blue%22%2C%20%22Yellow%22%2C%20%22Green%22%2C%20%22Purple%22%2C%20%22Orange%22%5D%2C%0A%20%20%20%20%22datasets%22%3A%20%5B%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22%23%20of%20Votes%22%2C%0A%20%20%20%20%20%20%20%20%22data%22%3A%20%5B12%2C%2019%2C%203%2C%205%2C%202%2C%203%5D%2C%0A%20%20%20%20%20%20%20%20%22backgroundColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%200.2)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%201)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderWidth%22%3A%201%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%20%20%7D%2C%0A%20%20%22options%22%3A%20%7B%0A%20%20%20%20%22scales%22%3A%20%7B%0A%20%20%20%20%20%20%22y%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22beginAtZero%22%3A%20true%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A'
+Type Helper
isDef(x): Check ifxis defined.isBoolean(x): Check ifxis a boolean.isString(x): Check ifxis a string.isNumber(x): Check ifxis a number.isPlainObject(x): Check ifxis a plain object.isArray(x): Check ifxis an array.isFunction(x): Check ifxis a function.isRegExp(x): Check ifxis a regular expression.
String Related
startsWith(a, b): Check if stringastarts with stringb.endsWith(a, b): Check if stringaends with stringb.
Return false if a is not a string.
对象相关
keys(x): Return an array of keys of objectx.values(x): Return an array of values of objectx.entries(x): Convert objectxto an array of key-value pairs.fromEntries(x): Convert an array of key-value pairsxto an object.deepAssign(x, y, ...): A deep version ofObject.assign.Example
// or @vuepress/helper/client +import { deepAssign } from '@vuepress/helper' + +const defaultOptions = { + optionA: { + optionA1: 'defaultOptionA1', + optionA2: 'defaultOptionA2', + optionA3: 'defaultOptionA3', + }, + optionB: true, + optionC: 'optionC', +} + +const userOptions = { + optionA: { + optionA1: 'optionA1', + optionA2: 'optionA2', + }, + optionB: false, +} + +deepAssign(defaultOptions, userOptions) +// { +// optionA: { +// optionA1: "optionA1", +// optionA2: "optionA2", +// optionA3: "defaultOptionA3", +// }, +// optionB: false, +// optionC: "optionC", +// } +
Date Related
getDate(x): Convert inputxto a date. It can supportDate, timestamp, and date string. The support degree of date string depends on theDate.parsesupport degree of the environment. Returnnullwhen it cannot be converted to a date.Example
getDate('2021-01-01') // a Date object represents 2021-01-01 +getDate(1609459200000) // a Date object represents 2021-01-01 +getDate('2021-01-01T00:00:00.000Z') // a Date object represents 2021-01-01 +getDate('2021/01/01') // a Date object represents 2021-01-01 (might be null in some browsers) +getDate('invalid date') // null +getDate(undefined) // null +getDate(-32) // null +dateSorter: Sort the values that can be converted to dates from new to old, and the values that cannot be converted to dates will be at the end.Example
const arr = [ + '2020-01-01', + 1609459200000, + '2022-01-01T00:00:00.000Z', + '2023/01/01', + 'invalid date', + undefined, + -32, +] + +arr.sort(dateSorter) +// [ +// '2023/01/01', +// '2022-01-01T00:00:00.000Z', +// 1609459200000, +// '2020-01-01', +// 'invalid date', +// undefined, +// -32, +// ] +
Link Related
isLinkHttp(x): Check ifxis a valid HTTP URL.isLinkWithProtocol(x): Check ifxis a valid URL with protocol.isLinkExternal(x): Check ifxis a valid external URL.isLinkAbsolute(x): Check ifxis a valid absolute URL.ensureEndingSlash(x): Ensurexends with a slash.ensureLeadingSlash(x): Ensurexstarts with a slash.removeEndingSlash(x): Ensurexdoes not end with a slash.removeLeadingSlash(x): Ensurexdoes not start with a slash.
active-header-links
该插件会监听页面滚动事件。当页面滚动至某个 标题锚点 后，如果存在对应的 标题链接 ，那么该插件会将路由 Hash 更改为该 标题锚点 。
该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。
使用方法
npm i -D @vuepress/plugin-active-header-links@next
+import { activeHeaderLinksPlugin } from '@vuepress/plugin-active-header-links'
+
+export default {
+ plugins: [
+ activeHeaderLinksPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
headerLinkSelector
类型：
string默认值：
'a.sidebar-item'详情：
标题链接 的选择器。
如果一个 标题锚点 没有对应的 标题链接 ，那么即使滚动到这个 标题锚点 ，该插件也不会更改路由 Hash 。
headerAnchorSelector
类型：
string默认值：
'.header-anchor'详情：
标题锚点 的选择器。
你通常不需要设置该选项，除非你通过 markdown.anchor 修改了 markdown-it-anchor 的
permalinkClass选项。参考：
delay
类型：
number默认值：
200详情：
滚动事件监听器的 Debounce 延迟。
offset
类型：
number默认值：
5详情：
即便直接点击 标题锚点 的链接，
scrollTop也可能不会完全等于 标题锚点 的offsetTop，所以我们添加一个 Offset 偏移量来避免这个误差。
back-to-top
该插件会给你的站点添加一个 返回顶部 按钮。当页面向下滚动时，该按钮会显示在页面的右下角，点击它就会滚动到页面顶部。
该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-back-to-top@next
+import { backToTopPlugin } from '@vuepress/plugin-back-to-top'
+
+export default {
+ plugins: [backToTopPlugin()],
+}
+选项
threshold
- 类型：
数字 - 默认值：
100 - 详情：显示返回顶部按钮的滚动阈值距离（以像素为单位）
progress
- 类型：
布尔值 - 默认值：
true - 详情：是否在图标周围显示进度条
样式
你可以通过 CSS 变量来自定义 返回顶部 按钮的样式：
:root {
+ --back-to-top-z-index: 5;
+ --back-to-top-icon: url("back-to-top.svg");
+ --back-to-top-bg-color: #fff;
+ --back-to-top-color: #3eaf7c;
+ --back-to-top-color-hover: #71cda3;
+ --back-to-top-shadow: rgb(0 0 0 / 20%);
+}
+baidu-analytics
将 百度统计 集成到 VuePress 中。
使用方法
npm i -D @vuepress/plugin-baidu-analytics@next
+import { baiduAnalyticsPlugin } from '@vuepress/plugin-baidu-analytics'
+
+export default {
+ plugins: [
+ baiduAnalyticsPlugin({
+ // 配置项
+ }),
+ ],
+}
+上报事件
在使用该插件之后，一个全局的 hmt 数组会被挂载到 window 对象上，你可以使用它进行 自定义事件的上报 。
选项
id
- 类型：
string - 详情： 百度统计的 ID ，即
hm.jsURL 中的查询参数。
配置
插件选项
getInfo
类型:
(page: Page) => Record<string, unknown>必填: 否
参考:
详情：
获取文章信息的函数。
获取到的信息会被稍后注入至路由元数据，以便你可以在客户端中通过组合式 API 获取。
filter
类型:
(page: Page) => boolean默认值:
(page) => Boolean(page.filePathRelative) && !page.frontmatter.home参考:
详情：
页面过滤器，此函数用于鉴别页面是否作为文章。
默认情况下，所有从 Markdown 源文件中生成的非主页页面，会被作为文章。
category
类型:
BlogCategoryOptions[]必填: 否
详情：
详情：
博客分类配置，详见 博客分类配置。
type
类型:
BlogTypeOptions[]必填: 否
参考：
详情：
博客分类配置，详见 博客类型配置。
slugify
- 类型:
(name: string) => string - 默认值:
(name) => name.replace(/ _/g, '-').replace(/[:?*|\\/<>]/g, "").toLowerCase() - 详情：Slugify 函数，用于转换 key 在路由中注册的形式。
excerpt
- 类型:
boolean - 默认值:
true - 详情：是否生成摘要。
excerptSeparator
- 类型:
string - 默认值:
<!-- more --> - 详情：摘要分隔符。
excerptLength
类型:
number默认值:
300参考：
详情：
自动生成的摘要的长度。
提示
摘要的长度会尽可能的接近这个值。如果设置为
0，意味着不自动生成摘要。
excerptFilter
类型:
(page: Page) => boolean默认值:
filter选项参考：
详情： 页面过滤器，此函数用于鉴别插件是否需要生成摘要。
提示
你可以使用此函数来跳过你不需要生成摘要的页面。例如：如果用户在 frontmatter 中设置了
excerpt或description，你可能希望直接使用它们。
isCustomElement
类型:
(tagName: string) => boolean默认值:
() => false参考：
详情： 被认为是自定义元素的标签。
用于判断一个标签是否是自定义元素，因为在摘要中，所有的未知标签都会被移除。
metaScope
类型:
string默认值:
"_blog"详情： 注入文章信息至路由元数据时使用的键名。
提示
设置为空字符串会直接注入路由元数据 (而不是一个键下)。
hotReload
类型:
boolean默认值: 是否使用
--debug标记详情： 是否在开发服务器中启用实时热重载。
致主题开发者
默认情况下它是禁用的，因为它确实会对具有很多分类和类别的站点产生性能影响，并且在编辑 Markdown 时会减慢热重载的速度。
如果用户正在添加或组织类别或标签，你可以告诉他们启用此功能，其余的时间最好禁用它。
此外，你可以尝试检测用户项目中的页面数并决定是否启用它。
博客分类配置
博客分类配置应为一个数组，每一项控制一个分类规则。
interface BlogCategoryOptions {
+ /**
+ * 唯一的分类名称
+ */
+ key: string
+
+ /**
+ * 从页面中获取分类的函数
+ */
+ getter: (page: Page) => string[]
+
+ /**
+ * 页面排序器
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * 待注册的页面路径图案
+ *
+ * @description `:key` 将会被替换为原 key 的 slugify 结果
+ *
+ * @default `/:key/`
+ */
+ path?: string | false
+
+ /**
+ * 页面布局组件名称
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Front Matter 配置
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+
+ /**
+ * 待注册的项目页面路径图案或自定义函数
+ *
+ * @description 当填入字符串的时候, `:key` 和 `:name` 会被自动替换为原始的 key、name 的 slugify 结果。
+ *
+ * @default `/:key/:name/`
+ */
+ itemPath?: string | ((name: string) => string) | false
+
+ /**
+ * 项目页面布局组件名称
+ *
+ * @default 'Layout'
+ */
+ itemLayout?: string
+
+ /**
+ * 项目 Front Matter 配置
+ */
+ itemFrontmatter?: (name: string, localePath: string) => Record<string, string>
+}
+博客类型配置
博客类型配置应为一个数组，每一项控制一个类型规则。
interface BlogTypeOptions {
+ /**
+ * 唯一的类型名称
+ */
+ key: string
+
+ /**
+ * 一个过滤函数来决定页面是否满足此类型
+ */
+ filter: (page: Page) => boolean
+
+ /**
+ * 页面排序器
+ */
+ sorter?: (pageA: Page, pageB: Page) => number
+
+ /**
+ * 待注册的页面路径
+ *
+ * @default '/:key/'
+ */
+ path?: string | false
+
+ /**
+ * 页面布局组件名称
+ *
+ * @default 'Layout'
+ */
+ layout?: string
+
+ /**
+ * Front Matter 配置
+ */
+ frontmatter?: (localePath: string) => Record<string, string>
+}
+可组合式 API
你可以从 @vuepress/plugin-blog/client 导入下列 API:
博客分类
const useBlogCategory: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogCategoryData<T>> +参数
key为需要获取的键名。如果未传入 key，会尝试使用与当前路径匹配的 key。博客类型
const useBlogType: < + T extends Record<string, unknown> = Record<string, unknown>, +>( + key?: string, +) => ComputedRef<BlogTypeData<T>> +参数
key为需要获取的键名。如果未传入 key，会尝试使用与当前路径匹配的 key。
详细的返回值如下:
interface Article<T extends Record<string, unknown> = Record<string, unknown>> {
+ /** 文章路径 */
+ path: string
+ /** 文章信息 */
+ info: T
+}
+
+interface BlogCategoryData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** 分类路径 */
+ path: string
+
+ /**
+ * 仅当当前路径和某个子项目匹配时可用
+ */
+ currentItems?: Article<T>[]
+
+ /** 分类映射 */
+ map: {
+ /** 当前分类下全局唯一的 key */
+ [key: string]: {
+ /** 对应键值的分类路径 */
+ path: string
+ /** 对应键值的项目 */
+ items: Article<T>[]
+ }
+ }
+}
+
+interface BlogTypeData<
+ T extends Record<string, unknown> = Record<string, unknown>,
+> {
+ /** 类别路径 */
+ path: string
+
+ /** 当前类别下的项目 */
+ items: Article<T>[]
+}
+使用 @vuepress/plugin-blog，你可以轻松地将博客功能引入主题。
收集文章并生成信息
起步时，插件会首选过滤并选择那些需要作为文章的页面。这将剔除你不想要的页面，并在后续处理中排除它们。
默认情况下，所有从 Markdown 文件生成但不是主页的页面，都将被视作文章。
你可能需要设置 filter 选项来完全自定义要收集的页面。 filter 接受一个形状为 (page: Page) => boolean 的函数。
接着，你应该设置 getInfo 选项为一个接受 Page 作为参数并返回包含所需信息的对象的函数。这样稍后，你可以从组合 API 中获取这些信息。
案例
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ filter: ({ filePathRelative, frontmatter }) => {
+ // 舍弃那些不是从 Markdown 文件生成的页面
+ if (!filePathRelative) return false
+
+ // 舍弃 `archives` 文件夹的页面
+ if (filePathRelative.startsWith('archives/')) return false
+
+ // 舍弃那些没有使用默认布局的页面
+ if (frontmatter.home || frontmatter.layout) return false
+
+ return true
+ },
+
+ getInfo: ({ frontmatter, git = {}, data = {} }) => {
+ // 获取页面信息
+ const info: Record<string, any> = {
+ author: frontmatter.author || '',
+ categories: frontmatter.categories || [],
+ date: frontmatter.date || git.createdTime || null,
+ tags: frontmatter.tags || [],
+ excerpt: data.excerpt || '',
+ }
+
+ return info
+ },
+ }),
+ // 其他插件 ...
+ ],
+}
+自定义类别和类型
基本上，你的博客中需要两种“类型”:
类别:
“类别”是用文章的标签 (或类别) 对它们进行分组。
例如，每篇文章可能都有对应的“分类”和“标签”。
类型:
“类型”是过滤不同条件的文章。
例如，你的帖子中可能有日记或笔记。当帖子带有写作日期信息时，它可以称为“时间线项目”。
了解这两种类型的描述后，你可以设置 category 和 type 选项，它们都接受一个数组，每个元素代表一个配置。
让我们从此处 2 个例子开始。
假设你想为每篇文章设置标签，并且你正在通过 frontmatter.tag 设置它们。同时，你想要在 /tag/ 中使用 TagMap 布局的标签页面，并在/tag/标签名称 中使用 TagList 布局对标签按名称进行分组，你可能需要这样的配置:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // 其他配置 ...
+ category: [
+ {
+ key: 'tag',
+ getter: ({ frontmatter }) => frontmatter.tag || [],
+ path: '/tag/',
+ layout: 'TagMap',
+ frontmatter: () => ({ title: '标签页' }),
+ itemPath: '/tag/:name/',
+ itemLayout: 'TagList',
+ itemFrontmatter: (name) => ({ title: `${name}标签` }),
+ },
+ ],
+ }),
+ // 其他插件 ...
+ ],
+}
+此外，你可能希望为你的一些文章加注星标，并将其展示给访问者。当你在 frontmatter 中设置 star: true 来标记它们时，你可能需要这样的配置来在 /star/ 路径中以 StarList 布局显示它们:
import { blogPlugin } from '@vuepress/plugin-blog'
+
+export default {
+ name: 'vuepress-theme-xxx',
+ plugins: [
+ blogPlugin({
+ // 其他配置 ...
+ type: [
+ {
+ key: 'star',
+ filter: ({ frontmatter }) => frontmatter.star,
+ path: '/star/',
+ layout: 'StarList',
+ frontmatter: () => ({ title: '星标文章' }),
+ },
+ ],
+ }),
+ // 其他插件 ...
+ ],
+}
+看，设置这两种类型很容易。有关完整选项，请参阅 博客分类配置 和 博客分类配置。
在客户端使用组合 API
当生成每个页面时，插件将在 frontmatter.blog 中设置如下信息
interface BlogFrontmatterOptions {
+ /** 当前页面的类型 */
+ type: 'category' | 'type'
+ /** 在当前分类或类别下全局唯一的 key */
+ key: string
+ /**
+ * 当前的分类名称
+ *
+ * @description 仅在分类子项目页面中可用
+ */
+ name?: string
+}
+所以你可以直接调用 useBlogCategory() 和 useBlogType()，结果将是当前路由绑定的类别或类型。
此外，你可以通过传递所需的 key 作为参数，来将获得绑定到该 key 的信息。
对于上方的 Node 配置而言，你可以在客户端通过如下方式获取 tag 和 star 的信息:
TagMap 布局:
<template>
+ <div>
+ <h1>Tag page</h1>
+ <ul>
+ <li v-for="({ items, path }, name) in categoryMap.map">
+ <RouteLink :key="name" :to="path" class="category">
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </li>
+ </ul>
+ </div>
+</template>
+<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+import { RouteLink } from 'vuepress/client'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+TagList 布局:
<template>
+ <div>
+ <h1>Tag page</h1>
+ <div class="category-wrapper">
+ <RouteLink
+ v-for="({ items, path }, name) in categoryMap.map"
+ :key="name"
+ :to="path"
+ class="category"
+ >
+ {{ name }}
+ <span class="category-num">
+ {{ items.length }}
+ </span>
+ </RouteLink>
+ </div>
+ <div class="article-wrapper" v-if="categoryMap.currentItems">
+ <div v-if="!categoryMap.currentItems.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in categoryMap.currentItems"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline
+ ? `${new Date(info.date).toLocaleDateString()}: `
+ : '') + info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author"
+ >Author: {{ info.author }}</span
+ >
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag"
+ >Tag: {{ info.tag.join(', ') }}</span
+ >
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+ </div>
+</template>
+<script setup lang="ts">
+import { useBlogCategory } from '@vuepress/plugin-blog'
+import { RouteLink } from 'vuepress/client'
+
+const categoryMap = useBlogCategory('tag')
+</script>
+StarList 布局:
<template>
+ <div class="article-wrapper" v-if="stars.items">
+ <div v-if="!stars.items.length">Nothing in here.</div>
+ <article
+ v-for="{ info, path } in stars.items"
+ class="article"
+ @click="$router.push(path)"
+ >
+ <header class="title">
+ {{
+ (isTimeline ? `${new Date(info.date).toLocaleDateString()}: ` : '') +
+ info.title
+ }}
+ </header>
+ <hr />
+ <div class="article-info">
+ <span v-if="info.author" class="author">Author: {{ info.author }}</span>
+ <span v-if="info.date && !isTimeline" class="date"
+ >Date: {{ new Date(info.date).toLocaleDateString() }}</span
+ >
+ <span v-if="info.category" class="category"
+ >Category: {{ info.category.join(', ') }}</span
+ >
+ <span v-if="info.tag" class="tag">Tag: {{ info.tag.join(', ') }}</span>
+ </div>
+ <div v-if="info.excerpt" class="excerpt" v-html="info.excerpt" />
+ </article>
+ </div>
+</template>
+<script setup lang="ts">
+import { useBlogType } from '@vuepress/plugin-blog/client'
+
+import ArticleList from '../components/ArticleList.vue'
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+
+const stars = useBlogType('star')
+</script>
+有关返回类型，请参阅 Composition API 返回类型。
多语言支持
该插件添加了原生多语言支持，因此你的设置将自动应用于每种语言。
例如，如果用户进行了以下 locales 配置，并且你正在设置上面的“star”示例:
export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+}
+那么 /zh/star/ 和 /star/ 都将可用，并且只会显示对应语言下的文章。
摘要生成
这个插件提供了一个内置的摘要生成器，可以通过将 excerpt 选项设置为 true 来启用。
摘要介绍
摘要是一个 HTML 片段，被用于在博客列表中显示文章的简短描述，所以摘要有如下限制:
- 摘要不支持任何未知标签以及 Vue 语法，所以此类内容会在生成时被移除。如果你有自定义组件 (非 Vue 组件)，请配置
isCustomElement选项。 - 由于摘要是一个 HTML 片段，所以你将无法通过相对路径或别名引入任何图片，这些图片会被直接移除。如果你想要保留图片，请使用基于
.vuepress/public的绝对路径或完整路径以确保它们可以在其他地址被访问。
摘要生成器将尝试从 Frontmatter 内容中找到有效的摘要分隔符，如果找到，它将使用分隔符之前的内容，分隔符默认为 <!-- more -->，并且你可以通过 excerptSeparator 选项来自定义它。
如果找不到有效的分隔符，它将从 Markdown 文件的开头开始解析内容，直到长度达到预设值时停止。该值默认为 300，你可以通过设置 excerptLength 选项来自定义它。
要选择哪个页面应该生成摘要，你可以使用 excerptFilter 选项。
示例
通常，如果用户设置了 frontmatter.description，你可能希望使用它们，因此如果 frontmatter.description 不为空，你可以让过滤器函数返回 false。
+
+
+
diff --git a/zh/plugins/catalog.html b/zh/plugins/catalog.html
new file mode 100644
index 0000000000..de91f34dcc
--- /dev/null
+++ b/zh/plugins/catalog.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+
+
catalog
此插件可以自动生成目录页面，也提供目录组件。
使用方法
npm i -D @vuepress/plugin-catalog@next
+import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ plugins: [
+ catalogPlugin({
+ // 你的选项
+ }),
+ ],
+}
+首先，你应该在路由元信息中设置目录信息:
import { catalogPlugin } from '@vuepress/plugin-catalog'
+
+export default {
+ extendsPage: (page) => {
+ // 在 routeMeta 中设置目录信息
+ page.routeMeta = {
+ // 目录标题
+ title: page.title,
+ // ... 其他信息
+ }
+ },
+}
+你可以之后导入 defineCatalogInfoGetter 并在 客户端配置文件 中使用它来从元信息中提取目录信息。
import { defineCatalogInfoGetter } from '@vuepress/plugin-catalog/client'
+
+export default {
+ setup: () => {
+ defineCatalogInfoGetter((meta) =>
+ meta.title ? { title: meta.title } : null,
+ )
+ },
+}
+目录信息应包含:
title: 目录标题order: 目录顺序 (可选)content: 目录内容组件 (可选)
通过 order 排序
插件将按以下方式通过 order 对页面进行排序:
// 从小到大依次排列正数
+order 1 的项目
+order 2 的项目
+...
+order 10 的项目
+...
+// 无 order 的项目
+无 order 的项目
+无 order 的项目
+...
+// 从小到大依次排列负数
+order -10 的项目
+// ...
+order -2 的项目
+order -1 的项目
+选项
level 仅限内置组件
- 类型：
1 | 2 | 3 - 默认值：
3 - 详情：目录项级别的最大深度。
index 仅限内置组件
- 类型：
boolean - 默认值：
false - 详情：目录是否显示索引
frontmatter
类型：
(path: string) => Record<string, any>详情：生成页面的 Frontmatter 获取器。
示例：
import { catalogPlugin } from '@vuepress/plugin-catalog' + +export default { + plugins: [ + catalogPlugin({ + frontmatter: (path) => ({ + // 你想要的 frontmatter + // 你可以自定义标题、作者、时间等 + }), + }), + ], +} +
exclude
类型：
(RegExp | string)[]默认值：
[]详情：
生成中需要排除的目录页路径。
"/foo/"意味着仅排除/foo/文件夹的目录页生成。/^\/foo\//意味着排除/foo/文件夹及其子文件夹的目录页生成。
404 页面会被自动排除。
component
- 类型：
string - 详情：用作目录的组件名称。
locales
类型：
CatalogPluginLocaleConfiginterface CatalogPluginLocaleData { + /** + * 目录标题 + */ + title: string + + /** + * 空目录提示 + */ + empty: string +} + +interface CatalogPluginLocaleConfig { + [localePath: string]: CatalogPluginLocaleData +} +必填: 否
详情：目录组件国际化配置。
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
客户端选项
defineCatalogInfoGetter
interface CatalogInfo {
+ /** 目录标题 */
+ title: string
+ /** 目录顺序 */
+ order?: number
+ /** 目录内容 */
+ content?: Component
+}
+
+type CatalogInfoGetter = (meta: Record<string, unknown>) => CatalogInfo | null
+
+const defineCatalogInfoGetter: (options: CatalogInfoGetter) => void
+自定义如何从 meta 中提取目录信息。
组件
Catalog
详情：
该插件默认会全局注册一个
<Catalog />组件（除非你设置了component选项）。你可以在主题布局中或直接在 Markdown 文件中使用
<Catalog />。组件支持四个属性：
level：更改显示层次深度（最大仅支持 3 层），默认为3。base：显示指定文件夹的目录，默认显示当前文件夹目录。index：为目录项添加索引号，默认无标号。hideHeading：隐藏组件标题，默认会显示目录标题。
样式
你可以通过 CSS 变量来自定义目录样式：
:root {
+ --catalog-bg-color: #fff;
+ --catalog-bg-secondary-color: #f8f8f8;
+ --catalog-border-color: #e5e5e5;
+ --catalog-active-color: #3eaf7c;
+ --catalog-hover-color: #71cda3;
+}
+container
为你的 VuePress 站点注册自定义容器。
该插件简化了 markdown-it-container 的使用方法，但同时也保留了其原本的能力。
默认主题的 自定义容器 就是由该插件支持的。
使用方法
npm i -D @vuepress/plugin-container@next
+import { containerPlugin } from '@vuepress/plugin-container'
+
+export default {
+ plugins: [
+ containerPlugin({
+ // 配置项
+ }),
+ ],
+}
+容器语法
::: <type> [info]
+[content]
+:::
+type是必需的，应通过 type 配置项来指定。info是可选的，其默认值可以通过 locales 的defaultInfo配置项来指定。content可是任何合法的 Markdown 内容。
提示
该插件可以被多次使用，以便支持不同类型的容器。
配置项
type
类型：
string详情：
容器的类型。
它将会被用作 markdown-it-container 的
name参数。
locales
类型：
Record<string, { defaultInfo: string }>详情：
容器在不同 locales 下的默认
info。如果没有指定该配置项，默认
info会使用大写的 type 。示例：
export default {
+ plugins: [
+ containerPlugin({
+ type: 'tip',
+ locales: {
+ '/': {
+ defaultInfo: 'TIP',
+ },
+ '/zh/': {
+ defaultInfo: '提示',
+ },
+ },
+ }),
+ ],
+}
+- 参考：
before
类型：
(info: string) => string默认值：
(info: string): string =>
+ `<div class="custom-container ${type}">${info ? `<p class="custom-container-title">${info}</p>` : ''}\n`
+after
类型：
(info: string) => string默认值：
(): string => '</div>\n'
+render
- 类型：
type MarkdownItContainerRenderFunction = (
+ tokens: Token[],
+ index: number,
+ options: any,
+ env: MarkdownEnv,
+ self: Renderer,
+) => string
+详情：
markdown-it-container 的
render配置项。该插件使用了一个默认的
render函数。但如果你指定了该配置项，那么默认的render函数就会被替换掉，此时 locales 、 before 和 after 配置项都会被忽略。
validate
类型：
(params: string) => boolean详情：
markdown-it-container 的
validate配置项。
marker
类型：
string详情：
markdown-it-container 的
marker配置项。
copy-code
此插件会自动在 PC 设备上为每个代码块右上角添加复制按钮。
默认选择器匹配 @vuepress/theme-default，所以在你自己的主题中集成时可能需要调整它。
使用
npm i -D @vuepress/plugin-copy-code@next
+import { copyCodePlugin } from '@vuepress/plugin-copy-code'
+
+export default {
+ plugins: [
+ copyCodePlugin({
+ // options
+ }),
+ ],
+}
+选项
selector
类型：
string | string[]默认值：
'.theme-default-content div[class*="language-"] pre'详情:
代码块选择器
showInMobile
类型：
boolean默认值：
false详情:
是否展示在移动端
duration
类型：
number默认值：
2000详情:
提示消息显示时间，设置为
0会禁用提示。
delay
类型：
number默认值：
800详情:
注册复制按钮的延时，单位 ms。
如果你使用的主题有切换动画，建议配置此选项为
切换动画时长 + 200
locales
类型：
CopyCodePluginLocaleConfiginterface CopyCodePluginLocaleData { + /** + * 复制文字 + */ + copy: string + + /** + * 已复制文字 + */ + copied: string +} + +interface CopyCodePluginLocaleConfig { + [localePath: string]: CopyCodePluginLocaleData +} +必填：否
详情:
复制按钮插件的国际化配置。
示例：
import { copyCodePlugin } from '@vuepress/plugin-copy-code' + +export default { + locales: { + '/': { + // 这是一个支持的语言 + lang: 'zh-CN', + }, + '/xx/': { + // 这是一个没有收到插件支持的语言 + lang: 'mm-NN', + }, + }, + + plugins: [ + copyCodePlugin({ + locales: { + '/': { + // 覆盖复制按钮标签文字 + copy: '复制此段代码', + }, + + '/xx/': { + // 在这里完整设置 `mm-NN` 的多语言配置 + }, + }, + }), + ], +} +
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
样式
你可以通过 CSS 变量来自定义复制按钮的样式：
:root {
+ --code-copy-icon: url("copy-button.svg");
+ --code-copied-icon: url("copied-button.svg");
+ --copy-code-color: #9e9e9e;
+ --copy-code-hover: rgb(0 0 0 / 50%);
+}
+copyright
此插件可以在访问者从你的站点复制内容时，自动追加版权信息，也可以禁止站点的复制或者选择。
使用
npm i -D @vuepress/plugin-copyright@next
+import { copyrightPlugin } from '@vuepress/plugin-copyright'
+
+export default {
+ plugins: [
+ copyrightPlugin({
+ // options
+ }),
+ ],
+}
+启用版权信息
此插件默认全局禁用。你可以:
- 在特定页面的 frontmatter 中设置
copy: true手动开启。 - 在插件选项中设置
global: true让其全局生效，并在页面的 frontmatter 中设置copy: false禁用它。
处于不打扰用户的考虑，默认配置下仅当复制长度超过 100 时才会追加版权信息。如果你希望改变这个触发值，你可以插件选项中设置 triggerLength，或在页面 frontmatter 单独设置 copy.triggerLength。
你可以通过插件的 author 和 license 选项设置全局作者和协议信息。
如果文档的不同部分拥有不同的作者和协议，你可以通过 authorGetter 和 licenseGetter 传入一个使用当前页面对象作为参数的函数 (page: Page) => string 并通过它返回相应信息。
插件会默认通过模板从作者、协议和页面链接生成版权信息，并在复制时追加。如果你认为这不够灵活，你可以设置 copyrightGetter 返回一个完全由你自定义的版权信息，或返回 null 以使用默认模板。
禁用复制和选择
如果你希望禁止用户复制较长内容，你可以在插件选项中设置 maxLength 控制这个临界值，或在页面 frontmatter 单独设置 copy.maxLength。
- 如果你不希望用户复制你的整个站点或特定页面文字，你可以在插件选项中设置
disableCopy或在页面 frontmatter 中设置copy.disableCopy来禁用复制，后者具有更高优先级。 - 如果你不希望用户选择你的整个站点或特定页面文字，你可以在插件选项中设置
disableSelection或在页面 frontmatter 中设置copy.disableSelection来禁用文字选择。此选项具有更高优先级
选项
author
- 类型：
string - 详情：默认作者信息
license
- 类型：
string - 详情：默认协议信息
authorGetter
- 类型：
(page: Page) => string | null - 详情：作者信息获取器
licenseGetter
- 类型：
(page: Page) => string | null - 详情：协议信息获取器
copyrightGetter
- 类型：
(page: Page) => string | null - 详情：协议信息获取器
triggerLength
- 类型：
number - 默认值：
100 - 详情：触发附加版权的最小内容长度
maxLength
- 类型：
number - 默认值：
0 - 详情：允许复制的最大内容长度，
0意味着无限制。
global
- 类型：
boolean - 默认值：
false - 详情：是否全局启用
disableCopy
- 类型：
boolean - 默认值：
false - 详情：禁用复制
disableSelection
- 类型：
boolean - 默认值：
false - 详情：禁用选择
canonical
类型：
string详情：
首选部署位置。
例子
如果你在 https://myblog.com 和 https://blog.com/username/ 下部署相同的内容，你可能希望选择一个站点作为首选链接。
- 如果你倾向于使用第一个，你应该将
canonical设置为https://myblog.com - 如果你倾向于使用第二个，你应该将
canonical设置为https://blog.com/username/
这样，在另一个站点触发的版权信息也会指向你的首选站点。
locales
类型：
CopyrightPluginLocaleConfiginterface CopyrightPluginLocaleData { + /** + * 作者文字 + * + * @description `:author` 将会被作者替换 + */ + author: string + + /** + * 协议文字 + * + * @description `:license` 会被当前协议替换 + */ + license: string + + /** + * 链接文字 + * + * @description `:link` 会替换为当前页面链接 + */ + link: string +} + +interface CopyrightPluginLocaleConfig { + [localePath: string]: CopyrightPluginLocaleData +} +详情：版权插件的国际化配置。
示例：
import { copyrightPlugin } from '@vuepress/plugin-copyright' + +export default { + locales: { + '/': { + // this is a supported language + lang: 'en-US', + }, + '/xx/': { + // the plugin does not support this language + lang: 'mm-NN', + }, + }, + + plugins: [ + copyrightPlugin({ + locales: { + '/': { + // Override link text + link: 'Original posted at :link', + }, + + '/xx/': { + // Complete locale config for `mm-NN` language here + }, + }, + }), + ], +} +
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
Frontmatter
copy.triggerLength
- 类型：
number - 默认值：
100 - 详情： 触发附加版权的最小内容长度
copy.maxLength
- 类型：
number - 默认值：
0 - 详情： 允许复制的最大内容长度，
0意味着无限制。
copy.disableCopy
- 类型：
boolean - 默认值：
false - 详情：禁用复制
copy.disableSelection
- 类型：
boolean - 默认值：
false - 详情：禁用选择
docsearch
将 Algolia DocSearch 集成到 VuePress 中，为你的文档网站提供搜索功能。
提示
当你正确配置该插件后，默认主题会把 DocSearch 按钮添加到导航栏。
该插件不一定能在其他主题中直接使用，因此你应参考主题本身的文档来获取更多信息。
使用方法
npm i -D @vuepress/plugin-docsearch@next
+import { docsearchPlugin } from '@vuepress/plugin-docsearch'
+
+export default {
+ plugins: [
+ docsearchPlugin({
+ // 配置项
+ }),
+ ],
+}
+获取搜索索引
你需要 提交你的网站 URL 来加入 DocSearch 项目。当你的索引成功创建后， DocSearch 团队会将 apiKey 和 indexName 发送到你的邮箱。接下来，你就可以配置该插件，在 VuePress 中启用 DocSearch 了。
或者，你也可以 运行你自己的爬虫 来创建索引，然后使用你自己的 appId, apiKey 和 indexName 来配置该插件。
官方爬虫配置示例
new Crawler({
+ appId: 'YOUR_APP_ID',
+ apiKey: 'YOUR_API_KEY',
+ rateLimit: 8,
+ startUrls: [
+ // 这是 Algolia 开始抓取网站的初始地址
+ // 如果你的网站被分为数个独立部分，你可能需要在此设置多个入口链接
+ 'https://YOUR_WEBSITE_URL/',
+ ],
+ sitemaps: [
+ // 如果你在使用 Sitemap 插件 (如: @vuepress-plugin/sitemap)，你可以提供 Sitemap 链接
+ 'https://YOUR_WEBSITE_URL/sitemap.xml',
+ ],
+ ignoreCanonicalTo: false,
+ exclusionPatterns: [
+ // 你可以通过它阻止 Algolia 抓取某些 URL
+ ],
+ discoveryPatterns: [
+ // 这是 Algolia 抓取 URL 的范围
+ 'https://YOUR_WEBSITE_URL/**',
+ ],
+ // 爬虫执行的计划时间，可根据文档更新频率设置
+ schedule: 'at 02:00 every 1 day',
+ actions: [
+ // 你可以拥有多个 action，特别是你在一个域名下部署多个文档时
+ {
+ // 使用适当的名称为索引命名
+ indexName: 'YOUR_INDEX_NAME',
+ // 索引生效的路径
+ pathsToMatch: ['https://YOUR_WEBSITE_URL/**'],
+ // 控制 Algolia 如何抓取你的站点
+ recordExtractor: ({ $, helpers }) => {
+ // @vuepress/theme-default 的选项
+ return helpers.docsearch({
+ recordProps: {
+ lvl0: {
+ selectors: '.sidebar-heading.active',
+ defaultValue: 'Documentation',
+ },
+ lvl1: '.theme-default-content h1',
+ lvl2: '.theme-default-content h2',
+ lvl3: '.theme-default-content h3',
+ lvl4: '.theme-default-content h4',
+ lvl5: '.theme-default-content h5',
+ lvl6: '.theme-default-content h6',
+ content: '.theme-default-content p, .theme-default-content li',
+ },
+ indexHeadings: true,
+ })
+ },
+ },
+ ],
+ initialIndexSettings: {
+ // 控制索引如何被初始化，这仅当索引尚未生成时有效
+ // 你可能需要在修改后手动删除并重新生成新的索引
+ YOUR_INDEX_NAME: {
+ attributesForFaceting: ['type', 'lang'],
+ attributesToRetrieve: ['hierarchy', 'content', 'anchor', 'url'],
+ attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'],
+ attributesToSnippet: ['content:10'],
+ camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'],
+ searchableAttributes: [
+ 'unordered(hierarchy_radio_camel.lvl0)',
+ 'unordered(hierarchy_radio.lvl0)',
+ 'unordered(hierarchy_radio_camel.lvl1)',
+ 'unordered(hierarchy_radio.lvl1)',
+ 'unordered(hierarchy_radio_camel.lvl2)',
+ 'unordered(hierarchy_radio.lvl2)',
+ 'unordered(hierarchy_radio_camel.lvl3)',
+ 'unordered(hierarchy_radio.lvl3)',
+ 'unordered(hierarchy_radio_camel.lvl4)',
+ 'unordered(hierarchy_radio.lvl4)',
+ 'unordered(hierarchy_radio_camel.lvl5)',
+ 'unordered(hierarchy_radio.lvl5)',
+ 'unordered(hierarchy_radio_camel.lvl6)',
+ 'unordered(hierarchy_radio.lvl6)',
+ 'unordered(hierarchy_camel.lvl0)',
+ 'unordered(hierarchy.lvl0)',
+ 'unordered(hierarchy_camel.lvl1)',
+ 'unordered(hierarchy.lvl1)',
+ 'unordered(hierarchy_camel.lvl2)',
+ 'unordered(hierarchy.lvl2)',
+ 'unordered(hierarchy_camel.lvl3)',
+ 'unordered(hierarchy.lvl3)',
+ 'unordered(hierarchy_camel.lvl4)',
+ 'unordered(hierarchy.lvl4)',
+ 'unordered(hierarchy_camel.lvl5)',
+ 'unordered(hierarchy.lvl5)',
+ 'unordered(hierarchy_camel.lvl6)',
+ 'unordered(hierarchy.lvl6)',
+ 'content',
+ ],
+ distinct: true,
+ attributeForDistinct: 'url',
+ customRanking: [
+ 'desc(weight.pageRank)',
+ 'desc(weight.level)',
+ 'asc(weight.position)',
+ ],
+ ranking: [
+ 'words',
+ 'filters',
+ 'typo',
+ 'attribute',
+ 'proximity',
+ 'exact',
+ 'custom',
+ ],
+ highlightPreTag: '<span class="algolia-docsearch-suggestion--highlight">',
+ highlightPostTag: '</span>',
+ minWordSizefor1Typo: 3,
+ minWordSizefor2Typos: 7,
+ allowTyposOnNumericTokens: false,
+ minProximity: 1,
+ ignorePlurals: true,
+ advancedSyntax: true,
+ attributeCriteriaComputedByMinProximity: true,
+ removeWordsIfNoResults: 'allOptional',
+ },
+ },
+})
+上述 recordProps 是用于默认主题的配置，你可以根据你使用的主题来修改它们。
注意 initialIndexSettings.YOUR_INDEX_NAME.attributesForFaceting 字段必须包含 'lang'，否则该插件将无法正常工作。
提示
如果你使用的不是默认主题，或者在使用 Docsearch 的时候遇到了任何问题，你也可以检查上述的爬虫配置示例，然后前往 Algolia Crawler 仓库，在你项目侧边栏中的 Editor 页面中修改你的配置。
配置项
apiKey
类型：
string是否必需：
true详情：
从 DocSearch 团队收到的
apiKey，或者由你自己生成。参考：
indexName
类型：
string是否必需：
true详情：
从 DocSearch 团队收到的
indexName，或者由你自己生成。参考：
appId
类型：
string是否必需：
true详情：
用于设置你的 Application ID。
参考：
searchParameters
类型：
SearchParameters详情：
Algolia 搜索 API 参数。
参考：
placeholder
类型：
string默认值：
'Search docs'详情：
搜索输入框的 placeholder 属性。
参考：
disableUserPersonalization
类型：
boolean默认值：
false详情：
是否禁用所有的个性化功能：最近的搜索、收藏的搜索结果等。
参考：
initialQuery
类型：
string详情：
打开弹窗时的初始请求。
参考：
translations
类型：
Partial<DocSearchTranslations>详情：
允许替换 DocSearch 按钮和弹窗内的默认文字。
参考：
locales
类型：
Record<string, DocsearchPluginOptions>详情：
在不同 locales 下对该插件进行不同的配置。
该插件的所有其他选项都可以在 locale 中进行配置。
示例：
export default {
+ plugins: [
+ docsearchPlugin({
+ appId: '<APP_ID>',
+ apiKey: '<API_KEY>',
+ indexName: '<INDEX_NAME>',
+ locales: {
+ '/': {
+ placeholder: 'Search Documentation',
+ translations: {
+ button: {
+ buttonText: 'Search Documentation',
+ },
+ },
+ },
+ '/zh/': {
+ placeholder: '搜索文档',
+ translations: {
+ button: {
+ buttonText: '搜索文档',
+ },
+ },
+ },
+ },
+ }),
+ ],
+}
+- 参考：
indexBase
类型：
string默认值： base
详情：
搜索索引基础路径。
如果你需要把你的站点部署到不同的域名上，你不需要把它们全都提交到 Docsearch 上来分别生成搜索索引。你可以选择其中一个域名作为 索引域名 ，并且仅将 索引域名 提交到 DocSearch 上来爬去搜索索引。然后，你就可以在不同的部署域名下复用索引。
如果你不同部署域名下的 base 是不一样的，你就需要将这个配置设置成 索引域名 的 base ，这样其他的部署域名就可以正确复用索引了。
injectStyles
类型：
boolean默认值：
true详情：
是否注入 DocSearch 的默认样式。
如果你认为 DocSearch 的默认样式和你的站点不兼容，你可以尝试覆盖默认样式，或者将该选项设置为
false来完全移除默认样式。当该选项被禁用时，你需要为 DocSearch 引入你自己的样式。同时要注意，你也无法再使用 样式 章节中提到的样式自定义能力。
样式
你可以通过 @docsearch/css 提供的 CSS 变量来自定义样式：
:root {
+ --docsearch-primary-color: rgb(84, 104, 255);
+ --docsearch-text-color: rgb(28, 30, 33);
+ --docsearch-spacing: 12px;
+ --docsearch-icon-stroke-width: 1.4;
+ --docsearch-highlight-color: var(--docsearch-primary-color);
+ --docsearch-muted-color: rgb(150, 159, 175);
+ --docsearch-container-background: rgba(101, 108, 133, 0.8);
+ --docsearch-logo-color: rgba(84, 104, 255);
+
+ /* modal */
+ --docsearch-modal-width: 560px;
+ --docsearch-modal-height: 600px;
+ --docsearch-modal-background: rgb(245, 246, 247);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 rgba(255, 255, 255, 0.5), 0 3px
+ 8px 0 rgba(85, 90, 100, 1);
+
+ /* searchbox */
+ --docsearch-searchbox-height: 56px;
+ --docsearch-searchbox-background: rgb(235, 237, 240);
+ --docsearch-searchbox-focus-background: #fff;
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--docsearch-primary-color);
+
+ /* hit */
+ --docsearch-hit-height: 56px;
+ --docsearch-hit-color: rgb(68, 73, 80);
+ --docsearch-hit-active-color: #fff;
+ --docsearch-hit-background: #fff;
+ --docsearch-hit-shadow: 0 1px 3px 0 rgb(212, 217, 225);
+
+ /* key */
+ --docsearch-key-gradient: linear-gradient(
+ -225deg,
+ rgb(213, 219, 228) 0%,
+ rgb(248, 248, 248) 100%
+ );
+ --docsearch-key-shadow: inset 0 -2px 0 0 rgb(205, 205, 230), inset 0 0 1px 1px
+ #fff, 0 1px 2px 1px rgba(30, 35, 90, 0.4);
+
+ /* footer */
+ --docsearch-footer-height: 44px;
+ --docsearch-footer-background: #fff;
+ --docsearch-footer-shadow: 0 -1px 0 0 rgb(224, 227, 232), 0 -3px 6px 0 rgba(69, 98, 155, 0.12);
+}
+组件
Docsearch
详情：
该插件会全局注册一个
<Docsearch />组件，你可以不传入任何 Props 来使用它。将该组件放置在你想要显示 docsearch 按钮的地方。例如，默认主题将这个组件放在了导航栏的末尾。
提示
该组件主要用于主题开发。在大多数情况下你不需要直接使用该组件。
external-link-icon
该插件会为你 Markdown 内容中的外部链接添加一个图标，即
该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-external-link-icon@next
+import { externalLinkIconPlugin } from '@vuepress/plugin-external-link-icon'
+
+export default {
+ plugins: [
+ externalLinkIconPlugin({
+ // 配置项
+ }),
+ ],
+}
+选项
locales
类型：
Record<string, { openInNewWindow: string }>详情：
外部链接图标在不同 locales 下的 A11y 文字。
如果没有指定该配置项，它会降级使用默认文字。
示例：
export default {
+ plugins: [
+ externalLinkIconPlugin({
+ locales: {
+ '/': {
+ openInNewWindow: 'open in new window',
+ },
+ '/zh/': {
+ openInNewWindow: '在新窗口打开',
+ },
+ },
+ }),
+ ],
+}
+- 参考：
Frontmatter
externalLinkIcon
类型：
boolean详情：
是否在当前页面的外部链接的后面添加外部链接图标。
样式
你可以通过 CSS 变量来自定义外部链接图标的样式：
:root {
+ --external-link-icon-color: #aaa;
+}
+组件
ExternalLinkIcon
详情：
该插件会全局注册一个
<ExternalLinkIcon />组件，你可以不传入任何 Props 来使用它。
提示
该组件主要用于主题开发。在大多数情况下你不需要直接使用该组件。
频道设置
channel 插件选项用于配置 feed 的频道。
channel.title
- 类型：
string - 默认值：
SiteConfig.title
频道的标题
channel.link
- 类型：
string - 默认值：部署的网址 (通过
options.hostname和context.base生成)
频道地址
channel.description
- 类型：
string - 默认值：
SiteConfig.description
频道描述信息
channel.language
- 类型：
string - 默认值:
siteConfig.locales['/'].locales- 如果上述未提供，回退到
"en-US"
频道使用的语言
channel.copyright
- 类型：
string - 默认值:
- 尝试读取 channel 选项中的
author.name生成Copyright by $author
- 尝试读取 channel 选项中的
- 建议自行设置: 是
频道版权信息
channel.pubDate
- 类型：
string(需是合法的 Date ISOString) - 默认值：每次插件构建时刻
- 建议自行设置: 是
频道内容的发布时间
channel.lastUpdated
- 类型：
string(需是合法的 Date ISOString) - 默认值：每次插件构建时刻
频道内容的上次更新时间
channel.ttl
- 类型：
number - 建议自行设置: 是
内容有效时间，即获取后保持缓存而不进行新获取的时间
channel.image
- 类型：
string - 建议自行设置: 是
这是一个会在频道中使用的图片，建议设置正方形图片、尺寸最好不小于 512×512。
channel.icon
- 类型：
string - 建议自行设置: 是
一个代表频道的图标，建议设置正方形图片、尺寸最好不小于 128×128，背景色透明。
channel.author
- 类型：
FeedAuthor - 建议自行设置: 是
频道的作者。
FeedAuthor 格式
interface FeedAuthor {
+ /** 作者姓名 */
+ name: string
+ /** 作者电子邮箱 */
+ email?: string
+ /** 作者网站 */
+ url?: string
+ /**
+ * 作者头像地址
+ *
+ * 正方形，最好不小于 128×128，透明背景
+ */
+ avatar?: string
+}
+channel.hub
- 类型：
string
Websub 的链接。Websub 需要服务器后端，与 VuePress 主旨不符，如无特殊需要忽略即可。
WebSub
有关信息，详见 Websub。
插件配置
hostname
- 类型：
string - 必填：是
部署网站的域名。
atom
- 类型：
boolean - 默认值：
false
是否启用 Atom 格式输出。
json
- 类型：
boolean - 默认值：
false
是否启用 JSON 格式输出。
rss
- 类型：
boolean - 默认值：
false
是否启用 RSS 格式输出。
image
- 类型：
string
一个大的图片，用作 feed 展示。
icon
- 类型：
string
一个小的图标，显示在订阅列表中。
count
- 类型：
number - 默认值：
100
设置 feed 的最大项目数量。在所有页面排序好后，插件会截取前 count 个项目。
如果你的站点文章很多，你应该考虑设置这个选项以减少 feed 文件大小。
preservedElements
- 类型：
(RegExp | string)[] | (tagName：string) => boolean
应在 Feed 中保留的自定义元素或组件。
默认情况下，所有未知标签均会被移除。
filter
类型：
(page: Page)=> boolean默认值：
;({ frontmatter, filePathRelative }: Page): boolean => + !( + frontmatter.home || + !filePathRelative || + frontmatter.article === false || + frontmatter.feed === false + ) +
自定义的过滤函数，用于过滤哪些项目在 feed 中显示。
sorter
类型：
(pageA: Page, pageB: Page)=> number默认值：
// dateSorter 来源于 @vuepress/helper +;(pageA, pageB): number => + dateSorter( + pageA.data.git?.createdTime + ? new Date(pageA.data.git?.createdTime) + : pageA.frontmatter.date, + pageB.data.git?.createdTime + ? new Date(pageB.data.git?.createdTime) + : pageB.frontmatter.date, + ) +
Feed 项目的排序器。
默认的排序行为是通过 Git 的文件添加日期 (需要 @vuepress/plugin-git)。
提示
你应该启用 @vuepress/plugin-git 来获取最新创建的页面作为 feed 项目。否则，feed 项目将按照 VuePress 中页面的默认顺序排序。
channel
channel 选项用于配置 Feed 频道。
可用选项详见 配置 → 频道设置
devServer
- 类型：
boolean - 默认值：
false
是否在开发服务器中启用
提示
由于性能原因，我们不提供热更新。重启开发服务器以同步你的变更。
devHostname
- 类型：
string - 默认值：
"http://localhost:${port}"
开发服务器使用的主机名
atomOutputFilename
- 类型：
string - 默认值：
"atom.xml"
Atom 格式输出路径，相对于输出路径。
atomXslTemplate
- 类型：
string - 默认值：
@vuepress/plugin-feed/templates/atom.xsl的内容
Atom xsl 模板文件没人陪美国
atomXslFilename
- 类型：
string - 默认值：
"atom.xsl"
Atom xsl 输出路径，相对于输出路径。
jsonOutputFilename
- 类型：
string - 默认值：
"feed.json"
JSON 格式输出路径，相对于输出路径。
rssOutputFilename
- 类型：
string - 默认值：
"rss.xml"
RSS 格式输出路径，相对于输出路径。
rssXslTemplate
- 类型：
string - 默认值：
@vuepress/plugin-feed/templates/rss.xsl的内容
RSS xsl 模板文件内容。
rssXslFilename
- 类型：
string - 默认值：
"rss.xsl"
RSS xsl 输出路径，相对于输出路径。
getter
Feed 生成控制器，详见 Feed 生成器。
此插件内置了生成器，只有当你想完全控制 feed 生成时才需要设置此选项。
locales
- 类型：
Record<string, BaseFeedOptions>
你可以将它用于每个语言环境的特定选项。
除 hostname 外，上述任何选项均受支持。
Frontmatter 配置
你可以通过配置每个页面的 Frontmatter，来对每个 Feed 项目生成进行单独的控制。
添加与移除
默认情况下，所有文章均会被添加至 feed 流。如果你想在 feed 中移除特定页面，你可以在 frontmatter 中设置 feed: false。
读取的 Frontmatter 信息
title
- 类型：
string
由 VuePress 自动生成，默认为页面的 h1 内容
description
- 类型：
string
页面描述
date
- 类型：
Date
页面的发布日期
article
- 类型：
boolean
该页面是否是文章
如果此项设置为
false，则该页不会包含在最终的 feed 中。
copyright
- 类型：
string
页面版权信息
cover / image / banner
- 类型：
string
页面的封面/分享图，需为完整链接或绝对链接。
Frontmatter 选项
feed.title
- 类型：
string
Feed 项目的标题
feed.description
- 类型：
string
Feed 项目的描述
feed.content
- 类型：
string
Feed 项目的内容
feed.author
- 类型：
FeedAuthor[] | FeedAuthor
Feed 项目的作者
FeedAuthor 格式
interface FeedAuthor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.contributor
- 类型：
FeedContributor[] | FeedContributor
Feed 项目的贡献者
FeedContributor 格式
interface FeedContributor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+feed.guid
- 类型：
string
Feed 项目的标识符，用于标识 Feed 项目。
你应该确保每个 Feed 项目有全局唯一的 guid。
Feed 获取器
你可以通过控制插件选项中的 getter 来完全控制 Feed 项目的生成。
getter.title
- 类型：
(page: Page) => string
项目标题获取器
getter.link
- 类型：
(page: Page) => string
项目链接获取器
getter.description
- 类型：
(page: Page) => string | undefined
项目描述获取器
提示
因为 Atom 在摘要中支持 HTML，所以如果可能的话，你可以在这里返回 HTML 内容，但内容必须以标记 html: 开头。
getter.content
- 类型：
(page: Page) => string
项目内容获取器
getter.author
- 类型：
(page: Page) => FeedAuthor[]
项目作者获取器。
获取器应在作者信息缺失时返回空数组。
FeedAuthor 格式
interface FeedAuthor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.category
- 类型：
(page: Page) => FeedCategory[] | undefined
项目分类获取器。
FeedCategory 格式
interface FeedCategory {
+ /**
+ * 分类名称
+ */
+ name: string
+
+ /**
+ * 标识分类法的字符串
+ *
+ * @description rss format only
+ */
+ domain?: string
+
+ /**
+ * URI 标识的分类 scheme
+ *
+ * @description atom format only
+ */
+ scheme?: string
+}
+getter.enclosure
- 类型：
(page: Page) => FeedEnclosure | undefined
项目附件获取器。
FeedEnclosure 格式
interface FeedEnclosure {
+ /**
+ * Enclosure 地址
+ */
+ url: string
+
+ /**
+ * 类型
+ *
+ * @description 应为一个标准的 MIME 类型，rss format only
+ */
+ type: string
+
+ /**
+ * 按照字节数计算的大小
+ *
+ * @description rss format only
+ */
+ length?: number
+}
+getter.publishDate
- 类型：
(page: Page) => Date | undefined
项目发布日期获取器
getter.lastUpdateDate
- 类型：
(page: Page) => Date
项目最后更新日期获取器
getter.image
- 类型：
(page: Page) => string
项目图片获取器
确保返回一个完整的 URL。
getter.contributor
- 类型：
(page: Page) => FeedContributor[]
项目贡献者获取器
获取器应在贡献者信息缺失时返回空数组。
FeedContributor 格式
interface FeedContributor {
+ /**
+ * 作者名字
+ */
+ name?: string
+
+ /**
+ * 作者邮件
+ */
+ email?: string
+
+ /**
+ * 作者网站
+ *
+ * @description json format only
+ */
+ url?: string
+
+ /**
+ * 作者头像
+ *
+ * @description json format only
+ */
+ avatar?: string
+}
+getter.copyright
- 类型：
(page: Page) => string | undefined
项目版权获取器
指南
使用
插件可为你生成以下三种格式的 feed 文件:
- Atom 1.0
- JSON 1.1
- RSS 2.0
请按照需要生成的格式，在插件选项中设置 atom, json 或 rss 为 true。
为了正确生成 Feed 链接，你需要在插件选项中设置 hostname。
可读的预览
当你在浏览器中打开 Feed 文件时，我们会通过 xsl 模板将 atom 和 rss feed xml 魔法般地转换为可读的 html。你可以查看本站的 atom 和 rss feed 作为案例！
如果你想在开发服务器中预览 Feed，你需要在插件选项中设置 devServer: true。如果你没有使用默认的 http://localhost:{port}，你还需要设置 devHostname。
频道设置
你可以通过设置 channel 选项来自自定义 Feed 频道的各项信息。
我们推荐进行如下设置:
- 将建立 Feed 的日期转换为 ISOString 写入到
channel.pubDate中 - 通过
channel.ttl中设置内容的更新周期(单位: 分钟) - 通过
channel.copyright设置版权信息 - 通过
channel.author设置频道作者。
详细的选项及其默认值详见 配置 → 频道设置
Feed 生成
默认情况下，所有文章均会被添加至 feed 流。
你可以在 frontmatter 中配置 feed 和其他选项控制每个页面的 Feed 项目内容，详见 Frontmatter 选项 了解它们如何被转换。
你可以通过配置插件选项中的 getter 完全控制 Feed 项目的生成逻辑。 详细的选项及其默认值详见 配置 → Feed 获取器
多语言配置
插件会针对每个语言生成单独的 Feed。
你可以通过插件选项中的 locales 分别对不同语言提供不同的默认设置。
+
+
+
diff --git a/zh/plugins/git.html b/zh/plugins/git.html
new file mode 100644
index 0000000000..f33d1256cb
--- /dev/null
+++ b/zh/plugins/git.html
@@ -0,0 +1,66 @@
+
+
+
+
+
+
+
+
+
git
该插件会收集你的页面的 Git 信息，包括创建和更新时间、贡献者等。
默认主题的 lastUpdated 和 contributors 就是由该插件支持的。
该插件主要用于开发主题，大部分情况下你不需要直接使用它。
使用方法
npm i -D @vuepress/plugin-git@next
+import { gitPlugin } from '@vuepress/plugin-git'
+
+export default {
+ plugins: [
+ gitPlugin({
+ // 配置项
+ }),
+ ],
+}
+Git 仓库
该插件要求你的项目在 Git 仓库 下，这样它才能从提交历史记录中收集信息。
在构建站点时，你应该确保所有的提交记录是可以获取到的。举例来说， CI 工作流通常会在克隆你的仓库时添加 --depth 1 参数来避免拉取全部的提交记录，因此你需要禁用这个功能，以便该插件在 CI 可以中正常使用。
注意
该插件会显著降低准备数据的速度，特别是在你的页面数量很多的时候。你可以考虑在 dev 模式下禁用该插件来获取更好的开发体验。
配置项
createdTime
类型：
boolean默认值：
true详情：
是否收集页面的创建时间。
updatedTime
类型：
boolean默认值：
true详情：
是否收集页面的更新时间。
contributors
类型：
boolean默认值：
true详情：
是否收集页面的贡献者。
Frontmatter
gitInclude
类型：
string[]详情：
文件相对路径组成的数组，该数组中的文件会在计算页面数据时被包含在内。
示例：
---
+gitInclude:
+ - relative/path/to/file1
+ - relative/path/to/file2
+---
+页面数据
该插件会向页面数据中添加一个 git 字段。
在使用该插件后，可以在页面数据中获取该插件收集到的 Git 信息：
import type { GitPluginPageData } from '@vuepress/plugin-git'
+import { usePageData } from 'vuepress/client'
+
+export default {
+ setup() {
+ const page = usePageData<GitPluginPageData>()
+ console.log(page.value.git)
+ },
+}
+git.createdTime
类型：
number详情：
页面第一次提交的 Unix 毫秒时间戳。
该属性将取当前页面及 gitInclude 中所列文件的第一次提交的时间戳的最小值。
git.updatedTime
类型：
number详情：
页面最后一次提交的 Unix 毫秒时间戳。
该属性将取当前页面及 gitInclude 中所列文件的最后一次提交的时间戳的最大值。
git.contributors
- 类型：
GitContributor[]
interface GitContributor {
+ name: string
+ email: string
+ commits: number
+}
+详情：
页面的贡献者信息。
该属性将会包含 gitInclude 所列文件的贡献者。
google-analytics
将 Google Analytics 集成到 VuePress 中。
该插件会通过引入 gtag.js 来启用 Google Analytics 4 。
使用方法
npm i -D @vuepress/plugin-google-analytics@next
+import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics'
+
+export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ // 配置项
+ }),
+ ],
+}
+上报事件
Google Analytics 会 自动收集部分事件 ，比如 page_view, first_visit 等。
因此，如果你只是想收集站点的一些基础数据，你只需要正确设置 Measurement ID ，不需要再额外做其他事情。
在引入该插件之后，一个全局的 gtag() 函数会被挂载到 window 对象上，你可以使用它进行 自定义事件的上报 。
选项
id
类型：
string详情：
Google Analytics 4 的 Measurement ID ，应以
'G-'开头。你可以通过 这里 的指引来找到你的 Measurement ID 。注意区分 Google Analytics 4 的 Measurement ID （即 "G-" 开头的 ID） 和 Universal Analytics 的 Tracking ID （即 "UA-" 开头的 ID）。
示例：
export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ }),
+ ],
+}
+debug
类型：
boolean详情：
设置为
true可以向 DebugView 发送事件。了解更多关于 DebugView 的信息 。示例：
export default {
+ plugins: [
+ googleAnalyticsPlugin({
+ id: 'G-XXXXXXXXXX',
+ debug: true,
+ }),
+ ],
+}
+
+
+
+
diff --git a/zh/plugins/medium-zoom.html b/zh/plugins/medium-zoom.html
new file mode 100644
index 0000000000..f5408a50e0
--- /dev/null
+++ b/zh/plugins/medium-zoom.html
@@ -0,0 +1,67 @@
+
+
+
+
+
+
+
+
+
medium-zoom
将 medium-zoom 集成到 VuePress 中，为图片提供可缩放的功能。
该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-medium-zoom@next
+import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom'
+
+export default {
+ plugins: [
+ mediumZoomPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
selector
类型：
string默认值：
':not(a) > img'详情：
可缩放的图片的选择器。
默认情况下，该插件会使
<a>标签以外的所有图片都支持缩放。
delay
类型：
number默认值：
500详情：
以毫秒为单位的延迟。
在切换路由进入一个新页面时，该插件会在一定延迟后才使页面内的图片支持缩放。
zoomOptions
类型：
Object详情：
medium-zoom 的配置项。
参考：
样式
你可以通过 zoomOptions 对大部分的缩放样式进行自定义，不过作为补充，该插件同样提供了一些 CSS 变量：
:root {
+ --medium-zoom-z-index: 100;
+ --medium-zoom-bg-color: #ffffff;
+ --medium-zoom-opacity: 1;
+}
+Composition API
useMediumZoom
详情：
返回该插件使用的
Zoom实例，便于你直接使用实例上的 methods 。该插件会在切换路由进入当前页面时使图片支持缩放。但如果你要动态添加新图片，那么你可能就需要这个方法来让这些新图片也支持缩放。
该插件在
Zoom实例上额外添加了一个refresh方法，它将使用 selector 作为默认参数，先调用zoom.detach()再调用zoom.attach()，便于你快速刷新当前页面图片的缩放状态。示例：
import { nextTick } from 'vue'
+import { useMediumZoom } from '@vuepress/plugin-medium-zoom/client'
+
+export default {
+ setup() {
+ const zoom = useMediumZoom()
+
+ // ... 进行了一些操作，在当前页面添加了新的图片
+
+ // 此时你可能需要手动调用 `refresh` 来让这些新图片支持缩放
+ nextTick(() => {
+ zoom.refresh()
+ })
+ },
+}
+nprogress 插件
将 nprogress 集成到 VuePress 中，在切换到另一个页面时会展示进度条。
该插件已经集成到默认主题中。
使用方法
npm i -D @vuepress/plugin-nprogress@next
+import { nprogressPlugin } from '@vuepress/plugin-nprogress'
+
+export default {
+ plugins: [nprogressPlugin()],
+}
+样式
你可以通过 CSS 变量来自定义进度条的样式：
:root {
+ --nprogress-color: #29d;
+ --nprogress-z-index: 1031;
+}
+palette
为你的主题提供调色板功能。
该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。
对于主题作者，该插件可以帮助你提供用户自定义样式的能力。
使用方法
npm i -D @vuepress/plugin-palette@next
+import { palettePlugin } from '@vuepress/plugin-palette'
+
+export default {
+ plugins: [
+ palettePlugin({
+ // 配置项
+ }),
+ ],
+}
+调色板和样式
该插件会提供一个 @vuepress/plugin-palette/palette （调色板文件）和一个 @vuepress/plugin-palette/style （样式文件），用于在你的主题样式中引入。
调色板文件用于定义样式变量，因此它一般会在你主题样式的开头引入。举例来说，用户可以在调色板中定义 CSS 变量 、 SASS 变量 、 LESS 变量 或 Stylus 变量 ，然后你可以在你的主题样式中使用这些变量。
样式文件用于覆盖默认样式或添加额外样式，因此它一般会在你主题样式的末尾引入。
使用
在你的主题中使用该插件，假设你使用 SASS 作为 CSS 预处理器：
export default {
+ // ...
+ plugins: [palettePlugin({ preset: 'sass' })],
+}
+使用调色板
在你主题需要使用对应变量的地方引入该插件的调色板文件，比如在 Layout.vue 中：
<template>
+ <h1 class="palette-title">你好，调色板！</h1>
+</template>
+
+<style lang="scss">
+/* 从该插件的调色板中引入变量 */
+@import '@vuepress/plugin-palette/palette';
+
+/* 设置变量的默认值 */
+$color: red !default;
+
+/* 在你的样式中使用变量 */
+.palette-title {
+ color: $color;
+}
+</style>
+然后，用户就可以在 .vuepress/styles/palette.scss 中自定义变量：
$color: green;
+使用样式
在你主题的样式之后引入该插件的样式文件，比如在 clientConfigFile 中：
// 引入你主题本身的样式文件
+import 'path/to/your/theme/style'
+// 引入该插件的样式文件
+import '@vuepress/plugin-palette/style'
+然后，用户就可以在 .vuepress/styles/index.scss 中添加额外样式，并可以覆盖你主题本身的样式：
h1 {
+ font-size: 2.5rem;
+}
+配置项
preset
类型：
'css' | 'sass' | 'less' | 'stylus'默认值：
'css'详情：
设置其他选项的预设。
如果你没有对该插件进行进阶定制化的需要，建议只设置该配置项并忽略其他选项。
userPaletteFile
类型：
string默认值：
- css:
'.vuepress/styles/palette.css' - sass:
'.vuepress/styles/palette.scss' - less:
'.vuepress/styles/palette.less' - stylus:
'.vuepress/styles/palette.styl'
- css:
详情：
用户调色板文件的路径，是针对源文件目录的相对路径。
默认值依赖于 preset 配置项。
该文件用于用户定义样式变量，建议保持默认值作为约定的文件路径。
tempPaletteFile
类型：
string默认值：
- css:
'styles/palette.css' - sass:
'styles/palette.scss' - less:
'styles/palette.less' - stylus:
'styles/palette.styl'
- css:
详情：
生成的调色板临时文件的路径，是针对临时文件文件目录的相对路径。
默认值依赖于 preset 配置项。
你应该使用
'@vuepress/plugin-palette/palette'别名来引入调色板文件，因此在绝大多数情况下你不需要修改该配置项。
userStyleFile
类型：
string默认值：
- css:
'.vuepress/styles/index.css' - sass:
'.vuepress/styles/index.scss' - less:
'.vuepress/styles/index.less' - stylus:
'.vuepress/styles/index.styl'
- css:
详情：
用户样式文件的路径，是针对源文件目录的相对路径。
默认值依赖于 preset 配置项。
该文件用于用户覆盖默认样式和添加额外样式，建议保持默认值作为约定的文件路径。
tempStyleFile
类型：
string默认值：
- css:
'styles/index.css' - sass:
'styles/index.scss' - less:
'styles/index.less' - stylus:
'styles/index.styl'
- css:
详情：
生成的样式临时文件的路径，是针对临时文件文件目录的相对路径。
默认值依赖于 preset 配置项。
你应该使用
'@vuepress/plugin-palette/style'别名来引入样式文件，因此在绝大多数情况下你不需要修改该配置项。
importCode
类型：
(filePath: string) => string默认值：
- css:
(filePath) => `@import '${filePath}';\n` - sass:
(filePath) => `@forward 'file:///${filePath}';\n` - less:
(filePath) => `@import '${filePath}';\n` - stylus:
(filePath) => `@require '${filePath}';\n`
- css:
详情：
用于生成引入代码的函数。
默认值依赖于 preset 配置项。
该配置项用于生成 tempPaletteFile 和 tempStyleFile ，在绝大多数情况下你不需要修改该配置项。
photo-swipe
此插件会使页面正文内的图片在点击时进入浏览模式浏览。
使用方法
npm i -D @vuepress/plugin-photo-swipe@next
+import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe'
+
+export default {
+ plugins: [
+ photoSwipePlugin({
+ // 选项
+ }),
+ ],
+}
+在图片预览模式中，你可以:
- 左右滑动按顺序浏览页面内其他的图片
- 查看图片的描述
- 对图片进行缩放
- 全屏浏览图片
- 下载图片
- 分享图片
提示
- 除了点击右上角的 "×" 退出浏览模式外，在上下滚动超过一定距离后，会自动退出图片浏览模式。
- 在移动端，或使用 PC 触控板，你可以使用平移、缩放手势在浏览模式中平移、缩放图片。
选项
selector
- 类型：
string | string[] - 默认值：
".theme-default-content :not(a) > img:not([no-view])" - 详情：图片选择器
scrollToClose
- 类型：
boolean - 默认值：
true - 详情：是否在滚动时关闭当前图片。
delay
类型：
number默认值：
800详情：
操作页面 DOM 的延时，单位 ms。
提示
如果你使用的主题有切换动画，建议配置此选项为
切换动画时长 + 200。
locales
类型：
PhotoSwipePluginLocaleConfiginterface PhotoSwipePluginLocaleData { + /** + * 关闭按钮标签文字 + */ + close: string + + /** + * 全屏按钮标签文字 + */ + fullscreen: string + + /** + * 分享按钮标签文字 + */ + share: string + + /** + * 缩放按钮标签文字 + */ + zoom: string + + /** + * 上一张图片按钮标签文字 + */ + prev: string + + /** + * 下一张图片按钮标签文字 + */ + next: string + + /** + * 功能按钮配置 + */ + buttons: PhotoSwipeDefaultUI.ShareButtonData[] +} + +interface PhotoSwipePluginLocaleConfig { + [localePath: string]: PhotoSwipePluginLocaleData +} +详情：Photo Swipe 插件的国际化配置。
示例：
import { defineUserConfig } from 'vuepress' +import { photoSwipePlugin } from '@vuepress/plugin-photo-swipe' + +export default defineUserConfig({ + locales: { + '/': { + // 这是一个支持的语言 + lang: 'zh-CN', + }, + '/xx/': { + // 这是一个没有收到插件支持的语言 + lang: 'mm-NN', + }, + }, + + plugins: [ + photoSwipePlugin({ + locales: { + '/': { + // 覆盖分享标签文字 + share: '分享给伙伴', + }, + + '/xx/': { + // 在这里完整设置 `mm-NN` 的多语言配置 + }, + }, + }), + ], +}) +
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
Frontmatter
photoswipe
类型：
string | false详情：
当前页面的图片选择器或
false以在当前页面中禁用 photo-swipe。
客户端配置
definePhotoSwipeConfig
传递给 photo-swipe 的额外选项。
import { definePhotoSwipeConfig } from '@vuepress/plugin-photo-swipe/client'
+
+definePhotoSwipeConfig({
+ // 在此设置 photoswipe 选项
+})
+
+export default {}
+API
你可以通过 API 来调用 photoswipe。
createPhotoSwipe 允许你以编程的方式查看图片链接:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue';
+import { createPhotoSwipe } from "@vuepress/plugin-photo-swipe/client";
+
+let state: PhotoSwipeState | null = null;
+
+const openPhotoSwipe = (index: number) => {
+ state?.open(index - 1);
+};
+
+onMounted(async () => {
+ // 通过图片链接创建一个新的 photoswipe 实例
+ state= await createPhotoSwipe(
+ [
+ 'https://exmaple.com/image1.png'
+ 'https://exmaple.com/image2.png'
+ 'https://exmaple.com/image3.png'
+ ],
+ {
+ // photoswipe 选项
+ }
+ );
+});
+
+onUnmounted(() => {
+ state?.destroy()
+})
+</script>
+
+<template>
+ <button v-for="i in 3" @click="openPhotoSwipe(i)">open photo {{ i }}</button>
+</template>
+registerPhotoSwipe 允许你为给定的图片元素注册 photoswipe:
<script setup lang="ts">
+import { onMounted, onUnmounted } from 'vue'
+import { registerPhotoSwipe } from '@vuepress/plugin-photo-swipe/client'
+
+let destroy: () => void | null = null
+
+onMounted(async () => {
+ await nextTick()
+
+ const images = Array.from(document.querySelectorAll('img'))
+
+ // 通过图片元素创建一个新的 photoswipe 实例
+ state = await registerPhotoSwipe(images, {
+ // photoswipe 选项
+ })
+})
+
+onUnmounted(() => {
+ destroy?.()
+})
+</script>
+样式
你可以通过 CSS 变量来自定义部分样式：
:root {
+ --photo-swipe-bullet: #fff;
+ --photo-swipe-bullet-active: #3eaf7c;
+}
+prismjs
该插件使用 Prism.js 来为 Markdown 代码块启用代码高亮。
该插件已经集成到默认主题中。
需要注意的是，该插件仅会给代码块添加 HTML 标记，而不会添加样式。当你在一个自定义主题中使用它时，可能需要自己选择并引入 Prism.js 样式主题。
使用方法
npm i -D @vuepress/plugin-prismjs@next
+import { prismjsPlugin } from '@vuepress/plugin-prismjs'
+
+export default {
+ plugins: [
+ prismjsPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
preloadLanguages
类型：
string[]默认值：
['markdown', 'jsdoc', 'yaml']详情：
需要预加载的语言。
默认情况下，语言会在解析 Markdown 文件时按需加载。
然而， Prism.js 在动态加载语言时可能会遇到 一些潜在的问题 。为了避免这些问题，你可以使用该配置项来预加载一些语言。
配置
选项
showInstall
类型：
boolean默认值：
false详情：
是否在 Service Worker 首次成功注册时显示 PWA 安装按钮
manifest
类型：
ManifestOption详情：
填充一个将被解析为 manifest.webmanifest 的对象。
提示
如果未设置某些选项，它们会回退到插件预设值。
- name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - short_name:
siteConfig.title||siteConfig.locales['/'].title||"Site" - description:
siteConfig.description||siteConfig.locales['/'].description||"A site built with vuepress" - lang:
siteConfig.locales['/'].lang||"en-US" - start_url:
context.base - scope:
context.base - display:
"standalone" - theme_color:
"#46bd87" - background_color:
"#ffffff" - orientation:
"portrait-primary" - prefer_related_applications:
false
- name:
参考：
favicon
类型：
string详情：
favicon.ico地址，填入绝对路径。注意
我们建议你为你的站点生成 favicon。
themeColor
- 类型：
string - 默认值：
"#46bd87" - 详情：PWA 的主题色。
cacheHTML
- 类型：
boolean - 默认值：
false - 详情：是否缓存主页和 404 错误页之外的 HTML 文件
cacheImage
- 类型：
boolean - 默认值：
false - 详情：是否缓存图片。
maxSize
类型：
number默认值：
2048详情：
允许缓存的最大大小 (以 KB 为单位)
注意
此选项具有最高优先级，任何超过此值的文件都会被排除。
所以你如果生成了很大的 HTML 或 JS 文件，请考虑调高此值，否则你的 PWA 可能无法在离线模式下正常运行。
maxImageSize
类型：
number默认值：
1024详情：
图片允许缓存的最大大小 (以 KB 为单位)
该选项不能大于 maxSize 选项
update
类型：
"disabled" | "available" | "hint" | "force"默认值：
"available"详情：
发现新内容时的控制逻辑。
"disabled": 即使有新的 service worker 也不做任何事情，新的 service work 开始等待后，会在用户下次访问时接管页面，让用户获得新内容。"available": 仅当新的 service worker 可用时才显示更新弹出窗口"hint": 显示更新内容可用提示，并允许用户立即刷新。当新的 SW 成功注册后，将转为更新内容就绪弹窗。当你希望用户立即查看新文档时，这很有帮助。
提示
如果用户在新 SW 就绪前选择刷新，当前的 Service Worker 将被注销，并且请求将开始向 Web 发出。新的 service worker 将开始安装并在安装后接管页面。
"force": 立即注销当前 Service Worker 然后刷新以获取新内容警告
虽然这可以确保用户访问的是最新内容，但这可能会影响访问体验。
提示
文档的更新方式由以前的版本控制，因此当前选项仅影响此版本的下一次更新。
apple
更高支持苹果的特殊设置，忽略它们是安全的。
apple.icon
- 类型：
string - 详情：填入苹果使用的图标地址，推荐 152×152 大小
apple.statusBarColor
- 类型：
"black" | "white" - 默认值：
"black" - 详情：Safari 状态栏颜色
apple.maskIcon
- 类型：
string - 详情：Safari 图标
msTile
针对微软磁贴的特殊设置，忽略它们是安全的。
msTile.image
- 类型：
string - 详情：磁贴图标
msTile.color
- 类型：
string - 默认值：
themeColor - 详情：磁贴颜色。
foundComponent
- 类型：
string - 默认值：
"PwaFoundPopup" - 详情：自定义的提示弹窗组件路径。
readyComponent
- 类型：
string - 默认值：
"PwaReadyPopup" - 详情：自定义的更新弹窗组件路径。
appendBase
- 类型：
boolean - 默认值：
false - 详情：是否为选项中所有绝对链接添加 base。
generateSwConfig
详情：
传递给
workbox-build的选项，具体详情，请见 Workbox 文档
locales
类型：
PwaPluginLocaleConfiginterface PwaPluginLocaleData { + /** + * 安装按钮文字 + */ + install: string + + /** + * iOS 安装文字 + */ + iOSInstall: string + + /** + * 取消按钮文字 + */ + cancel: string + + /** + * 关闭按钮文字 + */ + close: string + + /** + * 上一张图片文字 + */ + prevImage: string + + /** + * 下一张图片文字 + */ + nextImage: string + + /** + * 安装解释 + */ + explain: string + + /** + * 描述标签文字 + */ + desc: string + + /** + * 特性标签文字 + */ + feature: string + + /** + * 更新内容提示文字 + */ + hint: string + + /** + * 更新内容可用文字 + */ + update: string +} + +interface PwaPluginLocaleConfig { + [localePath: string]: PwaPluginLocaleData +} +详情：
PWA 插件的国际化配置。
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
组合式 API
usePwaEvent
详情：
返回此插件的事件派发器。
你可以添加监听器函数到 register-service-worker 提供的事件。
示例：
import { usePwaEvent } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+ event.on('ready', (registration) => {
+ console.log('Service worker is active.')
+ })
+ },
+}
+工具函数
forceUpdate
详情：
当发现新内容时强制刷新页面。
示例：
import { forceUpdate } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ forceUpdate()
+ })
+ },
+}
+registerSW
详情：
手动注册 Service Worker。
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| serviceWorkerPath | string | Service worker 的路径 |
| hooks | object | Service worker 的钩子 |
| showStatus | boolean | 在控制台输出状态日志 |
interface Hooks {
+ registrationOptions?: RegistrationOptions
+ ready?: (registration: ServiceWorkerRegistration) => void
+ registered?: (registration: ServiceWorkerRegistration) => void
+ cached?: (registration: ServiceWorkerRegistration) => void
+ updated?: (registration: ServiceWorkerRegistration) => void
+ updatefound?: (registration: ServiceWorkerRegistration) => void
+ offline?: () => void
+ error?: (error: Error) => void
+}
+- 示例：
import { registerSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ registerSW('/service-worker.js', {
+ ready(registration) {
+ console.log('Service worker is active.')
+ },
+ })
+ })
+ },
+}
+skipWaiting
详情：
激活等待中的 Service Worker。
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| registration | ServiceWorkerRegistration | 想要激活的 Service Worker 的注册 |
- 示例：
import { usePwaEvent, skipWaiting } from '@vuepress/plugin-pwa/client'
+
+export default {
+ setup() {
+ const event = usePwaEvent()
+
+ event.on('updated', (registration) => {
+ console.log('The waiting service worker is available.')
+ // activate the waiting service worker
+ skipWaiting(registration)
+ })
+ },
+}
+unregisterSW
详情：
手动注销 Service Worker。
示例：
import { unregisterSW } from '@vuepress/plugin-pwa/client'
+import { onMounted } from 'vue'
+
+export default {
+ setup() {
+ onMounted(() => {
+ unregisterSW()
+ })
+ },
+}
+样式
你可以通过 CSS 变量来自定义样式：
:root {
+ --pwa-z-index: 10;
+ --pwa-color: #2c3e50;
+ --pwa-bg-color: #ffffff;
+ --pwa-border-color: #3eaf7c;
+ --pwa-shadow-color: rgb(0 0 0 / 15%);
+ --pwa-btn-text-color: #ffffff;
+ --pwa-btn-bg-color: #3eaf7c;
+ --pwa-btn-hover-bg-color: #4abf8a;
+ --pwa-content-color: #333;
+ --pwa-content-light-color: #666;
+}
+指南
介绍
将你的 VuePress 站点变成渐进式网络应用程序 (PWA)[1]。
此插件使用 workbox-build 生成 Service Worker 文件，并使用 register-service-worker 注册 Service Worker。
注意
如果你启用过该插件，并想要禁用它，你可能需要 `@vuepress/plugin-remove-pwa 来移除现有的 Service Worker 。
A PWA uses a Service Worker [2] (SW for short) to cache and proxy site content.
一个 PWA 使用 Service Worker [2:1] (简称 SW) 来获取并托管网站内容。
网络 App 清单
为了使你的网站符合 PWA 的要求，一个网络 App 清单[3]文件是必要的，并且你的 PWA 应满足可安装性[4]要求。
你可以通过设置 manifest 选项来自定义 manifest 文件，或者在 public 文件夹中提供 manifest.webmanifest 或 manifest.json。前者优先级更高。
插件会自动为你生成 manifest.webmanifest，并在每个页面的 <head> 中添加清单链接声明，但是 你至少应该通过 manifest.icons 或 PWA 插件中的其他选项设置一个有效的图标。
注意
可安装性[4:1]规范要求 manifest 中至少声明一个有效的图标。
所以如果你不配置 manifest.icons，访问者只能享受到 Service Worker 缓存带来的离线可访问性，而并不能作为 PWA 进行安装。
此外，该插件默认不处理清单中的任何内容，而是按原样输出。 这意味着，如果你计划部署到子目录，则应自行将 URL 前缀附加到自己的清单 Urls 中。如果你需要的所有东西都在 base 文件夹下，你可以在插件选项中设置 appendBase: true 让插件将 base 自动附加到任何地址。
缓存控制
为了更好的控制 Service Worker 可以预缓存的内容，插件提供了相关的缓存控制选项。
默认缓存
默认情况下插件会预缓存所有的 JS 和 CSS 文件，但仅缓存主页和 404 页面的 HTML。插件同时还会缓存字体文件 (woff, woff2, eot, ttf, otf) 和 SVG 图标。
图片缓存
如果你的站点只有少量重要图片，并希望它们在离线模式下显示，你可以通过设置 cacheImage 选项为 true 来缓存站点图片。
我们通过文件后缀名识别图片，任何以 .png, .jpg, .jpeg, .gif, .bmp, .webp 结尾的文件都会视为图片。
HTML 缓存
当你网站体积不大，并且希望文档完全离线可用时，你可以通过设置 cacheHTML 为 true 来缓存所有 HTML 页面。
为什么默认不缓存非主页和 404 页面
虽然说 VuePress 为所有的页面通过 SSG[5] 生成了 HTML 文件，但是这些文件主要用于 SEO[6]，并能够让你在后端不做 SPA[7] 配置的情况下能够直接访问任何链接。
VuePress 本质上是一个 SPA。这意味着你只需要缓存主页并从主页进入即可正常访问所有页面。所以默认不缓存其他 HTML 能够有效减小缓存大小 (可以缩减大约 40% 的体积)，加快 SW 更新速度。
但是这样做也有缺点，如果用户直接从非主页进入网站，首个页面的 HTML 文件仍需要从互联网加载。同时离线环境下，用户只能通过主页进入再自行导航到对应页面，直接访问某个链接会出现无法访问的提示。
大小控制
为了防止在预缓存列表中包含大文件，任何 > 2 MB 的文件或 > 1 MB 的图片都将被忽略。 你可以通过 maxSize 和 maxImageSize 来自定义大小限制 (单位为 KB)。
更新控制
我们提供 update 选项控制用户如何接收更新。
update 选项的默认值是 "available"，这意味着当网站内容更新后，新的 SW 会在后台静默安装，并在安装结束后弹窗提示用户新内容就绪。用户可以自主选择是否立即刷新查看新内容。这意味在新 SW 就绪前用户会访问旧版本网站。
如果你的文档仍在建设期，希望尽早提示用户他可能在阅读已过时的内容，你可以将其设置为 "hint"。这样用户在进入文档后数秒内就可以收到新内容已发布的通知。但这样做的负面效果是如果用户在新 SW 就绪前选择更新，那么他将在新 SW 安装并接管页面前，需要从互联网获取页面的全部资源。
如果你的文档很稳定，或者你在托管博客，不太关心用户立即接收到最新版本，你可以将其设置为 "disabled"，这意味着新的 SW 将在后台完全静默安装并在安装后等待，当旧版本 SW 控制的页面全部关闭后，新 SW 将再下次访问接管并提供用户新内容。此设置可以避免用户在访中被弹窗打扰。
如果你希望通过 SW 来加速用户在弱网或无网条件下的访问，但同时希望用户时刻访问新内容，你可以将此选项设置为 "force"。这意味着检测到新 SW 后旧 SW 将会被立刻销毁并且页面会被刷新以确保用户浏览最新内容。最大的缺点就是致新 SW 发布后，用户在重新进入网站后的几秒内会遇到预期之外的突然刷新，并且他们将必须通过互联网访问文档并完全重新安装最新的 SW。
更新提示弹窗
当检测到新内容 (检测到新的 SW) 时，更新提示弹窗将会出现；当新内容就绪时，更新就绪弹窗将会出现。
如果你对默认的弹窗不满意，你可以自行编写组件更换。从 @vuepress/plugin-pwa/client 中导入 PwaFoundPopup 或 PwaReadyPopup 并使用其 slot 来自定义弹窗内容，然后将组件路径传递给 foundComponent 或 readyComponent 选项。
<script setup lang="ts">
+import { PwaFoundPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaFoundPopup v-slot="{ found, refresh }">
+ <div v-if="found">
+ 已找到新内容
+ <button @click="refresh">刷新</button>
+ </div>
+ </PwaFoundPopup>
+</template>
+<script setup lang="ts">
+import { PwaReadyPopup } from '@vuepress/plugin-pwa/client'
+</script>
+<template>
+ <PwaReadyPopup v-slot="{ isReady, reload }">
+ <div v-if="isReady">
+ 新内容已就绪
+ <button @click="reload">应用</button>
+ </div>
+ </PwaReadyPopup>
+</template>
+其他选项
插件还提供了其他 PWA 相关选项，比如微软磁贴图标与颜色设置，苹果图标等。 如果你是一个高级用户，你也可以设置 generateSwConfig 来配置 workbox-build。查看 插件选项 了解更多细节。
相关阅读
更多内容，请详见:
PWA 介绍
PWA 全称 Progressive Web app，即渐进式网络应用程序，标准由 W3C 规定。
它允许网站通过支持该特性的浏览器将网站作为 App 安装在对应平台上。
访问 https://developer.mozilla.org/zh-CN/docs/Web/Progressive_web_apps 查看详情。 ↩︎
Service Worker 简要介绍
Service Worker 会在注册过程中获取注册在其中的所有文件并缓存它们。
注册成功后，Service Worker 激活，并开始代理并控制你的全部请求。
每当你想要通过浏览器发起访问请求后，Service Worker 将会查看其是否存在与自身缓存列表中，若存在则直接返回缓存好的结果，否则调用自身的 fetch 方法进行获取。你可以通过自定义 fetch 方法，来完全控制网页内资源获取请求的结果，比如在离线时提供一个 fallback 的网页。
每次用户重新打开网站时，Service Worker 会向自身注册时的地址发出校验命令，如果检测到新版本的 Service Worker，则会更新自身，并开始缓存注册在新 Service Worker 中的资源列表。成功获取内容更新后，Service Worker 将会触发
update事件。可以通过此事件提示用户，比如将在右下角显示一个弹出窗口，提示用户新内容可用并允许用户触发更新。
清单文件
清单文件使用 JSON 格式，负责声明 PWA 各项信息，如名称、描述、图标、快捷动作等。
为了使你的站点能够被注册为 PWA，你需要满足 manifest 基本的规范，才能使浏览器认为该网站为一个可安装的 PWA 并允许用户安装它。
↩︎提示
Manifest 的标准与规范，请详见 MDN 网络 App 清单 和 W3C Manifest
可安装性
想要让网站可以注册为 PWA，网站需要自行成功注册有效的 Service Worker，同时拥有合法的 manifest 清单文件并在网站中声明它。
清单文件应至少包含
name(或short_name)iconsstart_url。SSG: Static Site Generating，静态站点生成。 ↩︎
SEO: Search Engine Optimization，搜索引擎增强，
SPA: Single Page Application, 单页应用
大多只有主页，并使用 history mode 处理路由，而不是真的在页面之间导航。 ↩︎
+
+
+
diff --git a/zh/plugins/reading-time.html b/zh/plugins/reading-time.html
new file mode 100644
index 0000000000..8d5b907f16
--- /dev/null
+++ b/zh/plugins/reading-time.html
@@ -0,0 +1,131 @@
+
+
+
+
+
+
+
+
+
reading-time
此插件会为每个页面生成字数统计与预计阅读时间。
使用方法
npm i -D @vuepress/plugin-reading-time@next
+import { readingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default {
+ plugins: [
+ readingTimePlugin({
+ // 配置项
+ }),
+ ],
+}
+插件会将相关信息注入到页面数据的 readingTime，其中：
readingTime.minutes：为预计阅读时间（分钟）numberreadingTime.words：字数统计，number
在 Node 侧获取数据
对于任何页面，你可以从 page.data.readingTime 获取预计阅读时间与字数统计:
page.data.readingTime // { minutes: 3.2, words: 934 }
+你可以在 extendsPage 以及其他生命周期获取它做进一步处理:
export default {
+ // ...
+ extendsPage: (page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ },
+
+ onInitialized: (app) => {
+ app.pages.map((page) => {
+ page.data.readingTime // { minutes: 3.2, words: 934 }
+ })
+ },
+}
+在客户端侧获取数据
你可以从 @vuepress/plugin-reading-time/client 导入 useReadingTimeData 和 useReadingTimeLocale 来获取当前页面的阅读时间数据和语言环境数据：
<script setup lang="ts">
+import {
+ useReadingTimeData,
+ useReadingTimeLocale,
+} from '@vuepress/plugin-reading-time/client'
+
+const readingTimeData = useReadingTimeData() // { minutes: 1.1, words: 100 }
+const readingTimeLocale = useReadingTimeLocale() // { time: "1 分钟", words: "100 字" }
+</script>
+选项
wordPerMinute
- 类型：
number - 默认值：
300 - 详情： 每分钟阅读字数
locales
类型：
ReadingTimePluginLocaleConfiginterface ReadingTimePluginLocaleData { + /** + * 字数模板，模板中 `$word` 会被自动替换为字数 + */ + word: string + + /** + * 小于一分钟文字 + */ + less1Minute: string + + /** + * 时间模板 + */ + time: string +} + +interface ReadingTimePluginLocaleConfig { + [localePath: string]: ReadingTimePluginLocaleData +} +必填：否
详情：
阅读时间插件的国际化配置。
内置支持语言
- 简体中文 (zh-CN)
- 繁体中文 (zh-TW)
- 英文(美国) (en-US)
- 德语 (de-DE)
- 德语(澳大利亚) (de-AT)
- 俄语 (ru-RU)
- 乌克兰语 (uk-UA)
- 越南语 (vi-VN)
- 葡萄牙语(巴西) (pt-BR)
- 波兰语 (pl-PL)
- 法语 (fr-FR)
- 西班牙语 (es-ES)
- 斯洛伐克 (sk-SK)
- 日语 (ja-JP)
- 土耳其语 (tr-TR)
- 韩语 (ko-KR)
- 芬兰语 (fi-FI)
- 印尼语 (id-ID)
- 荷兰语 (nl-NL)
客户端 API
你可以从 @vuepress/plugin-reading-time/client 导入并使用这些 API：
即使插件被禁用，这些 API 也不会抛出错误。
useReadingTimeData
interface ReadingTime {
+ /** 分钟为单位的预计阅读时长 */
+ minutes: number
+ /** 内容的字数 */
+ words: number
+}
+
+const useReadingTimeData: () => ComputedRef<ReadingTime | null>
+当插件被禁用时会返回 null。
useReadingTimeLocale
interface ReadingTimeLocale {
+ /** 当前语言的预计阅读时间 */
+ time: string
+ /** 当前语言的字数文字 */
+ words: string
+}
+
+const useReadingTimeLocale: () => ComputedRef<ReadingTimeLocale>
+高级使用
由于此插件主要面向插件和主题开发者，所以提供了 "使用 API"：
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ useReadingTimePlugin(app, {
+ // 你的选项
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+为什么你应该使用 "使用 API"
当你多次注册一个插件时，vuepress 会给你一个警告，告诉你只有第一个插件会生效。
useReadingTimePlugin会自动检测插件是否已经注册，避免多次注册。如果你在
extendsPage生命周期访问阅读时间数据，那么@vuepress/plugin-reading-time必须在你的主题或插件之前被调用，否则你会得到未定义的page.data.readingTime。useReadingTimePlugin确保了@vuepress/plugin-reading-time在你的主题或插件之前被调用。
我们也提供了一个 removeReadingTimePlugin api 来移除插件。你可以使用它来确保你的调用生效或清除插件:
import { useReadingTimePlugin } from '@vuepress/plugin-reading-time'
+
+export default (options) => (app) => {
+ // 这会移除任何当前存在的阅读时间插件
+ removeReadingTimePlugin(app)
+
+ // 所以这会生效，即使之前已经注册了一个阅读时间插件
+ useReadingTimePlugin(app, {
+ // 你的选项
+ })
+
+ return {
+ name: 'vuepress-plugin-xxx', // or vuepress-theme-xxx
+ }
+}
+redirect
此插件提供页面与整站重定向功能。
使用方法
npm i -D @vuepress/plugin-redirect@next
+import { redirectPlugin } from '@vuepress/plugin-redirect'
+
+export default {
+ plugins: [
+ redirectPlugin({
+ // 配置项
+ }),
+ ],
+}
+设置重定向
如果你改动了已有页面的地址，你可以在 Frontmatter 中使用 redirectFrom 选项设置重定向到此页面的地址，这样可以保证用户在访问旧链接时重定向到新的地址。
如果你需要将已有的页面重定向到新的页面，可以在 Frontmatter 中使用 redirectTo 选项设置需要重定向到的地址。这样该页面会在访问时重定向到新的地址。
你还可以通过插件选项中的 config 设置一个重定向映射，详见 config。
自动多语言
插件可以根据用户的语言首选项，自动将无多语言链接重定向到用户需要的多语言页面。为了实现这一点，你需要留空默认的语言目录 (/)，并在插件选项中设置 autoLocale: true。插件会自动根据用户语言跳转到对应的语言页面。
也就是你需要设置以下目录结构:
.
+├── en
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+├── zh
+│ ├── ...
+│ ├── page.md
+│ └── README.md
+└── other_languages
+ ├── ...
+ ├── page.md
+ └── README.md
+并将主题选项的 locales 设置为:
export default {
+ locales: {
+ '/en/': {
+ lang: 'en-US',
+ // ...
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ // ...
+ },
+ // other languages
+ },
+ // ...
+}
+这样当用户访问 / 或 /page.html 时，他们会自动根据当前浏览器语言重定向到 /en/ /en/page.html 与 /zh/ /zh/page.html。
自定义回退行为
有些时候，用户可能会在系统设置中添加多个语言。默认情况下，在站点支持首选语言，但首选语言不存在相应页面时，插件会尝试匹配用户设置的备用语言。
如果不需要回退到用户备用语言，而直接匹配用户首选语言，请在插件选项中设置 localeFallback: false。
自定义缺失行为
有些时候，当用户访问一个页面时，文档尚未包含用户需要的语言版本 (一个普遍的情况是当前页面尚未完成相关语言的本地化)，这样插件需要做出默认行为，你可以通过插件选项中的 defaultBehavior 定制它:
"defaultLocale": 重定向到默认语言或首个可用语言页面 (默认行为)"homepage": 重定向到当前语言的主页 (仅在文档包含用户语言时可用)"404": 重定向到当前语言的 404 页 (仅在文档包含用户语言时可用)
自定义默认路径
你可以通过设置插件选项中的 defaultLocale 来自定义默认路径。默认情况下，插件会使用 locales 中的第一个键名作为默认路径。
自动切换语言
插件支持在多语言文档中，自动根据用户语言首选项，将链接切换到用户需要的多语言页面。为了实现这一点，你需要在插件选项中设置 switchLocale，它可以是以下两个值:
direct: 直接切换到用户语言首选项页面，而不询问modal: 在用户语言首选项与当前页面语言不同时，弹出一个对话框询问用户是否切换语言
自定义多语言配置
默认情况下，插件会从站点的多语言配置 locales 选项中，读取 语言路径 和 lang 生成多语言配置。有些时候，你可能希望多个语言命中同一个路径，这种情况下，你应该设置插件的 localeConfig 选项。
比如，你可能希望所有英文用户都匹配到 /en/，并将繁体中文用户匹配到 /zh/ 中，那么你可以设置:
redirect({
+ localeConfig: {
+ '/en/': ['en-US', 'en-UK', 'en'],
+ '/zh/': ['zh-CN', 'zh-TW', 'zh'],
+ },
+})
+重定向站点
有时你可能会更改 base 或为你的站点使用新域名，因此你可能希望原始站点自动重定向到新站点。
为了解决这个问题，插件提供了 vp-redirect 脚手架。
使用:
+ $ vp-redirect generate [源文件夹]
+
+Options:
+ --hostname <hostname> 重定向到的域名 (例如: https://new.example.com/) (默认: /)
+ -c, --config <config> 设置配置文件路径
+ -o, --output <output> 设置输出目录 (默认: .vuepress/redirect)
+ --cache <cache> 设置缓存文件的目录
+ -t, --temp <temp> 设置临时文件的目录
+ --clean-cache 生成前清理缓存文件
+ --clean-temp 生成前清理临时文件
+ -h, --help 显示此消息
+你需要传入 VuePress 项目源目录并设置 hostname 选项。重定向助手脚手架将初始化你的 VuePress 项目以获取页面，然后在输出目录生成重定向 html 文件。
默认情况下，插件将输出到源文件夹下的 .vuepress/redirect 目录。你应该将其上传到你的原始站点以提供重定向。
选项
config
类型：
Record<string, string> | ((app: App) => Record<string, string>)详情
页面重定向映射。
可直接传入对象或传入参数为
App的函数返回值一个对象。每个键名必须是一个绝对路径，代表重定向的源页面地址。
每个键值是重定向的目标地址，可以是绝对路径或完整路径。
示例：
当 base 为
/base/时：- 将
/base/foo.html重定向到/base/bar.html - 将
/base/baz.html重定向到https://example.com/qux.html。
redirect({ + config: { + '/foo.html': '/bar.html', + '/baz.html': 'https://example.com/qux.html', + }, +}) +将 post 文件夹的路径重定向到 posts 文件夹
redirect({ + hostname: 'https://example.com', + config: (app) => + Object.fromEntries( + app.pages + .filter(({ path }) => path.startsWith('/posts/')) + .map(({ path }) => [path.replace(/^\/posts\//, '/post/'), path]), + ), +}) +- 将
autoLocale
- 类型：
boolean - 默认值:
false - 详情： 是否启用语言重定向
- 参考：
switchLocale
类型：
"direct" | "modal" | false默认值:
false详情：
是否根据用户偏好切换到新的语言环境。
"direct": 直接重定向到新的语言环境而不询问"modal": 显示一个模式让用户选择是否切换到新的语言环境
localeConfig
- 类型：
Record<string, string | string[]> - 详情：多语言语言配置
localeFallback
- 类型：
boolean - 默认值:
true - 详情：是否回退到用户定义的其他语言
defaultBehavior
- 类型：
"defaultLocale" | "homepage" | "404" - 默认值:
"defaultLocale" - 详情：当前链接没有可用的语言版本时的行为
defaultLocale
- 类型：
string - 默认值: 首个语言路径
- 详情：默认语言路径
Frontmatter
redirectFrom
- 类型：
string | string[] - 详情：重定向到该页面的地址。
redirectTo
- 类型：
string - 详情：该页面重定向到的地址。
样式
你可以通过 CSS 变量来自定义重定向弹窗的样式：
:root {
+ --redirect-z-index: 1499;
+ --redirect-bg-color: #fff;
+ --redirect-bg-color-light: #f3f4f5;
+ --redirect-bg-color-lighter: #eeeeee;
+ --redirect-text-color: #2c3e50;
+ --redirect-primary-bg-color: #3eaf7c;
+ --redirect-primary-hover-bg-color: #4abf8a;
+ --redirect-primary-text-color: #fff;
+}
+register-components
根据组件文件或目录自动注册 Vue 组件。
使用方法
npm i -D @vuepress/plugin-register-components@next
+import { registerComponentsPlugin } from '@vuepress/plugin-register-components'
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
components
类型：
Record<string, string>默认值：
{}详情：
一个定义了组件名称和其对应文件路径的对象。
键会被用作组件名称，值是组件文件的绝对路径。
如果该配置项中的组件名称和 componentsDir 配置项发生冲突，那么该配置项会有更高的优先级。
示例：
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ components: {
+ FooBar: path.resolve(__dirname, './components/FooBar.vue'),
+ },
+ }),
+ ],
+}
+componentsDir
类型：
string | null默认值：
null详情：
组件目录的绝对路径。
该目录下匹配 componentsPatterns 的文件会被自动注册为 Vue 组件。
示例：
import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export default {
+ plugins: [
+ registerComponentsPlugin({
+ componentsDir: path.resolve(__dirname, './components'),
+ }),
+ ],
+}
+组件目录：
components
+├─ FooBar.vue
+└─ Baz.vue
+组件会像这样被注册：
import { defineAsyncComponent } from 'vue'
+
+app.component(
+ 'FooBar',
+ defineAsyncComponent(() => import('/path/to/components/FooBar.vue')),
+)
+
+app.component(
+ 'Baz',
+ defineAsyncComponent(() => import('/path/to/components/Baz.vue')),
+)
+componentsPatterns
类型：
string[]默认值：
['**/*.vue']详情：
使用 globby 来匹配组件文件的 Patterns 。
该 Patterns 是相对于 componentsDir 目录的。
getComponentName
类型：
(filename: string) => string默认值：
(filename) => path.trimExt(filename.replace(/\/|\\/g, '-'))详情：
用于从文件名获取对应组件名称的函数。
它只会对 componentsDir 目录下匹配了 componentsPatterns 的文件生效。
注意，这里的
filename是相对于 componentsPatterns 目录的文件路径。
remove-pwa
此插件从你的 VuePress 站点中删除任何相关的 Service Worker，因此如果你在启用后任何 PWA 插件后移除它们，用户仍然可以获得更新。
如果你启用过 PWA，为什么需要这个插件？
PWA 插件，如 @vuepress/plugin-pwa 将 Service Worker 注册到你的站点，这将缓存你的站点并使其离线可用。
但是，如果你删除 PWA 插件，先前的 Service Worker 仍将在那里，但它们永远无法获得更新，因为他们永远无法找到要更新的新 Service Worker。 因此，用户将继续使用你网站的旧版本。
要解决这个问题：
一个新的内容为空的 Service Worker 需要生成在原位置。
新的 Service Worker 应该尝试删除旧 Service Worker 缓存的内容，然后它应该注销自己。
使用方法
npm i -D @vuepress/plugin-remove-pwa@next
+import { removePwaPlugin } from '@vuepress/plugin-remove-pwa'
+
+export default {
+ plugins: [
+ removePwaPlugin({
+ // options
+ }),
+ ],
+}
+选项
cachePrefix
- 类型：
string - 默认值：
'workbox' - 详情：Service worker 的缓存前缀。
swLocation
- 类型：
string - 默认值：
'service-worker.js' - 详情：旧 Service Worker 的位置。
rtl
此插件会在配置的语言上设置 rtl 方向。
使用方法
npm i -D @vuepress/plugin-rtl@next
+import { rtlPlugin } from '@vuepress/plugin-rtl'
+
+export default {
+ plugins: [
+ rtlPlugin({
+ // 配置项
+ locales: ['/ar/'],
+ }),
+ ],
+}
+选项
locales
- 类型：
string[] - 默认值：
['/'] - 详情： 开启 RTL 布局的多语言路径。
selector
类型：
SelectorOptionsinterface SelectorOptions { + [element: string]: { + [attrs: string]: string + } +} +默认值：
{ 'html': { dir: 'rtl' } }详情：
开启 RTL 的选择器。
默认设置意味着在 RTL 多语言中，
html元素的dir属性将被设置为rtl。
search
为你的文档网站提供本地搜索能力。
提示
当你正确配置该插件后，默认主题会把搜索框添加到导航栏。
该插件不一定能在其他主题中直接使用，因此你应参考主题本身的文档来获取更多信息。
使用方法
npm i -D @vuepress/plugin-search@next
+import { searchPlugin } from '@vuepress/plugin-search'
+
+export default {
+ plugins: [
+ searchPlugin({
+ // 配置项
+ }),
+ ],
+}
+本地搜索索引
该插件会根据你的页面，在本地生成搜索索引，然后在用户访问站点时加载搜索索引文件。换句话说，这是一个轻量级的内置搜索能力，不会进行任何外部请求。
然而，当你的站点包含大量页面时，搜索索引文件也会变得非常大，它可能会拖慢你的页面加载速度。在这种情况下，我们建议你使用更成熟的解决方案 - docsearch 。
配置项
locales
类型：
Record<string, { placeholder: string }>详情：
搜索框在不同 locales 下的文字。
如果没有指定该配置项，它会降级使用默认文字。
示例：
export default {
+ plugins: [
+ searchPlugin({
+ locales: {
+ '/': {
+ placeholder: 'Search',
+ },
+ '/zh/': {
+ placeholder: '搜索',
+ },
+ },
+ }),
+ ],
+}
+- 参考：
hotKeys
- 类型：
(string | HotKeyOptions)[]
export interface HotKeyOptions {
+ /**
+ * Value of `event.key` to trigger the hot key
+ */
+ key: string;
+ /**
+ * Whether to press `event.altKey` at the same time
+ *
+ * @default false
+ */
+ alt?: boolean;
+ /**
+ * Whether to press `event.ctrlKey` at the same time
+ *
+ * @default false
+ */
+ ctrl?: boolean;
+ /**
+ * Whether to press `event.shiftKey` at the same time
+ *
+ * @default false
+ */
+ shift?: boolean;
+}
+默认值：
['s', '/']详情：
指定热键的 event.key 。
当按下热键时，搜索框会被聚焦。
将该配置项设为空数组可以禁用热键功能。
maxSuggestions
类型：
number默认值：
5详情：
指定搜索结果的最大条数。
isSearchable
类型：
(page: Page) => boolean默认值：
() => true详情：
一个函数，用于判断一个页面是否应该被包含在搜索索引中。
- 返回
true来包含该页面。 - 返回
false来排除该页面。
- 返回
示例：
export default {
+ plugins: [
+ searchPlugin({
+ // 排除首页
+ isSearchable: (page) => page.path !== '/',
+ }),
+ ],
+}
+getExtraFields
类型：
(page: Page) => string[]默认值：
() => []详情：
一个函数，用于在页面的搜索索引中添加额外字段。
默认情况下，该插件会将页面标题和小标题作为搜索索引。该配置项可以帮助你添加更多的可搜索字段。
示例：
export default {
+ plugins: [
+ searchPlugin({
+ // 允许搜索 Frontmatter 中的 `tags`
+ getExtraFields: (page) => page.frontmatter.tags ?? [],
+ }),
+ ],
+}
+样式
你可以通过 CSS 变量来自定义搜索框的样式：
:root {
+ --search-bg-color: #ffffff;
+ --search-accent-color: #3eaf7c;
+ --search-text-color: #2c3e50;
+ --search-border-color: #eaecef;
+ --search-item-text-color: #5d81a5;
+ --search-item-focus-bg-color: #f3f4f5;
+ --search-input-width: 8rem;
+ --search-result-width: 20rem;
+}
+组件
SearchBox
详情：
该插件会全局注册一个
<SearchBox />组件，你可以不传入任何 Props 来使用它。将该组件放置在你想要显示搜索框的地方。例如，默认主题将这个组件放在了导航栏的末尾。
提示
该组件主要用于主题开发。在大多数情况下你不需要直接使用该组件。
选项
hostname
类型：
string必填：是
详情：
部署域名
author
类型：
Authortype AuthorName = string + +interface AuthorInfo { + /** + * 作者姓名 + */ + name: string + + /** + * 作者网站 + */ + url?: string + + /** + * 作者 Email + */ + email?: string +} + +type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[] +详情：
默认作者
autoDescription
类型：
boolean默认值：
true详情：
是否自动生成描述
canonical
类型：
string | ((page: Page) => string | null)详情：
首选链接
fallBackImage
类型：
string详情：
当找不到图片时的回退图片链接
restrictions
类型：
string详情：
内容的年龄分级，格式为
[int]+，如"13+"
twitterID
类型：
string详情：
你的 twitter 用户名
isArticle
类型：
(page: Page) => boolean详情：
你可以使用此选项判断一个页面是否是文章。
ogp
类型：
function ogp( + /** 插件推断的 OGP 信息 */ + ogp: SeoContent, + /** 页面对象 */ + page: Page, + /** VuePress App */ + app: App, +): SeoContent +详情：
自定义 OGP 生成器
你可以使用此选项来注入新的或覆盖掉默认生成的 OGP 标签。
jsonLd
类型：
function jsonLd( + /** 由插件推断出的 JSON-LD 对象 */ + jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema, + /** 页面对象 */ + page: Page, + /** VuePress App */ + app: App, +): ArticleSchema | BlogPostingSchema | WebPageSchema +详情：
自定义 JSON-LD 生成器
你可以使用此选项来注入新的或覆盖掉默认生成的 JSON-LD 标签。
customHead
类型：
function customHead( + /** head 标签配置 */ + head: HeadConfig[], + /** 页面对象 */ + page: Page, + /** VuePress App */ + app: App, +): void +详情：
你可以使用此选项来直接注入任意格式的标签到
<head>。
指南
本插件会通过向网站 <head> 注入标签，让你的网站完全支持 开放内容协议 OGP 和 JSON-LD 1.1，以全面增强站点的搜索引擎优化性。
开箱即用
插件开箱即用，在不做任何配置的情况下，会尽可能通过页面内容，提取对应的信息补全 OGP 与 JSON-LD 所需的必要标签。
默认情况下，插件会读取站点配置、主题配置与页面的 frontmatter 来尽可能自动生成。诸如站点名称，页面标题，页面类型，写作日期，最后更新日期，文章标签均会自动生成。
默认的 OGP 生成逻辑
| 属性名称 | 值 |
|---|---|
og:url | options.hostname + path |
og:site_name | siteConfig.title |
og:title | page.title |
og:description | page.frontmatter.description || 自动生成 (当插件选项中的 autoDescription 为 true 时) |
og:type | "article" |
og:image | options.hostname + page.frontmatter.image || 页面的第一张图片|| 插件选项的 fallbackImage |
og:updated_time | page.git.updatedTime |
og:locale | page.lang |
og:locale:alternate | siteData.locales 包含的其他语言 |
twitter:card | "summary_large_image" (仅在找到图片时) |
twitter:image:alt | page.title (仅在找到图片时) |
article:author | page.frontmatter.author || options.author |
article:tag | page.frontmatter.tags || page.frontmatter.tag |
article:published_time | page.frontmatter.date || page.git.createdTime |
article:modified_time | page.git.updatedTime |
默认的 JSON-LD 生成逻辑
| 属性名 | 值 |
|---|---|
@context | "https://schema.org" |
@type | "NewsArticle" |
headline | page.title |
image | 页面中的图片|| options.hostname + page.frontmatter.image |
datePublished | page.frontmatter.date || page.git.createdTime |
dateModified | page.git.updatedTime |
author | page.frontmatter.author || options.author |
直接添加 head 标签
你可以在页面的 frontmatter 中配置 head 选项，自主添加特定标签到页面 <head> 以增强 SEO。
如:
---
+head:
+ - - meta
+ - name: keywords
+ content: SEO plugin
+---
+会自动注入 <meta name="keywords" content="SEO plugin" />。
自定义生成过程
本插件也支持你完全控制生成逻辑。
页面类型
对于大多数页面，基本只有文章和网页两种类型，所以插件提供了 isArticle 选项让你提供辨别文章的逻辑。
选项接受一个 (page: Page) => boolean 格式的函数，默认情况下从 Markdown 文件生成的非主页页面都会被视为文章。
提示
如果某个网页的确符合图书、音乐之类的“冷门”类型，你可以通过设置下方三个选项处理它们。
OGP
你可以使用插件选项的 ogp 传入一个函数来按照你的需要修改默认 OGP 对象并返回。
function ogp(
+ /** 插件推断的 OGP 信息 */
+ ogp: SeoContent,
+ /** 页面对象 */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): SeoContent
+详细的参数结构详见 配置。
比如你在使用某个第三方主题，并按照主题要求为每篇文章在 Front Matter 中设置了 banner，那你可以传入这样的 ogp:
seoPlugin({
+ ogp: (ogp, page) => ({
+ ...ogp,
+ 'og:image': page.frontmatter.banner || ogp['og:image'],
+ }),
+})
+JSON-LD
同 OGP，你可以使用插件选项的 jsonLd 传入一个函数来按照你的需要修改默认 JSON-LD 对象并返回。
function jsonLd(
+ /** 由插件推断出的 JSON-LD 对象 */
+ jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema,
+ /** 页面对象 */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): ArticleSchema | BlogPostingSchema | WebPageSchema
+规范链接
如果你将内容部署到不同的站点，或不同 URL 下的相同内容，你可能需要设置 canonical 选项为你的页面提供 “规范链接”。 你可以设置一个字符串，这样它会附加在页面路由链接之前，或者添加一个自定义函数 (page: Page) => string | null 返回规范链接。
例子
如果你的站点部署在 example.com 的 docs 文件夹下，但同时在下列网址中可用:
http://example.com/docs/xxxhttps://example.com/docs/xxxhttp://www.example.com/docs/xxxhttps://www.example.com/docs/xxx(首选)
要让搜索引擎结果始终是首选，你可能需要将 canonical 设置为 https://www.example.com/docs/，以便搜索引擎知道首选第四个 URL 作为索引结果。
自定义 head 标签
有些时候你可能需要符合其他协议或按照其他搜索引擎提供的格式提供对应的 SEO 标签，此时你可以使用 customHead 选项，其类型为:
function customHead(
+ /** head 标签配置 */
+ head: HeadConfig[],
+ /** 页面对象 */
+ page: Page,
+ /** VuePress App */
+ app: App,
+): void
+你应该直接修改传入的 head 参数。
SEO 介绍
搜索引擎优化 (Search Engine Optimization)，是一种透过了解搜索引擎的运作规则来调整网站，以及提高目的网站在有关搜索引擎内排名的方式。由于不少研究发现，搜索引擎的用户往往只会留意搜索结果最前面的几个条目，所以不少网站都希望透过各种形式来影响搜索引擎的排序，让自己的网站可以有优秀的搜索排名。 所谓“针对搜索引擎作最优化的处理”，是指为了要让网站更容易被搜索引擎接受。搜索引擎会将网站彼此间的内容做一些相关性的资料比对，然后再由浏览器将这些内容以最快速且接近最完整的方式，呈现给搜索者。搜索引擎优化就是通过搜索引擎的规则进行优化，为用户打造更好的用户体验，最终的目的就是做好用户体验。
相关文档
开放内容协议 OGP (Open Graph Protocal)
本插件完美支持该协议，会自动生成符合该协议的
<meta>标签。本插件会为文章类页面生成 NewsArticle 类标签。
RDFa 主要标记 HTML 结构。这是插件无法支持的内容， 使用了这一功能通过了谷歌的富媒体结构测试。你可以考虑搭配使用。
结构标记的 Schema 定义站点
相关工具
你可以使用 Google 富媒体结构测试工具 测试本站点。
+
+
+
diff --git a/zh/plugins/shiki.html b/zh/plugins/shiki.html
new file mode 100644
index 0000000000..7f14bf9a47
--- /dev/null
+++ b/zh/plugins/shiki.html
@@ -0,0 +1,48 @@
+
+
+
+
+
+
+
+
+
shiki
该插件使用 Shiki 来为 Markdown 代码块启用代码高亮。
提示
Shiki 是 VSCode 正在使用的代码高亮器。它具有更高的保真度，但可能会比 Prism.js 要慢一些，特别是在有大量代码块需要处理的时候。
你可以考虑在 dev 模式下禁用该插件来获取更好的开发体验。
使用方法
npm i -D @vuepress/plugin-shiki@next
+import { shikiPlugin } from '@vuepress/plugin-shiki'
+
+export default {
+ plugins: [
+ shikiPlugin({
+ // 配置项
+ langs: ['ts', 'json', 'vue', 'md', 'bash', 'diff'],
+ }),
+ ],
+}
+配置项
langs
类型：
ShikiLang[]详情：
Shiki 要解析的代码块的语言。
该配置项会被传递到 Shiki 的
getHighlighter()方法中。你最好明确传入所有你使用的语言列表，否则 Shiki 会加载所有语言，并可能影响性能。
参考：
theme
类型：
ShikiTheme默认值：
'nord'详情：
Shiki 的主题。
该配置项会被传递到 Shiki 的
codeToHtml()方法中。参考：
themes
类型：
Record<'dark' | 'light', ShikiTheme>详情：
Shiki 的暗黑和明亮模式双主题。
该配置项会被传递到 Shiki 的
codeToHtml()方法中。参考：
配置
hostname
类型：
string必填：是
详情：
当前网站部署到的域名，插件需要此选项才能工作。
extraUrls
类型：
string[]详情：
需要额外包含的网址。
如果你有一些不包含在 VuePress 路由中的链接 (如: 存放在 public 文件夹下的页面或其他插件或工具直接生成的页面)，你可能需要设置此项。
示例：
['/about.html', '/api/']
excludePaths
类型：
string[]默认值：
['/404.html']详情：
不需要收录的页面路径，请以绝对路径开头。
默认情况下 VuePress 自动生成的所有路径 (除 404 页) 都会被添加进 Sitemap。
devServer
类型：
boolean默认值：
false详情：
是否在开发服务器中启用
提示
由于性能原因，我们不提供热更新。重启开发服务器以同步你的变更。
devHostname
类型：
string默认值：
"http://localhost:${port}"详情：
开发服务器使用的主机名
sitemapFilename
类型：
string默认值：
"sitemap.xml"详情：
输出的文件名，相对于输出目录。
sitemapXSLFilename
类型：
string默认值：
"sitemap.xsl"详情：
输出的 xsl 文件名，相对于输出目录。
sitemapXSLTemplate
类型：
string默认值：
"@vuepress-plugin/sitemap/templates/sitemap.xsl"详情：
用作模板的 XSL 文件内容
changefreq
类型：
"always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"默认值：
"daily"详情：
页面默认更新频率，会被 Frontmatter 中的 changefreq 选项覆盖。
priority
类型：
number默认值：
0.5详情：
页面优先级，范围
0至1。
modifyTimeGetter
类型：
(page: Page, app: App) => string详情：
最后修改事件的获得器，需要返回一个 ISO 字符形式的时间，默认会自动通过 Git 插件生成。
Frontmatter
sitemap
类型：
SitemapFrontmatterOptions | false详情：
false表示将页面排除在 sitemap 之外。
sitemap.changefreq
类型：
"always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"默认值：
"daily"详情：
页面默认更新频率。它会覆盖插件选项中的 changefreq 选项。
sitemap.priority
类型：
number默认值：
0.5详情：
页面优先级，范围
0至1。
指南
本插件会为你的网站自动生成 Sitemap。为了使插件正常工作，你需要将部署的域名传递给插件的 hostname 选项。如果你想在开发服务器中预览，请配置 devServer 选项。
插件会自动根据页面的 Git 的时间戳生成页面的最后更新时间，同时会根据站点的多语言配置声明页面的其他语言版本替代地址。
控制 Sitemap 链接
默认情况下，所有除 404 页面以外的网站链接均会被添加进 Sitemap。
如果你希望在 VuePress 项目页面之外，添加其他页面链接到 Sitemap，请将它们变成数组传入插件的 extraUrls 选项。
如果你需要排除一些页面路径，你可以将它们变成数组传入到插件的 excludePaths 选项。你也可以在对应页面的 frontmatter 中，设置 sitemap 为 false。
输出位置
你还可以通过插件的 sitemapFilename 选项控制输出的地址，此地址相对于输出目录，默认为 sitemap.xml。
更新周期
页面默认的更新周期是 daily (每天)，如果你希望修改全部的页面周期，请在插件选项中设置 changefreq 。你也可以在页面的 frontmatter 中设置 sitemap.changefreq，页面具有更高的优先级。
合法的频率有:
"always""hourly""daily""weekly""monthly""yearly""never"
优先级
你可以在插件中设置 priority 以提供一个默认值。同时你可以通过 frontmatter 中的 sitemap.priority 来为每个页面设置优先级。可接受的值为 0 到 1 的浮点数。
修改时间获取
你可以通过插件的 modifyTimeGetter 来返回一个 ISO 字符串格式的时间，默认会通过 Git 插件生成。
以下是一个基于文件最后修改时间的例子。
// 基于文件最后修改时间
+({
+ modifyTimeGetter: (page, app) =>
+ fs.statSync(app.dir.source(page.filePathRelative)).mtime.toISOString();
+})
+Sitemap 介绍
网站地图 (Sitemap) 提供搜索引擎优化 (SEO):
- 为搜索引擎爬虫提供可以浏览整个网站的链接；
- 为搜索引擎爬虫提供一些链接，指向动态页面或者采用其他方法比较难以到达的页面；
- 如果访问者试图访问网站所在域内并不存在的 URL，那么这个访问者就会被转到“无法找到文件”的错误页面，而网站地图可以作为导航页。
网站地图通过使所有页面可被找到来增强搜索引擎优化的效果。
大部分搜索引擎只跟踪页面内有限数量的链接，因此当网站非常大的时候，网站地图对于使搜索引擎和访问者可以访问网站中的所有内容就变得必不可少了。
Sitemaps 是站点管理员向搜索引擎爬虫公布站点可被抓取页面的协议，sitemap 文件内容必须遵循 XML 格式的定义。每个 URL 可以包含更新的周期和时间、URL 在整个站点中的优先级。这样可以让搜索引擎更佳有效的抓取网站内容。
同步配置 robots.txt
由于 Sitemap 面向搜索引擎，配合此插件使用时，你最好保证你在 .vuepress/public 文件夹下放置了有效的 robots.txt，以允许搜索引擎收录。一个最简单的 robots.txt 如下 (允许所有搜索引擎访问所有路径)
User-agent: *
+
+Allow: /
+
+
+
+
diff --git a/zh/plugins/theme-data.html b/zh/plugins/theme-data.html
new file mode 100644
index 0000000000..eea680b0a6
--- /dev/null
+++ b/zh/plugins/theme-data.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+
+
theme-data
为你的主题提供客户端数据，包含 VuePress 的 多语言支持 。
该插件主要用于开发主题，并且已经集成到默认主题中。大部分情况下你不需要直接使用它。
对于主题作者，该插件可以提供与 VuePress 及默认主题相同的多语言支持机制。但是如果你的主题不需要提供多语言支持，或者你想用你自己的方式来实现多语言支持，那么你不需要使用该插件。
使用方法
npm i -D @vuepress/plugin-theme-data@next
+import { themeDataPlugin } from '@vuepress/plugin-theme-data'
+
+export default {
+ plugins: [
+ themeDataPlugin({
+ // 配置项
+ }),
+ ],
+}
+配置项
themeData
类型：
ThemeData默认值：
{}详情：
你希望在 Client 端中使用的主题数据对象。
你可以通过该配置项，在 Node 端提供主题数据，然后在客户端通过 useThemeData 和 useThemeLocaleData 来使用主题数据。
示例：
export default {
+ plugins: [
+ themeDataPlugin({
+ themeData: {
+ foo: 'foo',
+ locales: {
+ '/zh/': {
+ foo: 'zh-foo',
+ },
+ },
+ },
+ }),
+ ],
+}
+注意
主题数据对象在传递到客户端之前，会使用 JSON.stringify() 进行处理，因此你需要保证你提供的是一个可以被 JSON 序列化的对象。
Composition API
useThemeData
详情：
返回主题数据的 Ref 对象。
数据是通过 themeData 配置项提供的。
示例：
import { useThemeData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeData = useThemeData<MyThemeData>()
+ console.log(themeData.value)
+ },
+}
+useThemeLocaleData
详情：
返回当前 locale 下主题数据的 Ref 对象。
当前 locale 中的字段已被合并到顶层字段中。
示例：
import { useThemeLocaleData } from '@vuepress/plugin-theme-data/client'
+import type { ThemeData } from '@vuepress/plugin-theme-data/client'
+
+type MyThemeData = ThemeData<{
+ foo: string
+}>
+
+export default {
+ setup() {
+ const themeLocaleData = useThemeLocaleData<MyThemeData>()
+ console.log(themeLocaleData.value)
+ },
+}
+toc
该插件会提供一个目录 (table-of-contents, TOC) 组件。
使用方法
npm i -D @vuepress/plugin-toc@next
+import { tocPlugin } from '@vuepress/plugin-toc'
+
+export default {
+ plugins: [
+ tocPlugin({
+ // 配置项
+ }),
+ ],
+}
+与 Markdown 目录语法的区别
与 Markdown 目录语法 类似，该插件提供的目录组件可以直接在你的 Markdown 内容中使用：
<!-- Markdown 目录语法 -->
+
+[[toc]]
+
+<!-- Vue 目录组件 -->
+<Toc />
+在 Build 模式中，它们都可以被正确地预渲染。然而，它们之间存在一些区别。
Markdown 语法 [[toc]] 仅能在 Markdown 文件中使用。它是由 markdown-it 解析的，生成的目录是静态内容。
组件 <Toc/> 既可以用在 Markdown 文件中，也可以用在 Vue 文件中。它是由 Vue 加载的，生成的目录是一个 Vue 组件。
该插件可以和 @vuepress/plugin-active-header-links 协同工作，你只需要将 headerLinkSelector 与该插件的 linkClass 匹配即可。当页面滚动至某个标题锚点后，对应的链接就会被加上 linkActiveClass 类名。
因此，该插件对于主题开发者来说更为有用。
配置项
componentName
类型：
string默认值：
'Toc'详情：
指定目录组件的名称。
defaultPropsOptions
类型：
Partial<TocPropsOptions>默认值：
{}详情：
覆盖组件 options Prop 的默认值。
组件 Props
目录组件可以通过 Props 来进行自定义。
<template>
+ <Toc :headers="headers" :options="options" />
+</template>
+headers
- 类型：
PageHeader[]
interface PageHeader {
+ level: number
+ title: string
+ slug: string
+ children: PageHeader[]
+}
+详情：
指定要渲染的标题数组。
如果该 Prop 没有被设置，默认会使用当前页面的标题。
options
- 类型：
Partial<TocPropsOptions>
interface TocPropsOptions {
+ containerTag: string
+ containerClass: string
+ listClass: string
+ itemClass: string
+ linkTag: 'a' | 'RouterLink' | 'RouteLink'
+ linkClass: string
+ linkActiveClass: string
+ linkChildrenActiveClass: string
+}
+默认值：
下列默认值可以用过 defaultPropsOptions 来覆盖：
const defaultOptions = {
+ containerTag: 'nav',
+ containerClass: 'vuepress-toc',
+ listClass: 'vuepress-toc-list',
+ itemClass: 'vuepress-toc-item',
+ linkTag: 'RouteLink',
+ linkClass: 'vuepress-toc-link',
+ linkActiveClass: 'active',
+ linkChildrenActiveClass: 'active',
+}
+详情：
自定义目录组件。
如果
containerTag设置为空字符串''，那么最外层的<nav>Container 会被完全移除。示例：
使用默认 options 的目录组件的渲染结果类似以下结构：
<template>
+ <!-- container -->
+ <nav class="vuepress-toc">
+ <!-- list -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link -->
+ <RouteLink class="vuepress-toc-link" to="#foo">Foo</RouteLink>
+ </li>
+ <!-- item with children -->
+ <li class="vuepress-toc-item">
+ <!-- link (children active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar">Bar</RouteLink>
+ <!-- list (children) -->
+ <ul class="vuepress-toc-list">
+ <!-- item -->
+ <li class="vuepress-toc-item">
+ <!-- link (active) -->
+ <RouteLink class="vuepress-toc-link active" to="#bar-child">
+ Bar Child
+ </RouteLink>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </nav>
+</template>
+内置组件
Badge badge
Props:
- type
- 类型：
'tip' | 'warning' | 'danger' - 默认值：
'tip'
- 类型：
- text
- 类型：
string - 默认值：
''
- 类型：
- vertical
- 类型：
'top' | 'middle' | 'bottom' | undefined - 默认值：
undefined
- 类型：
- type
示例：
输入
- VuePress - <Badge type="tip" text="v2" vertical="top" />
+- VuePress - <Badge type="warning" text="v2" vertical="middle" />
+- VuePress - <Badge type="danger" text="v2" vertical="bottom" />
+输出
- VuePress - v2
- VuePress - v2
- VuePress - v2
CodeGroup
详情：
CodeGroupItem 组件的 Wrapper 。
CodeGroupItem
Props:
- title
- 类型：
string - 是否必需：
true
- 类型：
- active
- 类型：
boolean - 默认值：
false
- 类型：
- title
详情：
该组件必须放置在 CodeGroup 组件的内部。
可以通过
activeProp 来设置初始激活的元素。如果不设置，默认激活第一个元素。示例：
输入
<CodeGroup>
+ <CodeGroupItem title="pnpm">
+
+```bash:no-line-numbers
+pnpm install
+```
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="yarn">
+
+```bash:no-line-numbers
+yarn install
+```
+
+ </CodeGroupItem>
+
+ <CodeGroupItem title="npm" active>
+
+```bash:no-line-numbers
+npm install
+```
+
+ </CodeGroupItem>
+</CodeGroup>
+输出
pnpm install
+yarn install
+npm install
+注意
你必须在 <CodeGroupItem> 的开始标签和代码块之间添加一个空行，否则代码块无法被 Markdown 正确解析。
所有内容首先都必须是合法的 Markdown ，然后才是一个 Vue SFC 。
了解更多： Cookbook > Markdown 与 Vue SFC
或者你可以选择使用 自定义容器 。
配置
基础配置
hostname
类型：
string详情：
部署的域名，例如
https://example.com
locales
类型：
{ [path: string]: Partial<DefaultThemeLocaleData> }默认值：
{}详情：
多语言支持的各个语言 locales 。
所有在 Locale 配置 章节内的配置项都可以在 locales 中使用。
该配置项仅能在默认主题内生效，注意不要和 站点配置 中的
locales混淆。参考：
Locale 配置
该章节内的配置项可以作为一般配置使用，也可以使用在 locales 内。
colorMode
类型：
'auto' | 'light' | 'dark'默认值：
'auto'详情：
默认颜色模式。
如果设置为
'auto'，则会根据 prefers-color-scheme 自动设置初始颜色模式。参考：
colorModeSwitch
类型：
boolean默认值：
true详情：
是否启用切换颜色模式的功能。
如果设置为
true，将会在导航栏展示一个切换颜色模式的按钮。参考：
home
类型：
string默认值：
/详情：
首页的路径。
它将被用于：
- 导航栏中 Logo 的链接
- 404 页面的 返回首页 链接
navbar
类型：
false | (NavbarItem | NavbarGroup | string)[]默认值：
[]详情：
导航栏配置。
设置为
false可以禁用导航栏。为了配置导航栏元素，你可以将其设置为 导航栏数组 ，其中的每个元素是
NavbarItem对象、NavbarGroup对象、或者字符串：NavbarItem对象应该有一个text字段和一个link字段，还有一个可选的activeMatch字段。NavbarGroup对象应该有一个text字段和一个children字段。children字段同样是一个 导航栏数组 。- 字符串应为目标页面文件的路径。它将会被转换为
NavbarItem对象，将页面标题作为text，将页面路由路径作为link。
示例 1：
export default {
+ theme: defaultTheme({
+ navbar: [
+ // NavbarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ },
+ // NavbarGroup
+ {
+ text: 'Group',
+ children: ['/group/foo.md', '/group/bar.md'],
+ },
+ // 字符串 - 页面文件路径
+ '/bar/README.md',
+ ],
+ }),
+}
+- 示例 2：
export default {
+ theme: defaultTheme({
+ navbar: [
+ // 嵌套 Group - 最大深度为 2
+ {
+ text: 'Group',
+ children: [
+ {
+ text: 'SubGroup',
+ children: ['/group/sub/foo.md', '/group/sub/bar.md'],
+ },
+ ],
+ },
+ // 控制元素何时被激活
+ {
+ text: 'Group 2',
+ children: [
+ {
+ text: 'Always active',
+ link: '/',
+ // 该元素将一直处于激活状态
+ activeMatch: '/',
+ },
+ {
+ text: 'Active on /foo/',
+ link: '/not-foo/',
+ // 该元素在当前路由路径是 /foo/ 开头时激活
+ // 支持正则表达式
+ activeMatch: '^/foo/',
+ },
+ ],
+ },
+ ],
+ }),
+}
+logo
类型：
null | string详情：
Logo 图片的 URL。
Logo 图片将会显示在导航栏的左端。
设置为
null可以禁用 Logo 。示例：
export default {
+ theme: defaultTheme({
+ // Public 文件路径
+ logo: '/images/hero.png',
+ // URL
+ logo: 'https://vuejs.org/images/logo.png',
+ }),
+}
+logoDark
类型：
null | string详情：
在夜间模式中使用的 Logo 图片的 URL。
如果你想在夜间模式中使用不同的 Logo 图片，就可以使用该配置项。
设置为
null可以在夜间模式下禁用 Logo 。忽略该配置项将会在夜间模式中使用 logo 配置。参考：
logoAlt
类型：
null | string详情：
指定 Logo 图片的替代文字。
当未指定时，将默认与站点标题相同。
repo
类型：
string详情：
项目仓库的 URL。
它将被用作 仓库链接 的链接。仓库链接 将会显示为导航栏的最后一个元素。
export default {
+ theme: defaultTheme({
+ // 如果你按照 `organization/repository` 的格式设置它
+ // 我们会将它作为一个 GitHub 仓库
+ repo: 'vuejs/vuepress',
+ // 你也可以直接将它设置为一个 URL
+ repo: 'https://gitlab.com/foo/bar',
+ }),
+}
+sidebar
类型：
false | 'auto' | SidebarConfigArray | SidebarConfigObject默认值：
'auto'详情：
侧边栏配置。
你可以通过页面的 sidebar frontmatter 来覆盖这个全局配置。
设置为
false可以禁用侧边栏。如果你设置为
'auto'，侧边栏会根据页面标题自动生成。为了手动配置侧边栏元素，你可以将其设置为 侧边栏数组 ，其中的每个元素是一个
SidebarItem对象或者一个字符串：SidebarItem对象应该有一个text字段，有一个可选的link字段、一个可选的children字段和一个可选的collapsible字段。children字段同样是一个 侧边栏数组 。collapsible字段来控制它是否可折叠。- 字符串应为目标页面文件的路径。它将会被转换为
SidebarItem对象，将页面标题作为text，将页面路由路径作为link，并根据页面小标题自动生成children。
如果你想在不同子路径中使用不同的侧边栏，你可以将该配置项设置为 侧边栏对象 ：
- Key 为路径前缀。
- Value 为 侧边栏数组 或
"heading"以自动为相应路径生成基于标题的侧边栏。
示例 1：
export default {
+ theme: defaultTheme({
+ // 侧边栏数组
+ // 所有页面会使用相同的侧边栏
+ sidebar: [
+ // SidebarItem
+ {
+ text: 'Foo',
+ link: '/foo/',
+ children: [
+ // SidebarItem
+ {
+ text: 'github',
+ link: 'https://github.com',
+ children: [],
+ },
+ // 字符串 - 页面文件路径
+ '/foo/bar.md',
+ ],
+ },
+ // 字符串 - 页面文件路径
+ '/bar/README.md',
+ ],
+ }),
+}
+- 示例 2：
export default {
+ theme: defaultTheme({
+ // 侧边栏对象
+ // 不同子路径下的页面会使用不同的侧边栏
+ sidebar: {
+ '/guide/': [
+ {
+ text: 'Guide',
+ children: ['/guide/introduction.md', '/guide/getting-started.md'],
+ },
+ ],
+ '/reference/': 'heading',
+ },
+ }),
+}
+- 示例 3：
export default {
+ theme: defaultTheme({
+ // 可折叠的侧边栏
+ sidebar: {
+ '/reference/': [
+ {
+ text: 'VuePress Reference',
+ collapsible: true,
+ children: ['/reference/cli.md', '/reference/config.md'],
+ },
+ {
+ text: 'Bundlers Reference',
+ collapsible: true,
+ children: [
+ '/reference/bundler/vite.md',
+ '/reference/bundler/webpack.md',
+ ],
+ },
+ ],
+ },
+ }),
+}
+sidebarDepth
类型：
number默认值：
2详情：
设置根据页面标题自动生成的侧边栏的最大深度。
- 设为
0来禁用所有级别的页面标题。 - 设为
1来包含<h2>标题。 - 设为
2来包含<h2>和<h3>标题。 - ...
最大值取决于你通过 markdown.headers.level 提取了哪些级别的标题。
由于
markdown.headers.level的默认值是[2, 3]，因此sidebarDepth的默认最大值是2。你可以通过页面的 sidebarDepth frontmatter 来覆盖这个全局配置。
- 设为
editLink
类型：
boolean默认值：
true详情：
是否启用 编辑此页 链接。
你可以通过页面的 editLink frontmatter 来覆盖这个全局配置。
editLinkPattern
类型：
string详情：
编辑此页 链接的 Pattern 。
它将会用于生成 编辑此页 的链接。
如果你不设置该选项，则会根据 docsRepo 配置项来推断 Pattern 。但是如果你的文档仓库没有托管在常用的平台上，比如 GitHub 、 GitLab 、 Bitbucket 、 Gitee 等，那么你必须设置该选项才能使 编辑此页 链接正常工作。
用法：
Pattern 描述 :repo文档仓库 URL ，即 docsRepo :branch文档仓库分支 ，即 docsBranch :path页面源文件的路径，即 docsDir 拼接上页面文件的相对路径 示例：
export default {
+ theme: defaultTheme({
+ docsRepo: 'https://gitlab.com/owner/name',
+ docsBranch: 'master',
+ docsDir: 'docs',
+ editLinkPattern: ':repo/-/edit/:branch/:path',
+ }),
+}
+则会生成类似于 'https://gitlab.com/owner/name/-/edit/master/docs/path/to/file.md' 的链接。
docsRepo
类型：
string详情：
文档源文件的仓库 URL 。
它将会用于生成 编辑此页 的链接。
如果你不设置该选项，则默认会使用 repo 配置项。但是如果你的文档源文件是在一个不同的仓库内，你就需要设置该配置项了。
docsBranch
类型：
string默认值：
'main'详情：
文档源文件的仓库分支。
它将会用于生成 编辑此页 的链接。
docsDir
类型：
string默认值：
''详情：
文档源文件存放在仓库中的目录名。
它将会用于生成 编辑此页 的链接。
lastUpdated
类型：
boolean默认值：
true详情：
是否启用 最近更新时间戳 。
你可以通过页面的 lastUpdated frontmatter 来覆盖这个全局配置。要注意的是，如果你已经将该选项设为了
false，那么这个功能会被完全禁用，并且无法在 locales 或页面 frontmatter 中启用。
contributors
类型：
boolean默认值：
true详情：
是否启用 贡献者列表 。
你可以通过页面的 contributors frontmatter 来覆盖这个全局配置。要注意的是，如果你已经将该选项设为了
false，那么这个功能会被完全禁用，并且无法在 locales 或页面 frontmatter 中启用。
继承
VuePress 默认主题有着大量的用户，因此我们对它进行了一些便于继承的设计，以便用户轻松进行定制化。
布局插槽
默认主题的 Layout 布局提供了一些插槽：
navbarnavbar-beforenavbar-aftersidebarsidebar-topsidebar-bottompagepage-toppage-bottompage-content-toppage-content-bottom
在它们的帮助下，你可以很容易地添加或替换内容。下面通过一个示例来介绍一下如何使用布局插槽来继承默认主题。
首先，创建一个客户端配置文件 .vuepress/client.ts ：
import { defineClientConfig } from 'vuepress/client'
+import Layout from './layouts/Layout.vue'
+
+export default defineClientConfig({
+ layouts: {
+ Layout,
+ },
+})
+接下来，创建 .vuepress/layouts/Layout.vue ，并使用由默认主题的 Layout 布局提供的插槽：
<script setup>
+import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
+</script>
+
+<template>
+ <ParentLayout>
+ <template #page-bottom>
+ <div class="my-footer">This is my custom page footer</div>
+ </template>
+ </ParentLayout>
+</template>
+
+<style lang="css">
+.my-footer {
+ text-align: center;
+}
+</style>
+此时默认的 Layout 布局已经被你的本地布局覆盖，将会在除了首页外的所有页面添加一个自定义的页脚：
组件替换
布局插槽十分实用，但有时候你可能会觉得它不够灵活。默认主题同样提供了替换单个组件的能力。
默认主题将所有 非全局的组件 都注册了一个带 @theme 前缀的 alias 。例如，HomeFooter.vue 的别名是 @theme/HomeFooter.vue 。
接下来，如果你想要替换 HomeFooter.vue 组件，只需要在配置文件 .vuepress/config.ts 中覆盖这个别名即可：
import { defaultTheme } from '@vuepress/theme-default'
+import { getDirname, path } from 'vuepress/utils'
+import { defineUserConfig } from 'vuepress'
+
+const __dirname = getDirname(import.meta.url)
+
+export default defineUserConfig({
+ theme: defaultTheme(),
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+})
+开发一个子主题
除了在 .vuepress/config.ts 和 .vuepress/client.ts 中直接扩展默认主题以外，你可以通过继承默认主题来开发一个你自己的主题：
import { defaultTheme, type DefaultThemeOptions } from '@vuepress/theme-default'
+import type { Theme } from 'vuepress/core'
+import { getDirname, path } from 'vuepress/utils'
+
+const __dirname = getDirname(import.meta.url)
+
+export const childTheme = (options: DefaultThemeOptions): Theme => {
+ return {
+ name: 'vuepress-theme-child',
+ extends: defaultTheme(options),
+
+ // 在子主题的客户端配置文件中覆盖布局
+ // 注意，你在发布到 NPM 之前会将 TS 构建为 JS ，因此这里需要设置为 JS 文件的路径
+ clientConfigFile: path.resolve(__dirname, './client.js'),
+
+ // 覆盖组件别名
+ alias: {
+ '@theme/HomeFooter.vue': path.resolve(
+ __dirname,
+ './components/MyHomeFooter.vue',
+ ),
+ },
+ }
+}
+Frontmatter
所有页面
本章节中的 Frontmatter 会在所有类型的页面中生效。
externalLinkIcon
类型：
boolean详情：
参考：
navbar
类型：
boolean详情：
是否在当前页面展示导航栏。
如果你在主题配置中禁用了导航栏，那么该 Frontmatter 将不会生效。
参考：
pageClass
类型：
string详情：
为当前页面添加额外的类名。
示例：
---
+pageClass: custom-page-class
+---
+然后你可以在 .vuepress/styles/index.scss 文件中为这个页面添加自定义样式：
.theme-container.custom-page-class {
+ /* 页面样式 */
+}
+首页
本章节中的 Frontmatter 只会在首页中生效。
home
类型：
boolean详情：
设定该页面是首页还是普通页面。
如果你不设置该 Frontmatter 或将其设为
false，则该页面会是一个 普通页面示例：
--- +home: true +--- +
heroImage
类型：
string详情：
首页图片的 URL 。
示例：
--- +# Public 文件路径 +heroImage: /images/hero.png +# URL +heroImage: https://vuejs.org/images/logo.png +--- +参考：
heroImageDark
类型：
string详情：
在夜间模式中使用的首页图片的 URL 。
如果你想在夜间模式中使用不同的首页图片，就可以使用该配置项。
参考：
heroAlt
类型：
string详情：
首页图片的
alt属性。如果不设置，则默认使用 heroText 。
heroHeight
类型：
number默认值：
280详情：
首页图片
<img>标签的height属性。当你的首页图片高度小于默认值时，你可能需要减小该属性。
需要注意的是，首页图片的高度同样受到了 CSS 的约束。设置这个属性主要是为了减少由加载首页图片引起的 累积布局偏移 (CLS) 。
heroText
类型：
string | null详情：
首页的大标题。
如果不设置，则默认使用站点 title 。
设置为
null来禁用首页大标题。
tagline
类型：
string | null详情：
首页的标语。
如果不设置，则默认使用站点 description 。
设置为
null来禁用首页标语。
actions
- 类型：
Array<{
+ text: string
+ link: string
+ type?: 'primary' | 'secondary'
+}>
+详情：
配置首页按钮。
示例：
---
+actions:
+ - text: 快速上手
+ link: /zh/guide/getting-started.html
+ type: primary
+ - text: 项目简介
+ link: /zh/guide/introduction.html
+ type: secondary
+---
+features
- 类型：
Array<{
+ title: string
+ details: string
+}>
+详情：
配置首页特性列表。
示例：
---
+features:
+ - title: 简洁至上
+ details: 以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
+ - title: Vue 驱动
+ details: 享受 Vue 的开发体验，可以在 Markdown 中使用 Vue 组件，又可以使用 Vue 来开发自定义主题。
+ - title: 高性能
+ details: VuePress 会为每个页面预渲染生成静态的 HTML，同时，每个页面被加载的时候，将作为 SPA 运行。
+---
+footer
类型：
string详情：
首页的页脚。
footerHtml
类型：
boolean详情：
是否允许页脚中使用 HTML 。
如果设置为
true，那么 footer 会被作为 HTML 代码处理。
普通页面
本章节中的 Frontmatter 只会在普通页面中生效。
editLink
类型：
boolean详情：
是否在本页面中启用 编辑此页 链接。
参考：
editLinkPattern
类型：
string详情：
本页面中 编辑此页 链接的 Pattern 。
参考：
lastUpdated
类型：
boolean详情：
是否在本页面中启用 最近更新时间戳 。
参考：
contributors
类型：
boolean详情：
是否在本页面中启用 贡献者列表 。
参考：
sidebar
类型：
false | 'auto' | SidebarConfigArray | SidebarConfigObject详情：
配置本页面的侧边栏。
参考：
sidebarDepth
类型：
number详情：
配置本页面的侧边栏深度。
参考：
prev
类型：
NavLink | string详情：
上一个页面的链接。
如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。
为了手动配置上一页面的链接，你可以将其设置为一个
NavLink对象或者一个字符串：NavLink对象应该有一个text字段和一个link字段。- 字符串应为目标页面文件的路径。它将会被转换为
NavLink对象，将页面标题作为text，将页面路由路径作为link。
示例：
---
+# NavLink
+prev:
+ text: Get Started
+ link: /guide/getting-started.html
+
+# NavLink - 外部 URL
+prev:
+ text: GitHub
+ link: https://github.com
+
+# 字符串 - 页面文件路径
+prev: /guide/getting-started.md
+
+# 字符串 - 页面文件相对路径
+prev: ../../guide/getting-started.md
+---
+next
类型：
NavLink | string详情：
下一个页面的链接。
如果你不设置该 Frontmatter ，该链接会自动根据侧边栏配置进行推断。
类型和 prev Frontmatter 相同。
+
+
+
diff --git a/zh/themes/default/locale.html b/zh/themes/default/locale.html
new file mode 100644
index 0000000000..5fcdd78d97
--- /dev/null
+++ b/zh/themes/default/locale.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+
+
+
语言配置
这些选项用于配置与语言相关的文本。
如果你的站点是以英语以外的其他语言提供服务的，你应该为每个语言设置这些选项来提供翻译。
repoLabel
类型：
string详情：
项目仓库的标签。
它将被用作 仓库链接 的文字。仓库链接 将会显示为导航栏的最后一个元素。
如果你不明确指定该配置项，它将会根据 repo 配置项自动推断。
selectLanguageText
类型：
string详情：
选择语言菜单 的文字。
如果你在站点配置中设置了多个 locales ，那么 选择语言菜单 就会显示在导航栏中仓库按钮的旁边。
selectLanguageAriaLabel
类型：
string详情：
选择语言菜单 的
aria-label属性。它主要是为了站点的可访问性 (a11y) 。
selectLanguageName
类型：
string详情：
Locale 的语言名称。
该配置项 仅能在主题配置的 locales 的内部生效 。它将被用作 locale 的语言名称，展示在 选择语言菜单 内。
示例：
export default {
+ locales: {
+ '/': {
+ lang: 'en-US',
+ },
+ '/zh/': {
+ lang: 'zh-CN',
+ },
+ },
+ theme: defaultTheme({
+ locales: {
+ '/': {
+ selectLanguageName: 'English',
+ },
+ '/zh/': {
+ selectLanguageName: '简体中文',
+ },
+ },
+ }),
+}
+navbarLabel
类型：
null | string详情：
导航栏中主导航
aria-label属性的值。
pageNavbarLabel
类型：
null | string详情：
下一页/上一页导航
aria-label属性的值
editLinkText
类型：
string默认值：
'Edit this page'详情：
编辑此页 链接的文字。
lastUpdatedText
类型：
string默认值：
'Last Updated'详情：
最近更新时间戳 标签的文字。
contributorsText
类型：
string默认值：
'Contributors'详情：
贡献者列表 标签的文字。
tip
类型：
string默认值：
'TIP'详情：
Tip 自定义容器 的默认标题。
warning
类型：
string默认值：
'WARNING'详情：
Warning 自定义容器 的默认标题。
danger
类型：
string默认值：
'DANGER'详情：
Danger 自定义容器 的默认标题。
notFound
类型：
string[]默认值：
['Not Found']详情：
404 页面的提示信息。
当用户进入 404 页面时，会从数组中随机选取一条信息进行展示。
backToHome
类型：
string默认值：
'Back to home'详情：
404 页面中 返回首页 链接的文字。
openInNewWindow
类型：
string默认值：
'open in new window'详情：
ExternalLinkIcon. 链接内的
sr-only文字。它主要是为了站点的可访问性 (a11y) 。
参考：
toggleColorMode
类型：
string默认值：
'toggle color mode'详情：
切换颜色模式按钮的标题文字。
它主要是为了站点的可访问性 (a11y) 。
参考：
toggleSidebar
类型：
string默认值：
'toggle sidebar'详情：
切换侧边栏按钮的标题文字。
它主要是为了站点的可访问性 (a11y) 。
Markdown
自定义容器
使用：
::: <type> [title] +[content] +::: +type是必需的，title和content是可选的。支持的
type有：tipwarningdangerdetails- CodeGroup 和 CodeGroupItem 的别名：
code-groupcode-group-item
示例 1 （默认标题）：
输入
::: tip
+这是一个提示
+:::
+
+::: warning
+这是一个警告
+:::
+
+::: danger
+这是一个危险警告
+:::
+
+::: details
+这是一个 details 标签
+:::
+输出
提示
这是一个提示
注意
这是一个警告
警告
这是一个危险警告
这是一个 details 标签
- 示例 2 （自定义标题）：
输入
::: danger STOP
+危险区域，禁止通行
+:::
+
+::: details 点击查看代码
+
+```ts
+console.log('你好，VuePress！')
+```
+
+:::
+输出
STOP
危险区域，禁止通行
点击查看代码
console.log('你好，VuePress！')
+- 示例 3 （Code Group 别名）：
输入
:::: code-group
+::: code-group-item FOO
+
+```ts
+const foo = 'foo'
+```
+
+:::
+
+::: code-group-item BAR
+
+```ts
+const bar = 'bar'
+```
+
+:::
+::::
+输出
const foo = 'foo'
+const bar = 'bar'
+插件配置
你可以通过 themePlugins 设置默认主题使用的插件。
默认主题使用了一些插件，如果你确实不需要该插件，你可以选择禁用它。在禁用插件之前，请确保你已了解它的用途。
import { defaultTheme } from '@vuepress/theme-default'
+
+export default {
+ theme: defaultTheme({
+ themePlugins: {
+ // 在这里自定义主题插件
+ },
+ }),
+}
+themePlugins.activeHeaderLinks
类型：
boolean默认值：
true详情：
themePlugins.backToTop
类型：
BackToTopPluginOptions | boolean默认值：
true详情：
是否启用 @vuepress/plugin-back-to-top 。
支持对象格式以作为插件选项。
themePlugins.container
类型：
Record<ContainerType, boolean>详情：
是否启用由 @vuepress/plugin-container 支持的自定义容器。
ContainerType类型为：tipwarningdangerdetailscodeGroupcodeGroupItem
参考：
themePlugins.copyCode
类型：
CopyCodePluginOptions | boolean默认值：
true详情：
是否启用 @vuepress/plugin-copy-code 。
支持对象格式以作为插件选项。
themePlugins.externalLinkIcon
类型：
boolean默认值：
true详情：
themePlugins.git
类型：
boolean默认值：
true详情：
是否启用 @vuepress/plugin-git 。
themePlugins.mediumZoom
类型：
boolean默认值：
true详情：
是否启用 @vuepress/plugin-medium-zoom 。
themePlugins.nprogress
类型：
boolean默认值：
true详情：
是否启用 @vuepress/plugin-nprogress 。
themePlugins.seo
类型：
SeoPluginOptions | boolean默认值：
true详情：
是否启用 @vuepress/plugin-seo 。
支持对象格式以作为插件选项。
themePlugins.sitemap
类型：
SitemapPluginOptions | boolean默认值：
true详情：
是否启用 @vuepress/plugin-sitemap 。
支持对象格式以作为插件选项。
样式
默认主题使用 SASS 作为 CSS 预处理器。
用户可以通过 palette 文件 来自定义样式变量，还可以通过 style 文件 来添加额外的样式。
Palette 文件
Palette 文件的路径是 .vuepress/styles/palette.scss 。
你可以利用它来覆盖默认主题的预定义 SASS 变量。
点击查看 SASS 变量
// responsive breakpoints
+$MQNarrow: 959px !default;
+$MQMobile: 719px !default;
+$MQMobileNarrow: 419px !default;
+Style 文件
Style 文件的路径是 .vuepress/styles/index.scss 。
你可以在这里添加额外的样式，或者覆盖默认样式：
:root {
+ scroll-behavior: smooth;
+}
+你也可以利用它来覆盖默认主题的预定义 CSS 变量。
点击查看 CSS 变量
:root {
+ // brand colors
+ --c-brand: #3eaf7c;
+ --c-brand-light: #4abf8a;
+
+ // background colors
+ --c-bg: #ffffff;
+ --c-bg-light: #f3f4f5;
+ --c-bg-lighter: #eeeeee;
+ --c-bg-dark: #ebebec;
+ --c-bg-darker: #e6e6e6;
+ --c-bg-navbar: var(--c-bg);
+ --c-bg-sidebar: var(--c-bg);
+ --c-bg-arrow: #cccccc;
+
+ // text colors
+ --c-text: #2c3e50;
+ --c-text-accent: var(--c-brand);
+ --c-text-light: #3a5169;
+ --c-text-lighter: #4e6e8e;
+ --c-text-lightest: #6a8bad;
+ --c-text-quote: #999999;
+
+ // border colors
+ --c-border: #eaecef;
+ --c-border-dark: #dfe2e5;
+
+ // custom container colors
+ --c-tip: #42b983;
+ --c-tip-bg: var(--c-bg-light);
+ --c-tip-title: var(--c-text);
+ --c-tip-text: var(--c-text);
+ --c-tip-text-accent: var(--c-text-accent);
+ --c-warning: #ffc310;
+ --c-warning-bg: #fffae3;
+ --c-warning-bg-light: #fff3ba;
+ --c-warning-bg-lighter: #fff0b0;
+ --c-warning-border-dark: #f7dc91;
+ --c-warning-details-bg: #fff5ca;
+ --c-warning-title: #f1b300;
+ --c-warning-text: #746000;
+ --c-warning-text-accent: #edb100;
+ --c-warning-text-light: #c1971c;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #f11e37;
+ --c-danger-bg: #ffe0e0;
+ --c-danger-bg-light: #ffcfde;
+ --c-danger-bg-lighter: #ffc9c9;
+ --c-danger-border-dark: #f1abab;
+ --c-danger-details-bg: #ffd4d4;
+ --c-danger-title: #ed1e2c;
+ --c-danger-text: #660000;
+ --c-danger-text-accent: #bd1a1a;
+ --c-danger-text-light: #b5474d;
+ --c-danger-text-quote: #c15b5b;
+ --c-details-bg: #eeeeee;
+
+ // badge component colors
+ --c-badge-tip: var(--c-tip);
+ --c-badge-warning: #ecc808;
+ --c-badge-warning-text: var(--c-bg);
+ --c-badge-danger: #dc2626;
+ --c-badge-danger-text: var(--c-bg);
+
+ // code group colors
+ --c-code-group-tab-title: rgba(255, 255, 255, 0.9);
+ --c-code-group-tab-bg: var(--code-bg-color);
+ --c-code-group-tab-outline: var(var(--c-code-group-tab-title));
+ --c-code-group-tab-active-border: var(--c-brand);
+
+ // transition vars
+ --t-color: 0.3s ease;
+ --t-transform: 0.3s ease;
+
+ // code blocks vars
+ --code-bg-color: #282c34;
+ --code-hl-bg-color: rgba(0, 0, 0, 0.66);
+ --code-ln-color: #9e9e9e;
+ --code-ln-wrapper-width: 3.5rem;
+
+ // font vars
+ --font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
+ Ubuntu, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
+ --font-family-code: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
+
+ // layout vars
+ --navbar-height: 3.6rem;
+ --navbar-padding-v: 0.7rem;
+ --navbar-padding-h: 1.5rem;
+ --sidebar-width: 20rem;
+ --sidebar-width-mobile: calc(var(--sidebar-width) * 0.82);
+ --content-width: 740px;
+ --homepage-width: 960px;
+}
+
+// plugin-back-to-top
+.vp-back-to-top-button {
+ --back-to-top-color: var(--c-brand);
+ --back-to-top-color-hover: var(--c-brand-light);
+ --back-to-top-bg-color: var(--c-bg);
+}
+
+// plugin-catalog
+.vp-catalog-wrapper {
+ --catalog-bg-color: var(--c-bg);
+ --catalog-bg-secondary-color: var(--c-bg-dark);
+ --catalog-border-color: var(--c-border);
+ --catalog-active-color: var(--c-brand);
+ --catalog-hover-color: var(--c-brand-light);
+}
+
+// plugin-docsearch
+.DocSearch {
+ --docsearch-primary-color: var(--c-brand);
+ --docsearch-text-color: var(--c-text);
+ --docsearch-highlight-color: var(--c-brand);
+ --docsearch-muted-color: var(--c-text-quote);
+ --docsearch-container-background: rgba(9, 10, 17, 0.8);
+ --docsearch-modal-background: var(--c-bg-light);
+ --docsearch-searchbox-background: var(--c-bg-lighter);
+ --docsearch-searchbox-focus-background: var(--c-bg);
+ --docsearch-searchbox-shadow: inset 0 0 0 2px var(--c-brand);
+ --docsearch-hit-color: var(--c-text-light);
+ --docsearch-hit-active-color: var(--c-bg);
+ --docsearch-hit-background: var(--c-bg);
+ --docsearch-hit-shadow: 0 1px 3px 0 var(--c-border-dark);
+ --docsearch-footer-background: var(--c-bg);
+}
+
+// plugin-external-link-icon
+.external-link-icon {
+ --external-link-icon-color: var(--c-text-quote);
+}
+
+// plugin-medium-zoom
+.medium-zoom-overlay {
+ --medium-zoom-bg-color: var(--c-bg);
+}
+
+// plugin-nprogress
+#nprogress {
+ --nprogress-color: var(--c-brand);
+}
+
+// plugin-photo-swipe
+body {
+ --photo-swipe-bullet: var(--c-bg);
+ --photo-swipe-bullet-active: var(--c-brand);
+}
+
+// plugin-pwa-popup
+html {
+ --pwa-text-color: var(--c-text);
+ --pwa-bg-color: var(--c-bg);
+ --pwa-border-color: var(--c-brand);
+ --pwa-btn-text-color: var(--c-bg);
+ --pwa-btn-bg-color: var(--c-brand);
+ --pwa-btn-hover-bg-color: var(--c-brand-light);
+}
+
+html.dark {
+ --pwa-shadow-color: rgb(0 0 0 / 30%);
+ --pwa-content-color: #ccc;
+ --pwa-content-light-color: #999;
+}
+
+// plugin-redirect
+.language-modal-mask {
+ --redirect-bg-color: var(--c-bg);
+ --redirect-bg-color-light: var(--c-bg-light);
+ --redirect-bg-color-lighter: var(--c-bg-lighter);
+ --redirect-text-color: var(--c-text);
+ --redirect-primary-bg-color: var(--c-brand);
+ --redirect-primary-hover-bg-color: var(--c-brand-light);
+ --redirect-primary-text-color: var(--c-bg);
+}
+
+// plugin-search
+.search-box {
+ --search-bg-color: var(--c-bg);
+ --search-accent-color: var(--c-brand);
+ --search-text-color: var(--c-text);
+ --search-border-color: var(--c-border);
+
+ --search-item-text-color: var(--c-text-lighter);
+ --search-item-focus-bg-color: var(--c-bg-light);
+}
+点击查看暗黑模式 CSS 变量
html.dark {
+ // brand colors
+ --c-brand: #3aa675;
+ --c-brand-light: #349469;
+
+ // background colors
+ --c-bg: #22272e;
+ --c-bg-light: #2b313a;
+ --c-bg-lighter: #262c34;
+ --c-bg-dark: #343b44;
+ --c-bg-darker: #37404c;
+
+ // text colors
+ --c-text: #adbac7;
+ --c-text-light: #96a7b7;
+ --c-text-lighter: #8b9eb0;
+ --c-text-lightest: #8094a8;
+
+ // border colors
+ --c-border: #3e4c5a;
+ --c-border-dark: #34404c;
+
+ // custom container colors
+ --c-tip: #318a62;
+ --c-warning: #e0ad15;
+ --c-warning-bg: #2d2f2d;
+ --c-warning-bg-light: #423e2a;
+ --c-warning-bg-lighter: #44442f;
+ --c-warning-border-dark: #957c35;
+ --c-warning-details-bg: #39392d;
+ --c-warning-title: #fdca31;
+ --c-warning-text: #d8d96d;
+ --c-warning-text-accent: #ffbf00;
+ --c-warning-text-light: #ddb84b;
+ --c-warning-text-quote: #ccab49;
+ --c-danger: #fc1e38;
+ --c-danger-bg: #39232c;
+ --c-danger-bg-light: #4b2b35;
+ --c-danger-bg-lighter: #553040;
+ --c-danger-border-dark: #a25151;
+ --c-danger-details-bg: #482936;
+ --c-danger-title: #fc2d3b;
+ --c-danger-text: #ea9ca0;
+ --c-danger-text-accent: #fd3636;
+ --c-danger-text-light: #d9777c;
+ --c-danger-text-quote: #d56b6b;
+ --c-details-bg: #323843;
+
+ // badge component colors
+ --c-badge-warning: var(--c-warning);
+ --c-badge-warning-text: #3c2e05;
+ --c-badge-danger: var(--c-danger);
+ --c-badge-danger-text: #401416;
+
+ // code blocks vars
+ --code-hl-bg-color: #363b46;
+}
+
+// plugin-docsearch
+html.dark .DocSearch {
+ --docsearch-logo-color: var(--c-text);
+ --docsearch-modal-shadow: inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309;
+ --docsearch-key-shadow: inset 0 -2px 0 0 #282d55, inset 0 0 1px 1px #51577d,
+ 0 2px 2px 0 rgba(3, 4, 9, 0.3);
+ --docsearch-key-gradient: linear-gradient(-225deg, #444950, #1c1e21);
+ --docsearch-footer-shadow: inset 0 1px 0 0 rgba(73, 76, 106, 0.5),
+ 0 -4px 8px 0 rgba(0, 0, 0, 0.2);
+}
+客户端相关
可组合 API
hasGlobalComponent
检查组件是否已全局注册。
提示
- 组件的局部导入不影响结果。
- 当在
setup之外调用时，你需要将app实例作为第二个参数传递。
export const hasGlobalComponent: (name: string, app?: App) => boolean
+示例
// 如果你全局注册了 `<my-component>`
+hasGlobalComponent('MyComponent') // true
+hasGlobalComponent('my-component') // true
+
+hasGlobalComponent('MyComponent2') // false
+useLocaleConfig
从语言环境设置中获取当前语言环境配置。
export const useLocaleConfig: <T extends LocaleData>(
+ localesConfig: RequiredLocaleConfig<T>,
+) => ComputedRef<T>
+示例
const localesCOnfig = {
+ '/': 'Title',
+ '/zh/': '标题',
+}
+
+const locale = useLocaleConfig(localesConfig)
+
+// under `/page`
+locale.value // 'Title'
+
+// under `/zh/page`
+locale.value // '标题'
+@vuepress/helper
此包为 VuePress 开发者提供辅助函数。
@vuepress/helper: Node.js 一侧的辅助函数。@vuepress/helper/client: 客户端一侧的辅助函数。@vuepress/helper/shared: Node.js 和客户端共享的辅助函数。
打包器相关
打包器函数用于在主题和插件中追加或修改打包器选项。
所有函数都应在 extendsBundlerOptions 生命周期挂钩中调用。
提示
我们在示例中省略了它。 实际代码应该是这样的：
// 导入你需要的函数
+import { addCustomElement } from '@vuepress/helper'
+
+export const yourPlugin = {
+ // ...
+ extendsBundlerOptions: (bundlerOptions, app) => {
+ // 在此添加它们
+ addCustomElement(bundlerOptions, app, 'my-custom-element')
+ },
+}
+通用方法
getBundlerName
获取当前打包器的名称。
export const getBundlerName: (app: App) => string
+示例
// @vuepress/bundler-vite
+getBundleName(app) === 'vite' // true
+// @vuepress/bundler-webpack
+getBundleName(app) === 'webpack' // true
+addCustomElement
将自定义元素声明添加到当前的打包器。
interface CustomElementCommonOptions {
+ app: App;
+ config: unknown;
+}
+/**
+ * Add tags as customElement
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param customElements tags recognized as custom element
+ */
+export const addCustomElement = (
+ bundlerOptions: unknown,
+ app: App,
+ customElement: string[] | string | RegExp
+) => void;
+示例
import { addCustomElement } from '@vuepress/helper'
+
+addCustomElement(bundlerConfig, app, 'my-custom-element')
+addCustomElement(bundlerOptions, app, [
+ 'custom-element1',
+ 'custom-element2',
+ // all tags start with `math-`
+ /^math-/,
+])
+customizeDevServer
为开发服务器中的特定路径提供内容。
export interface DevServerOptions {
+ /**
+ * Path to be responded
+ */
+ path: string;
+ /**
+ * Respond function
+ */
+ response: (request?: IncomingMessage) => Promise<string | Buffer>;
+
+ /**
+ * error msg
+ */
+ errMsg?: string;
+}
+
+/**
+ * Handle specific path when running VuePress Dev Server
+ *
+ * @param bundlerOptions VuePress Bundler config
+ * @param app VuePress Node App
+ * @param path Path to be responded
+ * @param response respond function
+ * @param errMsg error msg
+ */
+export const customizeDevServer: (
+ bundlerOptions: unknown,
+ app: App,
+ {
+ errMsg:"The server encountered an error",
+ response: responseHandler,
+ path,
+ }: CustomServerOptions
+) => void;
+示例
import { useCustomDevServer } from '@vuepress/helper'
+
+// handle `/api/` path
+useCustomDevServer(bundlerOptions, app, {
+ path: '/api/',
+ response: async () => getData(),
+ errMsg: 'Unexpected api error',
+})
+Vite 相关
addViteOptimizeDepsInclude
向 Vite
optimizeDeps.include列表中添加模块提示
如果一个包满足下列条件之一，你应该考虑将它添加至此。
- 为 CJS 格式
- 包的依赖包含 CJS 包
- 包通过
import()动态导入
addViteOptimizeDepsExclude
向 Vite
optimizeDeps.exclude列表中添加模块如果一个包和它的依赖都是纯 ESM 包，你应该考虑将它添加至此。
addViteSsrExternal
向 Vite
ssr.external列表中添加模块如果一个包是纯 ESM 包，且未使用别名 (alias) 或定义变量 (define)，你应该考虑将它添加至此。
addViteSsrNoExternal
向 Vite
ssr.noExternal列表中添加模块如果一个包内使用了别名 (alias) 或定义变量 (define)，你必须将它添加至此。
/** + * Add modules to Vite `optimizeDeps.include` list + */ +export const addViteOptimizeDepsInclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite `optimizeDeps.exclude` list + */ +export const addViteOptimizeDepsExclude: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite `ssr.external` list + */ +export const addViteSsrExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void + +/** + * Add modules to Vite `ssr.noExternal` list + */ +export const addViteSsrNoExternal: ( + bundlerOptions: unknown, + app: App, + module: string | string[], +) => void +示例
import { + addViteOptimizeDepsInclude, + addViteOptimizeDepsExclude, + addViteSsrExternal, + addViteSsrNoExternal, +} from '@vuepress/helper' + +addViteOptimizeDepsInclude(bundlerOptions, app, ['vue', 'vue-router']) +addViteOptimizeDepsExclude(bundlerOptions, app, 'packageA') +addViteSsrNoExternal(bundlerOptions, app, ['vue', 'vue-router']) +addViteSsrExternal(bundlerOptions, app, 'packageA') +addViteConfig
A function for you to add vite config
export const addViteConfig: ( + bundlerOptions: unknown, + app: App, + config: Record<string, unknown>, +) => void +Example
import { addViteConfig } from '@vuepress/helper' + +addViteConfig(bundlerOptions, app, { + build: { + charset: 'utf8', + }, +}) +mergeViteConfig
无需导入 vite 即可合并 vite 配置的功能
export const mergeViteConfig: ( + defaults: Record<string, any>, + overrides: Record<string, any>, +) => Record<string, any> +注意
你不应将 vite 作为依赖，因为你的的用户可能选择其他打包器！
示例
import { mergeViteConfig } from "@vuepress/helper"; + +config.viteOptions mergeViteConfig(config.viteOptions, { + build: { + charset: "utf8", + }, +}); +
Webpack 相关
chainWebpack
链式修改 webpack 配置.
export const chainWebpack: ( + { app, config }: WebpackCommonOptions, + chainWebpack: ( + config: WebpackChainConfig, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +示例
import { chainWebpack } from '@vuepress/helper' + +chainWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +configWebpack
配置 Webpack
export const configWebpack: ( + bundlerOptions: unknown, + app: App, + configureWebpack: ( + config: WebpackConfiguration, + isServer: boolean, + isBuild: boolean, + ) => void, +) => void +实例
import { configWebpack } from '@vuepress/helper' + +configWebpack(bundlerOptions, app, (config, isServer, isBuild) => { + // do some customize here +}) +
页面相关
这些函数为你的页面生成常见信息。
getPageExcerpt
获取页面摘要。
export interface PageExcerptOptions {
+ /**
+ * 摘要分隔符
+ *
+ * @default "<!-- more -->"
+ */
+ separator?: string
+
+ /**
+ * 摘要的长度
+ *
+ * @description 摘要的长度会尽可能的接近这个值
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * 被认为是自定义元素的标签
+ *
+ * @description 用于判断一个标签是否是自定义元素，因为在摘要中，所有的未知标签都会被移除。
+ */
+ isCustomElement?: (tagName: string) => boolean
+
+ /**
+ * 是否保留页面标题 (第一个 h1)
+ *
+ * @default false
+ */
+ keepPageTitle?: boolean
+
+ /**
+ * 是否保留代码块的标签，诸如行号和高亮行
+ *
+ * @default false
+ */
+ keepFenceDom?: boolean
+}
+
+export const getPageExcerpt: (
+ app: App,
+ page: Page,
+ options?: PageExcerptOptions,
+) => string
+getPageText
获取页面纯文本。
export interface PageTextOptions {
+ /**
+ * 是否将文字转换成单行内容
+ *
+ * @default false
+ */
+ singleLine?: boolean
+
+ /**
+ * 文字的长度
+ *
+ * @description 文字的长度会尽可能的接近这个值
+ *
+ * @default 300
+ */
+ length?: number
+
+ /**
+ * 需要移除的标签
+ *
+ * @description 默认情况下表格和代码块会被移除
+ *
+ * @default ['table', 'pre']
+ */
+ removedTags?: string[]
+}
+
+export const getPageText: (
+ app: App,
+ page: Page,
+ options?: PageTextOptions,
+) => string
+共享方法
以下函数在 Node.js 和客户端上均可用。
数据相关
此方法在 MarkdownIt 插件中很有用。有些时候你可能需要在 Markdown 插件中生成组件，并将复杂的数据写入到组件属性中，一个通常做法是使用 JSON.stringify + encodeURIComponent，并在客户端 decodeURIComponent + JSON.parse。但如果内容包含很多特殊字符，转换结果会很长。
所以我们提供 encodeData 和 decodeData 来压缩和编码内容。
export const encodeData: (
+ data: string,
+ level: DeflateOptions['level'] = 6,
+) => string
+
+export const decodeData: (compressed: string) => string
+const content = `
+{
+ "type": "bar",
+ "data": {
+ "labels": ["Red", "Blue", "Yellow", "Green", "Purple", "Orange"],
+ "datasets": [
+ {
+ "label": "# of Votes",
+ "data": [12, 19, 3, 5, 2, 3],
+ "backgroundColor": [
+ "rgba(255, 99, 132, 0.2)",
+ "rgba(54, 162, 235, 0.2)",
+ "rgba(255, 206, 86, 0.2)",
+ "rgba(75, 192, 192, 0.2)",
+ "rgba(153, 102, 255, 0.2)",
+ "rgba(255, 159, 64, 0.2)"
+ ],
+ "borderColor": [
+ "rgba(255, 99, 132, 1)",
+ "rgba(54, 162, 235, 1)",
+ "rgba(255, 206, 86, 1)",
+ "rgba(75, 192, 192, 1)",
+ "rgba(153, 102, 255, 1)",
+ "rgba(255, 159, 64, 1)"
+ ],
+ "borderWidth": 1
+ }
+ ]
+ },
+ "options": {
+ "scales": {
+ "y": {
+ "beginAtZero": true
+ }
+ }
+ }
+}
+`
+
+const prop = encodeData(content) // "eJyNUsFOwzAMve8rrHABKZqWlg5WxAE4cARxAMHEIV1NmQhNlaaCCe3fcdKtW0sLWGpjxy/v+UV512mlcIyfhTa2hHP4GgHYVYExsEQaxqlMpZWxbwAomaAqY5izO0wZB3apKnTrIyqlP1x2bRBzl9xWplC+eWNkniF7dmw1X4nWsfgaNtwNP2kfgH6Be22x9CPUUQ8yFwEHMeMQcog4UBFuiF0kcvGWGV3l6ZVW2uw0XDCTJfIwiOjYjAhESIcn4+BoT2MLio6pP6V+EBJ6AOSZgsmUwyl9A6ATwoiZn3lYTkTkRkycnuP8TU9ENPqUxuuA9i9BmxTNPy9A/G2/F9I23wtpW++FdIwPKzW2W5Afph+WqX2NQWz313XicT7XhV3qnB5f/ejKhVTYVACrXUqUmC3zC/uERsdgTYUdVr/Qb302+gZxe7S/"
+
+decodeData(prop) // will be the original content
+
+// if you use `encodeURIComponent`, it will be much longer
+encodeURIComponent(content) // '%0A%7B%0A%20%20%22type%22%3A%20%22bar%22%2C%0A%20%20%22data%22%3A%20%7B%0A%20%20%20%20%22labels%22%3A%20%5B%22Red%22%2C%20%22Blue%22%2C%20%22Yellow%22%2C%20%22Green%22%2C%20%22Purple%22%2C%20%22Orange%22%5D%2C%0A%20%20%20%20%22datasets%22%3A%20%5B%0A%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%22label%22%3A%20%22%23%20of%20Votes%22%2C%0A%20%20%20%20%20%20%20%20%22data%22%3A%20%5B12%2C%2019%2C%203%2C%205%2C%202%2C%203%5D%2C%0A%20%20%20%20%20%20%20%20%22backgroundColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%200.2)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%200.2)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderColor%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%2099%2C%20132%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(54%2C%20162%2C%20235%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20206%2C%2086%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(75%2C%20192%2C%20192%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(153%2C%20102%2C%20255%2C%201)%22%2C%0A%20%20%20%20%20%20%20%20%20%20%22rgba(255%2C%20159%2C%2064%2C%201)%22%0A%20%20%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%20%20%22borderWidth%22%3A%201%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%20%20%7D%2C%0A%20%20%22options%22%3A%20%7B%0A%20%20%20%20%22scales%22%3A%20%7B%0A%20%20%20%20%20%20%22y%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22beginAtZero%22%3A%20true%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A'
+类型助手
isDef(x): 判断 x 是否定义。isBoolean(x): 判断 x 是否为布尔值。isString(x): 判断 x 是否为字符串。isNumber(x): 判断 x 是否为数字。isPlainObject(x): 判断值是否为纯对象。isArray(x): 判断 x 是否为数组isFunction(x): 判断 x 是否为函数。isRegExp(x): 判断 x 是否为正则表达式
字符串相关
startsWith(a, b): 判断字符串 a 是否以指定字符串 b 开头endsWith(a, b): 判断字符串 a 是否以指定字符串 b 结尾
当 a 不是字符串时返回 false
对象相关
keys(x): 以数组形式返回对象 x 的键values(x): 以数组形式返回对象 x 的值entries(x): 将对象 x 转换为键值对数组。fromEntries(x): 将键值对数组 x 转换为对象。deepAssign(x, y, ...):Object.assign的深度版本。示例
// or @vuepress/helper/client +import { deepAssign } from '@vuepress/helper' + +const defaultOptions = { + optionA: { + optionA1: 'defaultOptionA1', + optionA2: 'defaultOptionA2', + optionA3: 'defaultOptionA3', + }, + optionB: true, + optionC: 'optionC', +} + +const userOptions = { + optionA: { + optionA1: 'optionA1', + optionA2: 'optionA2', + }, + optionB: false, +} + +deepAssign(defaultOptions, userOptions) +// { +// optionA: { +// optionA1: "optionA1", +// optionA2: "optionA2", +// optionA3: "defaultOptionA3", +// }, +// optionB: false, +// optionC: "optionC", +// } +
日期相关
getDate(x): 将输入 x 转换为日期，可以支持 Date，时间戳，日期字符串。日期字符串的支持度以环境的Date.parse支持度为准。当不能转换为日期时返回null示例
getDate('2021-01-01') // a Date object represents 2021-01-01 +getDate(1609459200000) // a Date object represents 2021-01-01 +getDate('2021-01-01T00:00:00.000Z') // a Date object represents 2021-01-01 +getDate('2021/01/01') // a Date object represents 2021-01-01 (might be null in some browsers) +getDate('invalid date') // null +getDate(undefined) // null +getDate(-32) // null +dateSorter: 将可转换为日期的值从新到旧排序，不能转换为日期的值会在最后。示例
const arr = [ + '2020-01-01', + 1609459200000, + '2022-01-01T00:00:00.000Z', + '2023/01/01', + 'invalid date', + undefined, + -32, +] + +arr.sort(dateSorter) +// [ +// '2023/01/01', +// '2022-01-01T00:00:00.000Z', +// 1609459200000, +// '2020-01-01', +// 'invalid date', +// undefined, +// -32, +// ] +
链接相关
isLinkHttp(x): x 是否是有效的 HTTP URL。isLinkWithProtocol(x): x 是否是有效的带有协议的 URL。isLinkExternal(x): x 是否是有效的外部 URL。isLinkAbsolute(x): x 是否是有效的绝对 URL。ensureEndingSlash(x): 确保 x 以斜杠结尾。ensureLeadingSlash(x): 确保 x 以斜杠开头。removeEndingSlash(x): 确保 x 不以斜杠结尾。removeLeadingSlash(x): 确保 x 不以斜杠开头。