mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-25 11:28:13 +08:00
201 lines
140 KiB
HTML
201 lines
140 KiB
HTML
<!doctype html><html lang="en-US"><head><meta charset="utf-8" /><meta name="viewport" content="width=device-width,initial-scale=1" /><meta name="generator" content="VuePress 2.0.0-rc.28" /><meta name="theme" content="VuePress Theme Plume 1.0.0-rc.195" /><script id="check-mac-os">document.documentElement.classList.toggle('mac', /Mac|iPhone|iPod|iPad/i.test(navigator.platform))</script><script id="check-dark-mode">;(function () {const um= localStorage.getItem('vuepress-theme-appearance') || 'auto';const sm = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;const isDark = um === 'dark' || (um !== 'light' && sm);document.documentElement.dataset.theme = isDark ? 'dark' : 'light';})();</script><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Theme Configuration","image":[""],"dateModified":"2026-01-19T13:43:41.000Z","author":[]}</script><meta property="og:url" content="https://theme-plume.vuejs.press/en/config/theme/"><meta property="og:site_name" content="Plume Theme"><meta property="og:title" content="Theme Configuration"><meta property="og:description" content="Overview Theme configuration is used to customize various features of the theme and control its behavior. You can configure it in either .vuepress/config.ts or .vuepress/plume.c..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2026-01-19T13:43:41.000Z"><meta property="article:modified_time" content="2026-01-19T13:43:41.000Z"><link rel="alternate" hreflang="zh-cn" href="https://theme-plume.vuejs.press/config/theme/"><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"><meta name="google-site-verification" content="AaTP7bapCAcoO9ZGE67ilpy99GL6tYqtD30tRHjO9Ps"><title>Theme Configuration | Config | Plume Theme</title><meta name="description" content="Overview Theme configuration is used to customize various features of the theme and control its behavior. You can configure it in either .vuepress/config.ts or .vuepress/plume.c..."><link rel="preload" href="/assets/style-DnsiUdcZ.css" as="style"><link rel="stylesheet" href="/assets/style-DnsiUdcZ.css"><link rel="modulepreload" href="/assets/app-B2DsuqVi.js"><link rel="modulepreload" href="/assets/plugin-vue_export-helper-CxTVcLa7.js"><link rel="modulepreload" href="/assets/chunk-DseTPa7n.js"><link rel="modulepreload" href="/assets/preload-helper-ca-nBW7U.js"><link rel="modulepreload" href="/assets/composables-DsGBjQEX.js"><link rel="modulepreload" href="/assets/VPHomeHero-D17FBc21.js"><link rel="modulepreload" href="/assets/composables-3J5ZwNFM.js"><link rel="modulepreload" href="/assets/client-C5e5tgZO.js"><link rel="modulepreload" href="/assets/theme-colors-bZHGy5AR.js"><link rel="modulepreload" href="/assets/VPButton-CjpnmuwG.js"><link rel="modulepreload" href="/assets/runtime-core.esm-bundler-CZvn3YaB.js"><link rel="modulepreload" href="/assets/runtime-dom.esm-bundler-DTRCDnrc.js"><link rel="modulepreload" href="/assets/dist-CMy7OcvW.js"><link rel="modulepreload" href="/assets/codeRepl-BV_0qCs3.js"><link rel="modulepreload" href="/assets/VPCopyright-DQT4wCul.js"><link rel="modulepreload" href="/assets/theme-A0Rkrk0h.js"></head><body><div id="app"><!--[--><!--[--><div class="theme-plume vp-layout" vp-container data-v-a5aadcf6><!--[--><!--[--><!--]--><!--[--><span tabindex="-1" data-v-26bc9d93></span><a href="#VPContent" class="vp-skip-link visually-hidden" data-v-26bc9d93> Skip to content </a><!--]--><!----><header class="vp-nav" data-v-a5aadcf6 data-v-f81e37e9><div class="vp-navbar" vp-navbar data-v-f81e37e9 data-v-b90976a4><div class="wrapper" data-v-b90976a4><div class="container" data-v-b90976a4><div class="title" data-v-b90976a4><div class="vp-navbar-title has-sidebar" data-v-b90976a4 data-v-f77fe1b1><a class="vp-link link no-icon title" href="/en/" data-v-f77fe1b1><!--[--><!--[--><!--]--><!--[--><!--[--><!--[--><img class="vp-image dark logo" style="" src="/plume.png" alt data-v-414baac9><!--]--><!--[--><img class="vp-image light logo" style="" src="/plume.png" alt data-v-414baac9><!--]--><!--]--><!--]--><span data-v-f77fe1b1>Plume Theme</span><!--[--><!--]--><!--]--><!--[--><!--]--><!----></a></div></div><div class="content" data-v-b90976a4><div class="content-body" data-v-b90976a4><!--[--><!--]--><div class="vp-navbar-search search" data-v-b90976a4><div class="search-wrapper" data-v-62419745><!----><div id="local-search" data-v-62419745><button type="button" class="mini-search mini-search-button" aria-label="Search" data-v-62419745><span class="mini-search-button-container"><span class="mini-search-search-icon vpi-mini-search" aria-label="search icon"></span><span class="mini-search-button-placeholder">Search</span></span><span class="mini-search-button-keys"><kbd class="mini-search-button-key"></kbd><kbd class="mini-search-button-key">K</kbd></span></button></div></div></div><!--[--><!--]--><nav aria-labelledby="main-nav-aria-label" class="vp-navbar-menu menu" data-v-b90976a4 data-v-b42927e7><span id="main-nav-aria-label" class="visually-hidden" data-v-b42927e7>Main Navigation</span><!--[--><!--[--><a class="vp-link link navbar-menu-link" href="/en/guide/intro/" tabindex="0" data-v-b42927e7 data-v-29cf8989><!--[--><span class="vp-icon vpi-icon-park-outline-guide-board" style="" aria-hidden data-provider="iconify" data-v-29cf8989></span><span data-v-29cf8989>Guide</span><!----><!--]--><!--[--><!--]--><!----></a><!--]--><!--[--><a class="vp-link link navbar-menu-link active" href="/en/config/intro/" tabindex="0" data-v-b42927e7 data-v-29cf8989><!--[--><span class="vp-icon vpi-icon-park-outline-setting-two" style="" aria-hidden data-provider="iconify" data-v-29cf8989></span><span data-v-29cf8989>Config</span><!----><!--]--><!--[--><!--]--><!----></a><!--]--><!--[--><a class="vp-link link navbar-menu-link" href="/en/blog/" tabindex="0" data-v-b42927e7 data-v-29cf8989><!--[--><span class="vp-icon vpi-material-symbols-article-outline" style="" aria-hidden data-provider="iconify" data-v-29cf8989></span><span data-v-29cf8989>Blog</span><!----><!--]--><!--[--><!--]--><!----></a><!--]--><!--[--><div class="vp-flyout vp-navbar-menu-group" data-v-b42927e7 data-v-15bfbb59><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-15bfbb59><span class="text" data-v-15bfbb59><span class="vp-icon vpi-icon-park-outline-more-three" style="" aria-hidden data-provider="iconify" data-v-15bfbb59></span><!----><span data-v-15bfbb59>More</span><!----><span class="vpi-chevron-down text-icon" data-v-15bfbb59></span></span></button><div class="menu" data-v-15bfbb59><div class="vp-menu" data-v-15bfbb59 data-v-f3964f32><div class="items" data-v-f3964f32><!--[--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/en/faq/" data-v-e06ddb34><!--[--><span class="vp-icon vpi-wpf-faq" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> FAQ <!----><!--]--><!--[--><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/en/tools/" data-v-e06ddb34><!--[--><span class="vp-icon vpi-jam-tools" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> Theme Tools <!----><!--]--><!--[--><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/en/friends/" data-v-e06ddb34><!--[--><span class="vp-icon vpi-carbon-friendship" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> Friend Links <!----><!--]--><!--[--><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-group" data-v-f3964f32 data-v-6c770283><p class="title" data-v-6c770283><span class="vp-icon vpi-logos-vue bg" style="" aria-hidden data-provider="iconify" data-v-6c770283></span><span data-v-6c770283>Vuepress</span></p><!--[--><!--[--><div class="vp-menu-link" data-v-6c770283 data-v-e06ddb34><a class="vp-link link vp-external-link-icon" href="https://v2.vuepress.vuejs.org" target="_blank" rel="noopener noreferrer" data-v-e06ddb34><!--[--><span class="vp-icon vpi-logos-vue bg" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> Official Docs <!----><!--]--><!--[--><!--]--><span class="visually-hidden">(Open in new window)</span></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-6c770283 data-v-e06ddb34><a class="vp-link link vp-external-link-icon" href="https://ecosystem.vuejs.press/" target="_blank" rel="noopener noreferrer" data-v-e06ddb34><!--[--><span class="vp-icon vpi-logos-vue bg" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> Ecosystem <!----><!--]--><!--[--><!--]--><span class="visually-hidden">(Open in new window)</span></a></div><!--]--><!--]--></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><div class="vp-flyout vp-navbar-menu-group" data-v-b42927e7 data-v-15bfbb59><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-15bfbb59><span class="text" data-v-15bfbb59><span class="vp-icon vpi-codicon-versions" style="" aria-hidden data-provider="iconify" data-v-15bfbb59></span><!----><span data-v-15bfbb59>1.0.0-rc.195</span><span class="vp-badge tip vp-menu-badge" style="" data-v-15bfbb59 data-v-52c8341f><!--[-->New<!--]--></span><span class="vpi-chevron-down text-icon" data-v-15bfbb59></span></span></button><div class="menu" data-v-15bfbb59><div class="vp-menu" data-v-15bfbb59 data-v-f3964f32><div class="items" data-v-f3964f32><!--[--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/en/changelog/" data-v-e06ddb34><!--[--><!----> Changelog <!----><!--]--><!--[--><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/en/contributing/" data-v-e06ddb34><!--[--><!----> Contributing <!----><!--]--><!--[--><!--]--><!----></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--]--></nav><!--[--><!--]--><div class="vp-flyout vp-navbar-translations translations" data-v-b90976a4 data-v-e0a18246 data-v-15bfbb59><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Languages" data-v-15bfbb59><span class="text" data-v-15bfbb59><!----><span class="vpi-languages option-icon" data-v-15bfbb59></span><!----><!----><span class="vpi-chevron-down text-icon" data-v-15bfbb59></span></span></button><div class="menu" data-v-15bfbb59><div class="vp-menu" data-v-15bfbb59 data-v-f3964f32><!----><!--[--><!--[--><div class="items" data-v-e0a18246><p class="title" data-v-e0a18246>English</p><!--[--><div class="vp-menu-link" data-v-e0a18246 data-v-e06ddb34><a class="vp-link link" href="/config/theme/" data-v-e06ddb34><!--[--><!----> 简体中文 <!----><!--]--><!--[--><!--]--><!----></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="vp-navbar-appearance appearance" data-v-b90976a4 data-v-17780d44><button class="vp-switch vp-switch-appearance" type="button" role="switch" aria-checked="false" title data-v-17780d44 data-v-cbe77d87 data-v-36bbbf22><span class="check" data-v-36bbbf22><span class="icon" data-v-36bbbf22><!--[--><span class="vpi-sun sun" data-v-cbe77d87></span><span class="vpi-moon moon" data-v-cbe77d87></span><!--]--></span></span></button></div><div class="vp-social-links vp-navbar-social-links social-links" data-v-b90976a4 data-v-ba70645a data-v-5dc0805d><!--[--><a class="vp-social-link no-icon" href="https://github.com/pengzhanbo/vuepress-theme-plume" aria-label="github" title="github" target="_blank" rel="noopener" data-v-5dc0805d data-v-c5bc2a09><span class="vp-icon vpi-simple-icons-github" style="" aria-hidden data-provider="iconify" data-v-c5bc2a09></span></a><a class="vp-social-link no-icon" href="https://qm.qq.com/q/FbPPoOIscE" aria-label="qq" title="qq" target="_blank" rel="noopener" data-v-5dc0805d data-v-c5bc2a09><span class="vp-icon vpi-simple-icons-qq" style="" aria-hidden data-provider="iconify" data-v-c5bc2a09></span></a><!--]--></div><div class="vp-flyout vp-navbar-extra extra" data-v-b90976a4 data-v-7e94ae84 data-v-15bfbb59><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-15bfbb59><span class="vpi-more-horizontal icon" data-v-15bfbb59></span></button><div class="menu" data-v-15bfbb59><div class="vp-menu" data-v-15bfbb59 data-v-f3964f32><!----><!--[--><!--[--><div class="group translations" data-v-7e94ae84><p class="trans-title" data-v-7e94ae84>English</p><!--[--><div class="vp-menu-link" data-v-7e94ae84 data-v-e06ddb34><a class="vp-link link" href="/config/theme/" data-v-e06ddb34><!--[--><!----> 简体中文 <!----><!--]--><!--[--><!--]--><!----></a></div><!--]--></div><div class="group appearance" data-v-7e94ae84><div class="item appearance" data-v-7e94ae84><p class="label" data-v-7e94ae84>Appearance</p><div class="appearance-action" data-v-7e94ae84><button class="vp-switch vp-switch-appearance" type="button" role="switch" aria-checked="false" title data-v-7e94ae84 data-v-cbe77d87 data-v-36bbbf22><span class="check" data-v-36bbbf22><span class="icon" data-v-36bbbf22><!--[--><span class="vpi-sun sun" data-v-cbe77d87></span><span class="vpi-moon moon" data-v-cbe77d87></span><!--]--></span></span></button></div></div></div><div class="group social" data-v-7e94ae84><div class="item social-links" data-v-7e94ae84><div class="vp-social-links social-links-list" data-v-7e94ae84 data-v-5dc0805d><!--[--><a class="vp-social-link no-icon" href="https://github.com/pengzhanbo/vuepress-theme-plume" aria-label="github" title="github" target="_blank" rel="noopener" data-v-5dc0805d data-v-c5bc2a09><span class="vp-icon vpi-simple-icons-github" style="" aria-hidden data-provider="iconify" data-v-c5bc2a09></span></a><a class="vp-social-link no-icon" href="https://qm.qq.com/q/FbPPoOIscE" aria-label="qq" title="qq" target="_blank" rel="noopener" data-v-5dc0805d data-v-c5bc2a09><span class="vp-icon vpi-simple-icons-qq" style="" aria-hidden data-provider="iconify" data-v-c5bc2a09></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="vp-navbar-hamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="nav-screen" data-v-b90976a4 data-v-2122c19e><span class="container" data-v-2122c19e><span class="top" data-v-2122c19e></span><span class="middle" data-v-2122c19e></span><span class="bottom" data-v-2122c19e></span></span></button></div></div></div></div><div class="divider" data-v-b90976a4><div class="divider-line" data-v-b90976a4></div></div></div><!----></header><div class="vp-local-nav reached-top has-sidebar" data-v-a5aadcf6 data-v-5171e520><button class="menu" aria-expanded="false" aria-controls="SidebarNav" data-v-5171e520><span class="vpi-align-left menu-icon" data-v-5171e520></span><span class="menu-text" data-v-5171e520>Menu</span></button><div class="vp-local-nav-outline-dropdown" style="--vp-vh:0px;" data-v-5171e520 data-v-d5044118><!----><!----></div></div><!--[--><aside class="vp-sidebar" vp-sidebar data-v-28af193e><div class="curtain" data-v-28af193e></div><nav id="SidebarNav" class="nav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-28af193e><span id="sidebar-aria-label" class="visually-hidden" data-v-28af193e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-71ba64cb><section class="vp-sidebar-item sidebar-item level-0 collapsible has-active" data-v-71ba64cb data-v-ab4803a9><div class="item" role="button" tabindex="0" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><h2 class="text" data-v-ab4803a9><span data-v-ab4803a9>Configuration</span><!----></h2><button type="button" class="caret" aria-label="Collapse Configuration" aria-expanded="true" tabindex="-1" data-v-ab4803a9><span class="vpi-chevron-right caret-icon" data-v-ab4803a9></span></button></div><div data-v-ab4803a9 data-v-ab4803a9><div class="items" data-v-ab4803a9><!--[--><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/intro/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Configuration Guide</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/theme/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Theme Configuration</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/locales/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Locales Configuration</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/navigation/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Navbar Configuration</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/sidebar/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Sidebar Configuration</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/collections/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Collections Configuration</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/markdown/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Markdown Configuration</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><!--]--></div></div></section></div><div class="no-transition group" data-v-71ba64cb><section class="vp-sidebar-item sidebar-item level-0 collapsible" data-v-71ba64cb data-v-ab4803a9><div class="item" role="button" tabindex="0" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><h2 class="text" data-v-ab4803a9><span data-v-ab4803a9>Page Configuration</span><!----></h2><button type="button" class="caret" aria-label="Collapse Page Configuration" aria-expanded="true" tabindex="-1" data-v-ab4803a9><span class="vpi-chevron-right caret-icon" data-v-ab4803a9></span></button></div><div data-v-ab4803a9 data-v-ab4803a9><div class="items" data-v-ab4803a9><!--[--><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/frontmatter/basic/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>General Configuration</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/frontmatter/home/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Homepage</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/frontmatter/article/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Posts Article</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/frontmatter/friends/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Friends Links Page</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><!--]--></div></div></section></div><div class="no-transition group" data-v-71ba64cb><section class="vp-sidebar-item sidebar-item level-0 collapsible" data-v-71ba64cb data-v-ab4803a9><div class="item" role="button" tabindex="0" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><h2 class="text" data-v-ab4803a9><span data-v-ab4803a9>Built-in Plugins</span><!----></h2><button type="button" class="caret" aria-label="Collapse Built-in Plugins" aria-expanded="true" tabindex="-1" data-v-ab4803a9><span class="vpi-chevron-right caret-icon" data-v-ab4803a9></span></button></div><div data-v-ab4803a9 data-v-ab4803a9><div class="items" data-v-ab4803a9><!--[--><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Introduction</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/code-highlight/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Code Highlighting</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/search/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Content Search</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/reading-time/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Reading Statistics</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/llmstxt/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>LLMs txt</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/markdown-enhance/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Markdown Enhance</span><span class="vp-badge danger vp-menu-badge" style="" data-v-ab4803a9 data-v-52c8341f><!--[-->Deprecated<!--]--></span></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/markdown-power/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Markdown Power</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/markdown-image/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Markdown Image</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/markdown-math/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Markdown Math</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/plugins/markdown-include/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Markdown Include</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><div class="vp-sidebar-item sidebar-item level-1 is-link" data-v-ab4803a9 data-v-ab4803a9><div class="item" data-v-ab4803a9><div class="indicator" data-v-ab4803a9></div><!----><a class="vp-link link link" href="/en/config/watermark/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Watermark</span><!----></p><!--]--><!--[--><!--]--><!----></a><!----></div><!----></div><!--]--></div></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="vp-sidebar-control" data-v-28af193e><button type="button" class="toggle-sidebar-btn" aria-label="Toggle sidebar" data-v-28af193e><span class="vpi-sidebar-close" data-v-28af193e></span></button></div><!--]--><!--[--><div id="VPContent" vp-content class="vp-content has-sidebar" data-v-a5aadcf6 data-v-d3283ff2><div class="vp-doc-container has-sidebar has-aside" data-v-d3283ff2 data-v-c2acd915><!--[--><!--]--><div class="container" data-v-c2acd915><div class="aside" vp-outline data-v-c2acd915><div class="aside-curtain" data-v-c2acd915></div><div class="aside-container" data-v-c2acd915><div class="aside-content" data-v-c2acd915><div class="vp-doc-aside" data-v-c2acd915 data-v-8e9ccc00><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="vp-doc-aside-outline" role="navigation" data-v-8e9ccc00 data-v-c71a8a7e><div class="content" data-v-c71a8a7e><div class="outline-marker" data-v-c71a8a7e></div><div id="doc-outline-aria-label" aria-level="2" class="outline-title" role="heading" data-v-c71a8a7e><span data-v-c71a8a7e>On this page</span><span class="vpi-print icon" data-v-c71a8a7e></span></div><ul class="root" data-v-c71a8a7e data-v-875470cb><!--[--><!--]--></ul></div></nav><!--[--><!--[--><!--[--><!--[--><div class="aside-nav-wrapper" data-v-a5aadcf6 data-v-44a708ba><a class="vp-link link no-icon vp-external-link-icon link" href="https://github.com/pengzhanbo/vuepress-theme-plume" target="_blank" rel="noopener noreferrer" data-v-44a708ba><!--[--><span class="vp-icon vpi-tabler-star" style="" aria-hidden data-provider="iconify" data-v-44a708ba></span><span class="link-text" data-v-44a708ba>Star on GitHub</span><span class="vpi-arrow-right" data-v-44a708ba></span><!--]--><!--[--><!--]--><!----></a><a class="vp-link link no-icon vp-external-link-icon link" href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/new/choose" target="_blank" rel="noopener noreferrer" data-v-44a708ba><!--[--><span class="vp-icon vpi-octicon-issue-opened-16" style="" aria-hidden data-provider="iconify" data-v-44a708ba></span><span class="link-text" data-v-44a708ba>Create Issues</span><span class="vpi-arrow-right" data-v-44a708ba></span><!--]--><!--[--><!--]--><!----></a><a class="vp-link link link" href="/sponsor/" data-v-44a708ba><!--[--><span class="vp-icon vpi-ep-milk-tea" style="" aria-hidden data-provider="iconify" data-v-44a708ba></span><span class="link-text" data-v-44a708ba>Buy me a Bubble Tea</span><span class="vpi-arrow-right" data-v-44a708ba></span><!--]--><!--[--><!--]--><!----></a></div><!--]--><!--]--><!--]--><!--]--><div class="spacer" data-v-8e9ccc00></div><!--[--><!--]--></div></div></div></div><div class="content" data-v-c2acd915><div class="content-container" data-v-c2acd915><!--[--><!--]--><main class="main" data-v-c2acd915><nav class="vp-breadcrumb" data-v-c2acd915 data-v-68dbda29><ol vocab="https://schema.org/" typeof="BreadcrumbList" data-v-68dbda29><!--[--><li property="itemListElement" typeof="ListItem" data-v-68dbda29><a class="vp-link link no-icon breadcrumb" href="/en/" property="item" typeof="WebPage" data-v-68dbda29><!--[-->Home<!--]--><!--[--><!--]--><!----></a><span class="vpi-chevron-right" data-v-68dbda29></span><meta property="name" content="Home" data-v-68dbda29><meta property="position" content="1" data-v-68dbda29></li><li property="itemListElement" typeof="ListItem" data-v-68dbda29><span class="vp-link no-icon breadcrumb" property="item" typeof="WebPage" data-v-68dbda29><!--[-->Config<!--]--><!--[--><!--]--><!----></span><span class="vpi-chevron-right" data-v-68dbda29></span><meta property="name" content="Config" data-v-68dbda29><meta property="position" content="2" data-v-68dbda29></li><li property="itemListElement" typeof="ListItem" data-v-68dbda29><a class="vp-link link no-icon breadcrumb current" href="/en/config/theme/" property="item" typeof="WebPage" data-v-68dbda29><!--[-->Theme Configuration<!--]--><!--[--><!--]--><!----></a><!----><meta property="name" content="Theme Configuration" data-v-68dbda29><meta property="position" content="3" data-v-68dbda29></li><!--]--></ol></nav><!--[--><!--]--><!--[--><div class="vp-doc-title" data-v-42fa9e7c><!--[--><!--]--><h1 class="page-title" data-v-42fa9e7c><!----> Theme Configuration <!----></h1><!--[--><!--[--><!--[--><!--[--><div class="vp-page-context-menu" data-v-a5aadcf6 data-v-b0188d12><div class="page-context-button" type="button" data-v-b0188d12><span class="page-context-copy" data-v-b0188d12><span class="vpi-copy" data-v-b0188d12></span><span class="text" data-v-b0188d12>Copy page</span></span><span class="page-context-toggle" data-v-b0188d12><span class="vpi-chevron-down" data-v-b0188d12></span></span></div><ul class="page-context-menu" style="display:none;" data-v-b0188d12><li data-v-b0188d12><a href="javascript:void(0)" data-v-b0188d12><span class="vpi-copy" data-v-b0188d12></span><span data-v-b0188d12>Copy page <small data-v-b0188d12>Copy page as Markdown for LLMs</small></span></a></li><!--[--><li data-v-b0188d12><a href="/en/config/theme/index.md" target="_blank" rel="noopener noreferrer" aria-label="View as Markdown" type="text/markdown" data-allow-mismatch data-v-b0188d12><span class="vpi-markdown" data-v-b0188d12></span><span data-v-b0188d12>View as Markdown <span class="vpi-external-link" data-v-b0188d12></span><small data-v-b0188d12>View this page as plain text</small></span></a></li><li data-v-b0188d12><a href="https://chat.openai.com/?prompt=" target="_blank" rel="noopener noreferrer" aria-label="Open in ChatGPT" data-allow-mismatch data-v-b0188d12><span class="vpi-chatgpt" data-v-b0188d12></span><span data-v-b0188d12>Open in ChatGPT <span class="vpi-external-link" data-v-b0188d12></span><small data-v-b0188d12>Ask ChatGPT about this page</small></span></a></li><li data-v-b0188d12><a href="https://claude.ai/new?q=" target="_blank" rel="noopener noreferrer" aria-label="Open in Claude" data-allow-mismatch data-v-b0188d12><span class="vpi-claude" data-v-b0188d12></span><span data-v-b0188d12>Open in Claude <span class="vpi-external-link" data-v-b0188d12></span><small data-v-b0188d12>Ask Claude about this page</small></span></a></li><li data-v-b0188d12><a href="https://perplexity.ai/?q=" target="_blank" rel="noopener noreferrer" aria-label="Open in Perplexity" data-allow-mismatch data-v-b0188d12><span class="vpi-perplexity" data-v-b0188d12></span><span data-v-b0188d12>Open in Perplexity <span class="vpi-external-link" data-v-b0188d12></span><small data-v-b0188d12>Ask Perplexity about this page</small></span></a></li><!--]--></ul></div><!--]--><!--]--><!--]--><!--]--></div><div class="vp-doc-meta" data-v-42fa9e7c><!--[--><!--]--><p class="reading-time" data-v-42fa9e7c><span class="vpi-books icon" data-v-42fa9e7c></span><span data-v-42fa9e7c>About 2590 words</span><span data-v-42fa9e7c>About 9 min</span></p><!----><!--[--><!--]--><p class="create-time" data-v-42fa9e7c><span class="vpi-clock icon" data-v-42fa9e7c></span><span data-v-42fa9e7c>2025-10-09</span></p></div><!--]--><!--[--><!--]--><!--[--><div class="_en_config_theme_ external-link-icon-enabled vp-doc plume-content" vp-content data-v-c2acd915><!--[--><!--]--><div data-v-c2acd915><h2 id="overview" tabindex="-1"><a class="header-anchor" href="#overview"><span>Overview</span></a></h2><p>Theme configuration is used to customize various features of the theme and control its behavior. You can configure it in either <code>.vuepress/config.ts</code> or <code>.vuepress/plume.config.ts</code>.</p><p>When a field description includes the following statement, it indicates that the field is not supported for configuration in <code>.vuepress/plume.config.ts</code>:</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div><p>For fields without the above declaration, you can configure them in either <code>.vuepress/config.ts</code> or <code>.vuepress/plume.config.ts</code>. It is generally recommended to configure them in <code>.vuepress/plume.config.ts</code>.</p><div class="hint-container warning"><p class="hint-container-title">Avoid reconfiguring a field that has already been configured in one configuration file within another configuration file.</p></div><div class="vp-code-tabs"><div class="vp-code-tabs-nav" role="tablist"><!--[--><button class="active vp-code-tab-nav" type="button" role="tab" aria-controls="codetab-16-0" aria-selected="true"><!--[--><span class="vp-icon vpi-vscode-icons-file-type-typescript bg" style="" aria-hidden data-provider="iconify"></span><span>.vuepress/config.ts</span><!--]--></button><button class="vp-code-tab-nav" type="button" role="tab" aria-controls="codetab-16-1" aria-selected="false"><!--[--><span class="vp-icon vpi-vscode-icons-file-type-typescript bg" style="" aria-hidden data-provider="iconify"></span><span>.vuepress/plume.config.ts</span><!--]--></button><!--]--></div><!--[--><div id="codetab-16-0" class="active vp-code-tab" role="tabpanel" aria-expanded="true"><div class="vp-code-tab-title"><!--[--><span class="vp-icon vpi-vscode-icons-file-type-typescript bg" style="" aria-hidden data-provider="iconify"></span><span>.vuepress/config.ts</span><!--]--></div><!--[--><div class="language-ts" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code twoslash lsp"><code class="language-ts"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">import</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> </span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"><div class="v-popper v-popper--theme-twoslash v-popper--theme-dropdown twoslash-hover"><!--[--><!--[--><span>defineUserConfig</span><!--]--><div id="popper_0hg5rhmx_44hk5x" data-allow-mismatch class="v-popper__popper v-popper--theme-twoslash v-popper--theme-dropdown shiki twoslash-floating vp-copy-ignore vp-code v-popper__popper--hidden v-popper__popper--hide-to" style="position:absolute;transform:translate3d(0px,0px,0);" aria-hidden="false" tabindex="0" data-popper-placement><div class="v-popper__backdrop"></div><div class="v-popper__wrapper" style=""><div class="v-popper__inner"><!----></div><div class="v-popper__arrow-container" style="left:0px;top:0px;"><div class="v-popper__arrow-outer"></div><div class="v-popper__arrow-inner"></div></div></div></div><!--]--></div></span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> from</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">vuepress</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">import</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> </span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"><div class="v-popper v-popper--theme-twoslash v-popper--theme-dropdown twoslash-hover"><!--[--><!--[--><span>plumeTheme</span><!--]--><div id="popper_vl430ps5_44hk5y" data-allow-mismatch class="v-popper__popper v-popper--theme-twoslash v-popper--theme-dropdown shiki twoslash-floating vp-copy-ignore vp-code v-popper__popper--hidden v-popper__popper--hide-to" style="position:absolute;transform:translate3d(0px,0px,0);" aria-hidden="false" tabindex="0" data-popper-placement><div class="v-popper__backdrop"></div><div class="v-popper__wrapper" style=""><div class="v-popper__inner"><!----></div><div class="v-popper__arrow-container" style="left:0px;top:0px;"><div class="v-popper__arrow-outer"></div><div class="v-popper__arrow-inner"></div></div></div></div><!--]--></div></span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> from</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">vuepress-theme-plume</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"><div class="v-popper v-popper--theme-twoslash v-popper--theme-dropdown twoslash-hover"><!--[--><!--[--><span>defineUserConfig</span><!--]--><div id="popper_12xyawao_44hk5z" data-allow-mismatch class="v-popper__popper v-popper--theme-twoslash v-popper--theme-dropdown shiki twoslash-floating vp-copy-ignore vp-code v-popper__popper--hidden v-popper__popper--hide-to" style="position:absolute;transform:translate3d(0px,0px,0);" aria-hidden="false" tabindex="0" data-popper-placement><div class="v-popper__backdrop"></div><div class="v-popper__wrapper" style=""><div class="v-popper__inner"><!----></div><div class="v-popper__arrow-container" style="left:0px;top:0px;"><div class="v-popper__arrow-outer"></div><div class="v-popper__arrow-inner"></div></div></div></div><!--]--></div></span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"><div class="v-popper v-popper--theme-twoslash v-popper--theme-dropdown twoslash-hover"><!--[--><!--[--><span>theme</span><!--]--><div id="popper_lcm1zoly_44hk5z" data-allow-mismatch class="v-popper__popper v-popper--theme-twoslash v-popper--theme-dropdown shiki twoslash-floating vp-copy-ignore vp-code v-popper__popper--hidden v-popper__popper--hide-to" style="position:absolute;transform:translate3d(0px,0px,0);" aria-hidden="false" tabindex="0" data-popper-placement><div class="v-popper__backdrop"></div><div class="v-popper__wrapper" style=""><div class="v-popper__inner"><!----></div><div class="v-popper__arrow-container" style="left:0px;top:0px;"><div class="v-popper__arrow-outer"></div><div class="v-popper__arrow-inner"></div></div></div></div><!--]--></div></span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"><div class="v-popper v-popper--theme-twoslash v-popper--theme-dropdown twoslash-hover"><!--[--><!--[--><span>plumeTheme</span><!--]--><div id="popper_mt7tu3q9_44hk5z" data-allow-mismatch class="v-popper__popper v-popper--theme-twoslash v-popper--theme-dropdown shiki twoslash-floating vp-copy-ignore vp-code v-popper__popper--hidden v-popper__popper--hide-to" style="position:absolute;transform:translate3d(0px,0px,0);" aria-hidden="false" tabindex="0" data-popper-placement><div class="v-popper__backdrop"></div><div class="v-popper__wrapper" style=""><div class="v-popper__inner"><!----></div><div class="v-popper__arrow-container" style="left:0px;top:0px;"><div class="v-popper__arrow-outer"></div><div class="v-popper__arrow-inner"></div></div></div></div><!--]--></div></span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Theme configuration</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> })</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre></div><!--]--></div><div id="codetab-16-1" class="vp-code-tab" role="tabpanel" aria-expanded="false"><div class="vp-code-tab-title"><!--[--><span class="vp-icon vpi-vscode-icons-file-type-typescript bg" style="" aria-hidden data-provider="iconify"></span><span>.vuepress/plume.config.ts</span><!--]--></div><!--[--><div class="language-ts" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code twoslash lsp"><code class="language-ts"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">import</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> </span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"><div class="v-popper v-popper--theme-twoslash v-popper--theme-dropdown twoslash-hover"><!--[--><!--[--><span>defineThemeConfig</span><!--]--><div id="popper_oasrmzan_44hk60" data-allow-mismatch class="v-popper__popper v-popper--theme-twoslash v-popper--theme-dropdown shiki twoslash-floating vp-copy-ignore vp-code v-popper__popper--hidden v-popper__popper--hide-to" style="position:absolute;transform:translate3d(0px,0px,0);" aria-hidden="false" tabindex="0" data-popper-placement><div class="v-popper__backdrop"></div><div class="v-popper__wrapper" style=""><div class="v-popper__inner"><!----></div><div class="v-popper__arrow-container" style="left:0px;top:0px;"><div class="v-popper__arrow-outer"></div><div class="v-popper__arrow-inner"></div></div></div></div><!--]--></div></span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> from</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">vuepress-theme-plume</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"><div class="v-popper v-popper--theme-twoslash v-popper--theme-dropdown twoslash-hover"><!--[--><!--[--><span>defineThemeConfig</span><!--]--><div id="popper_05irvsvr_44hk60" data-allow-mismatch class="v-popper__popper v-popper--theme-twoslash v-popper--theme-dropdown shiki twoslash-floating vp-copy-ignore vp-code v-popper__popper--hidden v-popper__popper--hide-to" style="position:absolute;transform:translate3d(0px,0px,0);" aria-hidden="false" tabindex="0" data-popper-placement><div class="v-popper__backdrop"></div><div class="v-popper__wrapper" style=""><div class="v-popper__inner"><!----></div><div class="v-popper__arrow-container" style="left:0px;top:0px;"><div class="v-popper__arrow-outer"></div><div class="v-popper__arrow-inner"></div></div></div></div><!--]--></div></span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Theme configuration</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre></div><!--]--></div><!--]--></div><h2 id="basic-configuration" tabindex="-1"><a class="header-anchor" href="#basic-configuration"><span>Basic Configuration</span></a></h2><h3 id="configfile" tabindex="-1"><a class="header-anchor" href="#configfile"><span>configFile</span></a></h3><ul><li><p><strong>Type:</strong> <code>string</code></p></li><li><p><strong>Default:</strong> <code>''</code></p></li><li><p><strong>Details:</strong></p><p>Custom path to the theme configuration file.</p><p>Refer to <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a> for more information.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="plugins" tabindex="-1"><a class="header-anchor" href="#plugins"><span>plugins</span></a></h3><ul><li><p><strong>Type:</strong> <code>PlumeThemePluginOptions</code></p></li><li><p><strong>Default:</strong> <code>{}</code></p></li><li><p><strong>Details:</strong></p><p>Custom configuration for plugins used internally by the theme.</p><p>The plugins used by the theme are configured by default. In most cases, modification is not required. For detailed customization, please refer to <a class="vp-link link" href="/en/config/plugins/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="markdown" tabindex="-1"><a class="header-anchor" href="#markdown"><span>markdown <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.136 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>MarkdownOptions</code></p></li><li><p><strong>Default:</strong> <code>{}</code></p></li><li><p><strong>Details:</strong></p><p>Markdown feature configuration. Refer to <a class="vp-link link" href="/en/config/markdown/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="codehighlighter" tabindex="-1"><a class="header-anchor" href="#codehighlighter"><span>codeHighlighter <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.136 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>false | ShikiPluginOptions</code></p></li><li><p><strong>Default:</strong> <code>{}</code></p></li><li><p><strong>Details:</strong></p><p>Code highlighting configuration. Refer to <a class="vp-link link" href="/en/guide/code/intro/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="search" tabindex="-1"><a class="header-anchor" href="#search"><span>search <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.136 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>false | SearchOptions</code></p></li><li><p><strong>Default:</strong> <code>{ provider: 'local' }</code></p></li><li><p><strong>Details:</strong></p><p>Search configuration. Refer to <a class="vp-link link" href="/en/guide/features/content-search/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="comment" tabindex="-1"><a class="header-anchor" href="#comment"><span>comment <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.136 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>false | CommentPluginOptions</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong></p><p>Comment configuration. Refer to <a class="vp-link link" href="/en/guide/features/comments/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="watermark" tabindex="-1"><a class="header-anchor" href="#watermark"><span>watermark <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.136 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>false | WatermarkPluginOptions</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong></p><p>Watermark configuration. Refer to <a class="vp-link link" href="/en/guide/features/watermark/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="readingtime" tabindex="-1"><a class="header-anchor" href="#readingtime"><span>readingTime <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.136 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>false | ReadingTimePluginOptions</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong></p><p>Reading time configuration. Refer to <a class="vp-link link" href="/en/config/plugins/reading-time/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="copycode" tabindex="-1"><a class="header-anchor" href="#copycode"><span>copyCode <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.136 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>false | CopyCodePluginOptions</code></p></li><li><p><strong>Default:</strong> <code>{}</code></p></li><li><p><strong>Details:</strong></p><p>Copy code configuration. Refer to <a class="vp-link link" href="/en/guide/code/copy-code/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="replaceassets" tabindex="-1"><a class="header-anchor" href="#replaceassets"><span>replaceAssets <span class="vp-badge tip" style="" data-v-52c8341f><!--[-->1.0.0-rc.139 +<!--]--></span></span></a></h3><ul><li><p><strong>Type:</strong> <code>false | ReplaceAssetsPluginOptions</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong></p><p>Replace assets configuration. Refer to <a class="vp-link link" href="/en/guide/features/replace-assets/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="hostname" tabindex="-1"><a class="header-anchor" href="#hostname"><span>hostname</span></a></h3><ul><li><p><strong>Type:</strong> <code>string</code></p></li><li><p><strong>Default:</strong> <code>''</code></p></li><li><p><strong>Details:</strong></p><p>Deployment site domain name.</p><p>When <code>hostname</code> is configured to a valid domain, the theme will generate <code>sitemap</code> and SEO-related content.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="autofrontmatter" tabindex="-1"><a class="header-anchor" href="#autofrontmatter"><span>autoFrontmatter</span></a></h3><ul><li><p><strong>Type:</strong> <code>false | AutoFrontmatterOptions</code></p></li><li><p><strong>Details:</strong></p><p>Whether to automatically add frontmatter configuration to markdown files.</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> AutoFrontmatterOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to automatically generate permalink</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> true</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - true: auto generate permalink</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - false: do not generate permalink</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - 'filepath': generate permalink based on file path</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> permalink</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">filepath</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to automatically generate createTime</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Reads file creation time by default. `createTime` is more precise (to the second) than the default VuePress `date` field.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> createTime</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to automatically generate title</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Uses the filename as the title by default.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> title</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h3 id="cache" tabindex="-1"><a class="header-anchor" href="#cache"><span>cache</span></a></h3><ul><li><p><strong>Type:</strong> <code>false | 'memory' | 'filesystem'</code></p></li><li><p><strong>Default:</strong> <code>filesystem</code></p></li><li><p><strong>Details:</strong></p><p>Whether to enable compilation cache, or configure the caching method.</p><p>This configuration item addresses the slow startup speed of VuePress. It caches the compilation results during the first service start. On subsequent starts, it reads the cache directly, skipping compilation to speed up startup.</p><ul><li><code>false</code>: Disable cache.</li><li><code>'memory'</code>: Use memory cache. This method provides faster startup speed but increases memory usage as the number of project files grows. Suitable for projects with fewer articles.</li><li><code>'filesystem'</code>: Use filesystem cache. This method provides a relatively fast and stable startup speed, more suitable for projects with substantial content.</li></ul><div class="hint-container warning"><p class="hint-container-title">Warning</p><p>This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p><p>For the cache to take effect, you should <strong>remove</strong> the <code>--clean-cache</code> parameter from the <code>vuepress dev</code> development server startup script in your <code>package.json</code>.</p></div></li></ul><h3 id="docsrepo" tabindex="-1"><a class="header-anchor" href="#docsrepo"><span>docsRepo</span></a></h3><ul><li><strong>Type:</strong> <code>string</code></li><li><strong>Default:</strong> <code>''</code></li><li><strong>Details:</strong> Documentation repository configuration, used to generate the <code>Edit this page</code> link.</li></ul><h3 id="docsbranch" tabindex="-1"><a class="header-anchor" href="#docsbranch"><span>docsBranch</span></a></h3><ul><li><strong>Type:</strong> <code>string</code></li><li><strong>Default:</strong> <code>''</code></li><li><strong>Details:</strong> Documentation repository branch configuration, used to generate the <code>Edit this page</code> link.</li></ul><h3 id="docsdir" tabindex="-1"><a class="header-anchor" href="#docsdir"><span>docsDir</span></a></h3><ul><li><strong>Type:</strong> <code>string</code></li><li><strong>Default:</strong> <code>''</code></li><li><strong>Details:</strong> Documentation repository directory configuration, used to generate the <code>Edit this page</code> link.</li></ul><h3 id="editlink" tabindex="-1"><a class="header-anchor" href="#editlink"><span>editLink</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong> Whether to enable the edit link.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="lastupdated" tabindex="-1"><a class="header-anchor" href="#lastupdated"><span>lastUpdated</span></a></h3><ul><li><strong>Type:</strong> <code>false | LastUpdatedOptions</code></li><li><strong>Default:</strong> <code>{ formatOptions: { dateStyle: 'short', timeStyle: 'short' } }</code></li><li><strong>Details:</strong> Last updated time.</li></ul><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> LastUpdatedOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Options to set the format of the last updated time.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">see</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * { dateStyle: 'short', timeStyle: 'short' }</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> formatOptions</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">Intl</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">.</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">DateTimeFormatOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> & { </span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;">forceLocale</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div><h3 id="contributors" tabindex="-1"><a class="header-anchor" href="#contributors"><span>contributors</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | ContributorsOptions</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong> Whether to display contributors.</p><p>For more configuration, please refer to <a class="vp-link link" href="/en/guide/features/contributors/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="changelog" tabindex="-1"><a class="header-anchor" href="#changelog"><span>changelog</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | ChangelogOptions</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong> Whether to display page change history.</p><p>For more configuration, please refer to <a class="vp-link link" href="/en/guide/features/changelog/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><div class="hint-container warning"><p class="hint-container-title">This field is not supported for configuration in the <a class="vp-link link" href="/en/config/intro/#theme-config-file"><!--[-->Theme Config File <code>plume.config.js</code><!--]--><!--[--><!--]--><!----></a>.</p></div></li></ul><h3 id="locales" tabindex="-1"><a class="header-anchor" href="#locales"><span>locales</span></a></h3><ul><li><strong>Type:</strong> <code>Record<string, ThemeLocaleData></code></li><li><strong>Default:</strong> <code>{}</code></li><li><strong>Details:</strong> Multi-language configuration.</li></ul><p>Text configuration for different languages. Refer to <a class="vp-link link" href="/en/config/locales/"><!--[-->this documentation<!--]--><!--[--><!--]--><!----></a>.</p><p>The multi-language configuration supports all configuration options under the following <a href="#locale-configuration">Locale</a> to control theme behavior in different languages.</p><h2 id="locale-configuration" tabindex="-1"><a class="header-anchor" href="#locale-configuration"><span>Locale Configuration</span></a></h2><div class="hint-container tip"><p class="hint-container-title">All the following fields are also basic configuration fields and can be configured at the same level as fields like <code>locales</code>.</p></div><h3 id="home" tabindex="-1"><a class="header-anchor" href="#home"><span>home</span></a></h3><ul><li><strong>Type:</strong> <code>false | string</code></li><li><strong>Default:</strong> <code>/</code></li><li><strong>Details:</strong> The path to the home page. It will be used for: <ul><li>The logo link in the navbar;</li><li>The <em>Back to Home</em> link on the 404 page;</li></ul></li></ul><h3 id="logo" tabindex="-1"><a class="header-anchor" href="#logo"><span>logo</span></a></h3><ul><li><strong>Type:</strong> <code>false | string</code></li><li><strong>Default:</strong> <code>false</code></li><li><strong>Details:</strong> Logo in the navbar.</li></ul><h3 id="logodark" tabindex="-1"><a class="header-anchor" href="#logodark"><span>logoDark</span></a></h3><ul><li><strong>Type:</strong> <code>false | string</code></li><li><strong>Default:</strong> <code>false</code></li><li><strong>Details:</strong> Logo in the navbar for Dark mode.</li></ul><h3 id="appearance" tabindex="-1"><a class="header-anchor" href="#appearance"><span>appearance</span></a></h3><ul><li><strong>Type:</strong> <code>boolean | 'dark' | 'force-dark'</code></li><li><strong>Default:</strong> <code>true</code></li></ul><p>Whether to enable dark mode.</p><ul><li>If this option is set to <code>true</code>, the default theme will be determined by the user's preferred color scheme.</li><li>If this option is set to <code>dark</code>, the theme will be dark by default unless the user manually toggles it.</li><li>If this option is set to <code>false</code>, the user will not be able to switch themes.</li><li>If this option is set to <code>force-dark</code>, the user will not be able to switch themes, and the theme will be forced to dark.</li></ul><p>This option injects an inline script that restores user settings from local storage. This ensures <code>[data-theme="dark"]</code> is applied before the page is rendered to avoid flashing.</p><h3 id="profile" tabindex="-1"><a class="header-anchor" href="#profile"><span>profile</span></a></h3><ul><li><strong>Type:</strong> <code>ProfileOptions</code></li><li><strong>Default:</strong> <code>{}</code></li><li><strong>Details:</strong> Configure the site owner's personal information. <ul><li><code>profile.avatar</code>: Avatar URL, used for displaying blogger information on the right.</li><li><code>profile.name</code>: Name, used for displaying blogger information on the right.</li><li><code>profile.description</code>: Personal description, used for displaying blogger information on the right.</li><li><code>profile.circle</code>: Whether the avatar is circular.</li><li><code>profile.location</code>: User's geographical location.</li><li><code>profile.organization</code>: User's organization/company.</li><li><code>profile.layout</code>: Whether to display personal information on the left or right, <code>'left' | 'right'</code>.</li></ul></li></ul><p>Example:</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;">plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> profile</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> avatar</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/avatar.jpg</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> name</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Zhang San</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> description</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Here is no silver three hundred two, next door Wang Er never stole</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> circle</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">true</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> location</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Hangzhou, China</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> organization</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">XXX Company</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> layout</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">right</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> })</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="social" tabindex="-1"><a class="header-anchor" href="#social"><span>social</span></a></h3><ul><li><p><strong>Type:</strong> <code>false | SocialLink[]</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong> Personal social information configuration.</p><p>Displayed as icon links on the far right of the navbar.</p><p>Supports any icon from <a href="https://icon-sets.iconify.design/" target="_blank" rel="noopener noreferrer">Iconify</a>. Simply use the iconify name to load it automatically.</p><p>For icons in the <code>simple-icons</code> collection, you can omit the <code>simple-icons:</code> prefix. For example, <code>simple-icons:github</code> can be abbreviated as <code>github</code>.</p><p>Examples of common social icons:</p><div style="margin:16px 0;display:flex;gap:16px;"><div style="flex:1;"><ul><li>discord <span class="vp-icon vpi-simple-icons-discord" style="" aria-hidden data-provider="iconify"></span></li><li>telegram <span class="vp-icon vpi-simple-icons-telegram" style="" aria-hidden data-provider="iconify"></span></li><li>facebook <span class="vp-icon vpi-simple-icons-facebook" style="" aria-hidden data-provider="iconify"></span></li><li>github <span class="vp-icon vpi-simple-icons-github" style="" aria-hidden data-provider="iconify"></span></li><li>instagram <span class="vp-icon vpi-simple-icons-instagram" style="" aria-hidden data-provider="iconify"></span></li><li>linkedin <span class="vp-icon vpi-simple-icons-linkedin" style="" aria-hidden data-provider="iconify"></span></li><li>mastodon <span class="vp-icon vpi-simple-icons-mastodon" style="" aria-hidden data-provider="iconify"></span></li><li>npm <span class="vp-icon vpi-simple-icons-npm" style="" aria-hidden data-provider="iconify"></span></li><li>slack <span class="vp-icon vpi-simple-icons-slack" style="" aria-hidden data-provider="iconify"></span></li><li>twitter <span class="vp-icon vpi-simple-icons-twitter" style="" aria-hidden data-provider="iconify"></span></li><li>x <span class="vp-icon vpi-simple-icons-x" style="" aria-hidden data-provider="iconify"></span></li><li>youtube <span class="vp-icon vpi-simple-icons-youtube" style="" aria-hidden data-provider="iconify"></span></li><li>bluesky <span class="vp-icon vpi-simple-icons-bluesky" style="" aria-hidden data-provider="iconify"></span></li><li>tiktok <span class="vp-icon vpi-simple-icons-tiktok" style="" aria-hidden data-provider="iconify"></span></li></ul></div><div style="flex:1;"><ul><li>qq <span class="vp-icon vpi-simple-icons-qq" style="" aria-hidden data-provider="iconify"></span></li><li>weibo <span class="vp-icon vpi-simple-icons-sinaweibo" style="" aria-hidden data-provider="iconify"></span></li><li>bilibili <span class="vp-icon vpi-simple-icons-bilibili" style="" aria-hidden data-provider="iconify"></span></li><li>gitlab <span class="vp-icon vpi-simple-icons-gitlab" style="" aria-hidden data-provider="iconify"></span></li><li>docker <span class="vp-icon vpi-simple-icons-docker" style="" aria-hidden data-provider="iconify"></span></li><li>juejin <span class="vp-icon vpi-simple-icons-juejin" style="" aria-hidden data-provider="iconify"></span></li><li>zhihu <span class="vp-icon vpi-simple-icons-zhihu" style="" aria-hidden data-provider="iconify"></span></li><li>douban <span class="vp-icon vpi-simple-icons-douban" style="" aria-hidden data-provider="iconify"></span></li><li>steam <span class="vp-icon vpi-simple-icons-steam" style="" aria-hidden data-provider="iconify"></span></li><li>stackoverflow <span class="vp-icon vpi-simple-icons-stackoverflow" style="" aria-hidden data-provider="iconify"></span></li><li>xbox <span class="vp-icon vpi-simple-icons-xbox" style="" aria-hidden data-provider="iconify"></span></li><li>kuaishou <span class="vp-icon vpi-simple-icons-kuaishou" style="" aria-hidden data-provider="iconify"></span></li><li>twitch <span class="vp-icon vpi-simple-icons-twitch" style="" aria-hidden data-provider="iconify"></span></li><li>xiaohongshu <span class="vp-icon vpi-simple-icons-xiaohongshu" style="" aria-hidden data-provider="iconify"></span></li></ul></div></div><p><a href="https://icon-sets.iconify.design/simple-icons/" class="readmore" target="_blank" rel="noopener noreferrer">You can view all available icons for <strong>simple-icons</strong> here</a></p><p>If <strong>Iconify</strong> does not meet your needs, you can pass in the format <code>{ svg: string, name?: string }</code> to use a custom icon. Pass in the SVG source code string, with the optional <code>name</code> field for configuring <a href="#navbarsocialinclude"><code>navbarSocialInclude</code></a>.</p></li></ul><p>Example:</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;">plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> social</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: [</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // use iconify name</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> { </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">icon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">github</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">, </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">https://github.com/zhangsan</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // use custom icon</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> icon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: { </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">svg</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;"><svg>xxxxx</svg></span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">, </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">name</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">xxx</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">https://xxx.com</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ]</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> })</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="navbarsocialinclude" tabindex="-1"><a class="header-anchor" href="#navbarsocialinclude"><span>navbarSocialInclude</span></a></h3><ul><li><p><strong>Type:</strong> <code>string[]</code></p></li><li><p><strong>Default:</strong> <code>['github', 'twitter', 'discord', 'facebook']</code></p></li><li><p><strong>Details:</strong></p><p>Social links allowed to be displayed in the navbar. This configuration is only effective on PC.</p><p>If <a href="#social"><code>social</code></a> is configured as <code>{ svg: string, name: string}</code>, then <code>name</code> can be used as a value for <code>navbarSocialInclude</code>.</p></li></ul><h3 id="navbar" tabindex="-1"><a class="header-anchor" href="#navbar"><span>navbar</span></a></h3><ul><li><p><strong>Type:</strong> <code>NavItem[]</code></p></li><li><p><strong>Default:</strong> <code>[]</code></p></li><li><p><strong>Details:</strong> Navbar configuration.</p><p>To configure navbar elements, you can set it to a navbar array, where each element is a <code>string</code> or a <code>NavItem</code> object.</p><ul><li>A <code>NavItem</code> object should have a <code>text</code> field and a <code>link</code> field, with an optional <code>activeMatch</code> field.</li><li>A <code>string</code> represents a page file path or a page access path.</li></ul></li></ul><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">type</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> NavItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> =</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * The page prefix for the current group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> prefix</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Navigation items under this group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> items</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">NavItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[]</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Supports iconify icons. Use the iconify name directly and it will be loaded automatically.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">see</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> https://icon-sets.iconify.design/</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> icon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Controls when the element is active.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> activeMatch</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li><p>Example 1:</p><div class="language-js line-numbers-mode" data-highlighter="shiki" data-ext="js" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-js"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> navbar</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // NavbarItem</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Foo</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // NavbarGroup</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Group</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> prefix</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/group/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">bar/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // String - page file path</span></span>
|
|
<span class="line"><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/bar</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // The `.md` extension can be omitted directly.</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }),</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>Example 2:</p><div class="language-js line-numbers-mode" data-highlighter="shiki" data-ext="js" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-js"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> navbar</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Nested Group - maximum depth is 2</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Group</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">SubGroup</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/group/sub/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/group/sub/bar/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Control when the element is active</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Group 2</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Always active</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // This element will always be active</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> activeMatch</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Active on /foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/not-foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // This element is active when the current route path starts with /foo/</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Supports regular expressions</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> activeMatch</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">^/foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }),</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h3 id="collections" tabindex="-1"><a class="header-anchor" href="#collections"><span>collections</span></a></h3><ul><li><p><strong>Type:</strong> <code>ThemeCollectionItem[]</code></p></li><li><p><strong>Default:</strong> <code>[]</code></p></li><li><p><strong>Details:</strong> Documentation collections configuration.</p><p><a class="vp-link link read-more" href="/en/guide/collection/"><!--[-->Check <strong>Collections Guide</strong><!--]--><!--[--><!--]--><!----></a></p><p><a class="vp-link link read-more" href="/en/config/collections/"><!--[-->Check <strong>Collections Configuration</strong> to learn more<!--]--><!--[--><!--]--><!----></a></p></li></ul><h3 id="sidebar" tabindex="-1"><a class="header-anchor" href="#sidebar"><span>sidebar</span></a></h3><ul><li><p><strong>Type:</strong> <code>false | SidebarMulti</code></p></li><li><p><strong>Details:</strong></p><p>Sidebar configuration. <strong>The theme recommends configuring the sidebar in <a class="vp-link link" href="/en/config/collections/"><!--[-->collections configuration<!--]--><!--[--><!--]--><!----></a>.</strong></p><p>The <code>key</code> of the configuration object is the common access path prefix for the sidebar.</p><p>For <code>value</code>:</p><ul><li><code>'auto'</code> means automatically generate the sidebar based on the directory structure.</li><li><code>string</code> represents the page file path corresponding to the sidebar.</li><li><code>SidebarItem</code> represents a single sidebar item configuration.</li></ul></li></ul><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">type</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> ThemeIcon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> =</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> svg</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">type</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> SidebarMulti</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> =</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> Record</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"><</span></span>
|
|
<span class="line"><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">auto</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> (</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)[]</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">auto</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | (</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)[],</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> prefix</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">></span></span>
|
|
<span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Sidebar text.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> text</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Sidebar link.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> link</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Sidebar icon.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> icon</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">ThemeIcon</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Nested sidebar group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> items</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">auto</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | (</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)[]</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * If not specified, the group is not collapsible.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * If `true`, the group is collapsible and collapsed by default.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * If `false`, the group is collapsible but expanded by default.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> collapsed</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Link prefix for the current group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> prefix</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> rel</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> target</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="sidebarscrollbar" tabindex="-1"><a class="header-anchor" href="#sidebarscrollbar"><span>sidebarScrollbar</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong> Whether to show the sidebar scrollbar.</p><p>When set to <code>false</code>, only the scrollbar is hidden, but the scrolling behavior remains unchanged.</p></li></ul><h3 id="aside" tabindex="-1"><a class="header-anchor" href="#aside"><span>aside</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | 'left'</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong></p><p>Whether to display the aside (right sidebar).</p><ul><li><code>false</code> disables the right aside.</li><li><code>true</code> enables the right aside.</li><li><code>'left'</code> moves the right aside to the left side of the article content, to the right of the main sidebar.</li></ul><p>Each page can override this global configuration via <a class="vp-link link" href="/en/config/frontmatter/basic/#aside"><!--[-->frontmatter aside<!--]--><!--[--><!--]--><!----></a>.</p></li></ul><h3 id="outline" tabindex="-1"><a class="header-anchor" href="#outline"><span>outline</span></a></h3><ul><li><p><strong>Type:</strong> <code>false | number | [number, number] | 'deep'</code></p></li><li><p><strong>Default:</strong> <code>[2, 3]</code></p></li><li><p><strong>Details:</strong></p><p>The heading levels to display.</p><p>A single number means only display headings of that level.</p><p>If a tuple is passed, the first number is the minimum level and the second is the maximum level.</p><p><code>'deep'</code> is the same as <code>[2, 6]</code>, which displays all headings from <code><h2></code> to <code><h6></code>.</p><p>When <a href="#aside">aside</a> is disabled, <code>outline</code> is also disabled.</p><p>Each page can override this global configuration via <a class="vp-link link" href="/en/config/frontmatter/basic/#outline"><!--[-->frontmatter outline<!--]--><!--[--><!--]--><!----></a>.</p></li></ul><h3 id="transition" tabindex="-1"><a class="header-anchor" href="#transition"><span>transition</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | TransitionOptions</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong></p><p>Whether to enable transition animations.</p><p>When passing a <code>boolean</code>, <code>true</code> enables and <code>false</code> disables.</p><p>An object can also be passed for specific configuration, as shown below.</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> TransitionOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to enable page transition animations.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> true</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> page</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to enable blog post list transition animations.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> true</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> postList</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to enable dark/light mode switch transition animations,</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * or configure the transition animation type.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;">fade</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> appearance</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">fade</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">circle-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">horizontal-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">vertical-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">skew-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">blinds-vertical</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">blinds-horizontal</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">soft-blur-fade</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">diamond-reveal</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h3 id="footer" tabindex="-1"><a class="header-anchor" href="#footer"><span>footer</span></a></h3><ul><li><strong>Type:</strong> <code>false | { message: string; copyright: string }</code></li><li><strong>Default:</strong> <code>false</code></li><li><strong>Details:</strong> Footer configuration.</li></ul><h3 id="bulletin" tabindex="-1"><a class="header-anchor" href="#bulletin"><span>bulletin</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | BulletinOptions</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong> Bulletin board configuration.</p><p>For details, please refer to <a class="vp-link link" href="/en/guide/features/bulletin/"><!--[-->Bulletin Board<!--]--><!--[--><!--]--><!----></a>.</p></li></ul><h3 id="editlinkpattern" tabindex="-1"><a class="header-anchor" href="#editlinkpattern"><span>editLinkPattern</span></a></h3><ul><li><p><strong>Type:</strong> <code>string</code></p></li><li><p><strong>Default:</strong> <code>''</code></p></li><li><p><strong>Details:</strong> Regular expression for the edit link.</p><p>Example: <code>':repo/edit/:branch/:path'</code></p></li></ul><h3 id="copyright" tabindex="-1"><a class="header-anchor" href="#copyright"><span>copyright</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | CopyrightLicense | CopyrightOptions</code></p></li><li><p><strong>Default:</strong> <code>false</code></p></li><li><p><strong>Details:</strong> Copyright configuration.</p><p>For details, please refer to <a class="vp-link link" href="/en/guide/features/copyright/"><!--[-->Copyright<!--]--><!--[--><!--]--><!----></a>.</p></li></ul><h3 id="prevpage" tabindex="-1"><a class="header-anchor" href="#prevpage"><span>prevPage</span></a></h3><ul><li><strong>Type:</strong> <code>boolean</code></li><li><strong>Default:</strong> <code>true</code></li><li><strong>Details:</strong> Whether to show the previous page link.</li></ul><h3 id="nextpage" tabindex="-1"><a class="header-anchor" href="#nextpage"><span>nextPage</span></a></h3><ul><li><strong>Type:</strong> <code>boolean</code></li><li><strong>Default:</strong> <code>true</code></li><li><strong>Details:</strong> Whether to show the next page link.</li></ul><h3 id="createtime" tabindex="-1"><a class="header-anchor" href="#createtime"><span>createTime</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | 'only-posts'</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong> Whether to display the creation time.</p><ul><li><code>false</code> - Do not display.</li><li><code>'only-posts'</code> - Only display on blog post list pages.</li><li><code>true</code> - Display on all article pages.</li></ul></li></ul></div><!--[--><h2 id="doc-contributors" tabindex="-1"><a href="#doc-contributors" class="header-anchor"><span>Contributors</span></a></h2><div class="vp-contributors"><a href="https://github.com/pengzhanbo" target="_blank" rel="noreferrer" class="vp-contributor"><img src="https://avatars.githubusercontent.com/pengzhanbo?v=4" alt class="vp-contributor-avatar"><span class="vp-contributor-name">pengzhanbo</span></a></div><!--]--><!--[--><h2 id="doc-changelog" tabindex="-1"><a href="#doc-changelog" class="header-anchor"><span>Changelog</span></a></h2><div class="vp-changelog-wrapper"><div class="vp-changelog-header"><div class="vp-latest-updated"><span class="vp-changelog-icon"></span><span data-allow-mismatch>1/19/26, 1:43 PM</span></div><div><span class="vp-changelog-menu-icon"></span><span>View All Changelog</span></div></div><ul class="vp-changelog-list"><!--[--><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/a3d8e225b96b8950d72ba6bb1a43cfecd926afd5" target="_blank" rel="noreferrer"><code>a3d8e</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">feat(theme): add filepath permalink support for auto frontmatter, <a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/815" target="_blank" rel="noopener noreferrer">#815</a> (<a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/822" target="_blank" rel="noopener noreferrer">#822</a>)</span><span class="vp-changelog-date" data-allow-mismatch>on <time datetime="2026-01-19T13:43:41.000Z">1/19/26</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/95d345bf6d3f738f1c44ac6db5cbe95f68d590e4" target="_blank" rel="noreferrer"><code>95d34</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">refactor(theme): social icon support all iconify icons, close <a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/781" target="_blank" rel="noopener noreferrer">#781</a> (<a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/790" target="_blank" rel="noopener noreferrer">#790</a>)</span><span class="vp-changelog-date" data-allow-mismatch>on <time datetime="2025-12-12T12:40:50.000Z">12/12/25</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/1503a20fbe41f5ba73f975ef16a602583b1d8f35" target="_blank" rel="noreferrer"><code>1503a</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">feat(theme): optimize view transition (<a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/725" target="_blank" rel="noopener noreferrer">#725</a>)</span><span class="vp-changelog-date" data-allow-mismatch>on <time datetime="2025-10-15T04:34:16.000Z">10/15/25</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/385059f214cb07fc9a098859e889432fb81f998b" target="_blank" rel="noreferrer"><code>38505</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">docs: update en docs (<a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/708" target="_blank" rel="noopener noreferrer">#708</a>)</span><span class="vp-changelog-date" data-allow-mismatch>on <time datetime="2025-10-09T07:46:05.000Z">10/9/25</time></span></li><!--]--></ul></div><!--]--><!----><footer class="vp-doc-footer" data-v-c2acd915 data-v-393f5f4b><!--[--><!--]--><div class="edit-info" data-v-393f5f4b><div class="edit-link" data-v-393f5f4b><a class="vp-link link no-icon vp-external-link-icon edit-link-button" href="https://github.com/pengzhanbo/vuepress-theme-plume/edit/main/docs/en/config/theme.md" target="_blank" rel="noopener noreferrer" data-v-393f5f4b><!--[--><span class="vpi-square-pen edit-link-icon" aria-label="edit icon" data-v-393f5f4b></span> Edit this page<!--]--><!--[--><!--]--><!----></a></div><!----></div><!----><nav class="prev-next" data-v-393f5f4b><div class="pager" data-v-393f5f4b><a class="vp-link link pager-link prev" href="/en/config/intro/" data-v-393f5f4b><!--[--><span class="desc" data-v-393f5f4b>Previous page</span><span class="title" data-v-393f5f4b><!----><span data-v-393f5f4b>Configuration Guide</span></span><!--]--><!--[--><!--]--><!----></a></div><div class="pager" data-v-393f5f4b><a class="vp-link link pager-link next" href="/en/config/locales/" data-v-393f5f4b><!--[--><span class="desc" data-v-393f5f4b>Next page</span><span class="title" data-v-393f5f4b><!----><span data-v-393f5f4b>Locales Configuration</span></span><!--]--><!--[--><!--]--><!----></a></div></nav></footer></div><!--]--></main><div id="comment" class="giscus-wrapper input-top vp-comment" vp-comment style="display:block;" data-v-c2acd915><div style="display: flex;align-items: center;justify-content: center;height: 96px"><span style="--loading-icon: url("data:image/svg+xml;charset=utf8,%3Csvg preserveAspectRatio=%22xMidYMid%22 viewBox=%2225 25 50 50%22%3E%3CanimateTransform attributeName=%22transform%22 type=%22rotate%22 dur=%222s%22 keyTimes=%220;1%22 repeatCount=%22indefinite%22 values=%220;360%22%3E%3C/animateTransform%3E%3Ccircle cx=%2250%22 cy=%2250%22 r=%2220%22 fill=%22none%22 stroke=%22currentColor%22 stroke-width=%224%22 stroke-linecap=%22round%22%3E%3Canimate attributeName=%22stroke-dasharray%22 dur=%221.5s%22 keyTimes=%220;0.5;1%22 repeatCount=%22indefinite%22 values=%221,200;90,200;1,200%22%3E%3C/animate%3E%3Canimate attributeName=%22stroke-dashoffset%22 dur=%221.5s%22 keyTimes=%220;0.5;1%22 repeatCount=%22indefinite%22 values=%220;-35px;-125px%22%3E%3C/animate%3E%3C/circle%3E%3C/svg%3E");--icon-size: 48px;display: inline-block;width: var(--icon-size);height: var(--icon-size);background-color: currentcolor;-webkit-mask-image: var(--loading-icon);mask-image: var(--loading-icon)"></span></div></div><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!--]--><button type="button" class="vp-back-to-top" aria-label="back to top" data-v-a5aadcf6 style="display:none;" data-v-7a6b3799><span class="percent" data-allow-mismatch data-v-7a6b3799>0%</span><span class="show icon vpi-back-to-top" data-v-7a6b3799></span><svg aria-hidden="true" data-v-7a6b3799><circle cx="50%" cy="50%" data-allow-mismatch style="stroke-dasharray:calc(0% - 12.566370614359172px) calc(314.1592653589793% - 12.566370614359172px);" data-v-7a6b3799></circle></svg></button><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewbox="0 0 24 24" aria-label="sign down" class="vp-sign-down" aria-hidden="true" data-v-a5aadcf6 style="display:none;" data-v-43069080><g fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2.5" data-v-43069080><path d="m19 11l-7 6l-7-6" data-v-43069080></path><path d="m19 5l-7 6l-7-6" opacity="0.6" data-v-43069080></path></g></svg><footer class="vp-footer has-sidebar" vp-footer data-v-a5aadcf6 data-v-b83cc7e0><!--[--><div class="container" data-v-b83cc7e0><div class="message" data-v-b83cc7e0>Powered by <a target="_blank" href="https://v2.vuepress.vuejs.org/">VuePress</a> & <a target="_blank" href="https://theme-plume.vuejs.press">vuepress-theme-plume</a></div><div class="copyright" data-v-b83cc7e0>Copyright © 2021-present pengzhanbo</div></div><!--]--></footer><!--[--><!--]--><!--]--></div><!----><!--]--><!--[--><!--]--><!--]--></div><script type="module" src="/assets/app-B2DsuqVi.js" defer></script></body></html> |