mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-25 11:28:13 +08:00
201 lines
142 KiB
HTML
201 lines
142 KiB
HTML
<!doctype html><html lang="zh-CN"><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.194" /><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":"主题配置","image":[""],"dateModified":"2026-03-08T13:55:27.000Z","author":[]}</script><meta property="og:url" content="https://theme-plume.vuejs.press/config/theme/"><meta property="og:site_name" content="Plume 主题"><meta property="og:title" content="主题配置"><meta property="og:description" content="概述 主题配置用于定制主题的各项功能,以控制主题的行为, 您可以在 .vuepress/config.ts 或者 .vuepress/plume.config.ts 中进行配置。 当字段说明包含以下声明时,表示该字段不支持在 .vuepress/plume.config.ts 中进行配置: 该字段不支持在 中进行配置。 无以上声明的字段,您可以在 .v..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:locale:alternate" content="en-US"><meta property="og:updated_time" content="2026-03-08T13:55:27.000Z"><meta property="article:modified_time" content="2026-03-08T13:55:27.000Z"><link rel="alternate" hreflang="en-us" href="https://theme-plume.vuejs.press/en/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>主题配置 | 配置 | Plume 主题</title><meta name="description" content="概述 主题配置用于定制主题的各项功能,以控制主题的行为, 您可以在 .vuepress/config.ts 或者 .vuepress/plume.config.ts 中进行配置。 当字段说明包含以下声明时,表示该字段不支持在 .vuepress/plume.config.ts 中进行配置: 该字段不支持在 中进行配置。 无以上声明的字段,您可以在 .v..."><link rel="preload" href="/assets/style-BGtb9b_n.css" as="style"><link rel="stylesheet" href="/assets/style-BGtb9b_n.css"><link rel="modulepreload" href="/assets/app-CponcA4I.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-LadtrrgZ.js"><link rel="modulepreload" href="/assets/VPHomeHero-DWhHhzVg.js"><link rel="modulepreload" href="/assets/composables-Dy7xAEJk.js"><link rel="modulepreload" href="/assets/client-DIGNuIZ_.js"><link rel="modulepreload" href="/assets/theme-colors-bZHGy5AR.js"><link rel="modulepreload" href="/assets/VPButton-DJaiL7ma.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-DjcuOnVB.js"><link rel="modulepreload" href="/assets/VPCopyright-DUWF61Ht.js"><link rel="modulepreload" href="/assets/theme-CrJAd-5M.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="/" 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 主题</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="搜索文档" 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">搜索文档</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="/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>指南</span><!----><!--]--><!----></a><!--]--><!--[--><a class="vp-link link navbar-menu-link active" href="/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>配置</span><!----><!--]--><!----></a><!--]--><!--[--><a class="vp-link link navbar-menu-link" href="/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>博客</span><!----><!--]--><!----></a><!--]--><!--[--><a class="vp-link link navbar-menu-link" href="/demos/" tabindex="0" data-v-b42927e7 data-v-29cf8989><!--[--><span class="vp-icon vpi-map-wind-surfing" style="" aria-hidden data-provider="iconify" data-v-29cf8989></span><span data-v-29cf8989>案例</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>更多</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="/faq/" data-v-e06ddb34><!--[--><span class="vp-icon vpi-wpf-faq" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> 常见问题 <!----><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/sponsor/" data-v-e06ddb34><!--[--><span class="vp-icon vpi-line-md-coffee-loop" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> 喝杯奶茶 <!----><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/tools/" data-v-e06ddb34><!--[--><span class="vp-icon vpi-jam-tools" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> 主题工具 <!----><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/friends/" data-v-e06ddb34><!--[--><span class="vp-icon vpi-carbon-friendship" style="" aria-hidden data-provider="iconify" data-v-e06ddb34></span> 友情链接 <!----><!--]--><!----></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> 官方文档 <!----><!--]--><span class="visually-hidden">(在新窗口打开)</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> 生态系统 <!----><!--]--><span class="visually-hidden">(在新窗口打开)</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.194</span><span class="vp-badge tip vp-menu-badge" style="" data-v-15bfbb59 data-v-52c8341f><!--[-->新<!--]--></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="/changelog/" data-v-e06ddb34><!--[--><!----> 更新日志 <!----><!--]--><!----></a></div><!--]--><!--[--><div class="vp-menu-link" data-v-f3964f32 data-v-e06ddb34><a class="vp-link link" href="/contributing/" data-v-e06ddb34><!--[--><!----> 参与贡献 <!----><!--]--><!----></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="选择语言" 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>简体中文</p><!--[--><div class="vp-menu-link" data-v-e0a18246 data-v-e06ddb34><a class="vp-link link" href="/en/config/theme/" data-v-e06ddb34><!--[--><!----> English <!----><!--]--><!----></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>简体中文</p><!--[--><div class="vp-menu-link" data-v-7e94ae84 data-v-e06ddb34><a class="vp-link link" href="/en/config/theme/" data-v-e06ddb34><!--[--><!----> English <!----><!--]--><!----></a></div><!--]--></div><div class="group appearance" data-v-7e94ae84><div class="item appearance" data-v-7e94ae84><p class="label" data-v-7e94ae84>外观</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>配置</span><!----></h2><button type="button" class="caret" aria-label="Collapse 配置" 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="/config/intro/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>配置说明</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="/config/theme/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>主题配置</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="/config/locales/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>多语言配置</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="/config/navigation/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>导航栏配置</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="/config/sidebar/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>侧边栏配置</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="/config/collections/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>集合配置</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="/config/markdown/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>Markdown 配置</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>页面配置</span><!----></h2><button type="button" class="caret" aria-label="Collapse 页面配置" 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="/config/frontmatter/basic/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>通用配置</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="/config/frontmatter/home/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>首页</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="/config/frontmatter/article/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>posts文章</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="/config/frontmatter/friends/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>友情链接页</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>内置插件</span><!----></h2><button type="button" class="caret" aria-label="Collapse 内置插件" 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="/config/plugins/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>介绍</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="/config/plugins/code-highlight/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>代码高亮</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="/config/plugins/search/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>内容搜索</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="/config/plugins/reading-time/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>阅读统计</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="/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="/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><!--[-->弃用<!--]--></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="/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="/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="/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="/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="/config/watermark/" data-v-ab4803a9><!--[--><p class="text" data-v-ab4803a9><span data-v-ab4803a9>水印</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>此页内容</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>在 GitHub 上 Star</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>遇到问题?</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>喝杯奶茶</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="/" property="item" typeof="WebPage" data-v-68dbda29><!--[-->首页<!--]--><!----></a><span class="vpi-chevron-right" data-v-68dbda29></span><meta property="name" content="首页" 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><!--[-->配置<!--]--><!----></span><span class="vpi-chevron-right" data-v-68dbda29></span><meta property="name" content="配置" 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="/config/theme/" property="item" typeof="WebPage" data-v-68dbda29><!--[-->主题配置<!--]--><!----></a><!----><meta property="name" content="主题配置" 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><!----> 主题配置 <!----></h1><!--[--><!--[--><!--[--><!--[--><div class="vp-page-context-menu" data-v-a5aadcf6 data-v-7b50bfdd><div class="page-context-button" type="button" data-v-7b50bfdd><span class="page-context-copy" data-v-7b50bfdd><span class="vpi-copy" data-v-7b50bfdd></span><span class="text" data-v-7b50bfdd>复制页面</span></span><span class="page-context-toggle" data-v-7b50bfdd><span class="vpi-chevron-down" data-v-7b50bfdd></span></span></div><ul class="page-context-menu" style="display:none;" data-v-7b50bfdd><li data-v-7b50bfdd><a href="javascript:void(0)" data-v-7b50bfdd><span class="vpi-copy" data-v-7b50bfdd></span><span data-v-7b50bfdd>复制页面 <small data-v-7b50bfdd>将页面以 Markdown 格式复制供 LLMs 使用</small></span></a></li><!--[--><li data-v-7b50bfdd><a href="/config/theme/index.md" target="_blank" rel="noopener noreferrer" aria-label="以 Markdown 格式查看" type="text/markdown" data-allow-mismatch data-v-7b50bfdd><span class="vpi-markdown" data-v-7b50bfdd></span><span data-v-7b50bfdd>以 Markdown 格式查看 <span class="vpi-external-link" data-v-7b50bfdd></span><small data-v-7b50bfdd>以纯文本查看此页面</small></span></a></li><li data-v-7b50bfdd><a href="https://chat.openai.com/?prompt=" target="_blank" rel="noopener noreferrer" aria-label="在 ChatGPT 中打开" data-allow-mismatch data-v-7b50bfdd><span class="vpi-chatgpt" data-v-7b50bfdd></span><span data-v-7b50bfdd>在 ChatGPT 中打开 <span class="vpi-external-link" data-v-7b50bfdd></span><small data-v-7b50bfdd>向 ChatGPT 提问有关此页面</small></span></a></li><li data-v-7b50bfdd><a href="https://claude.ai/new?q=" target="_blank" rel="noopener noreferrer" aria-label="在 Claude 中打开" data-allow-mismatch data-v-7b50bfdd><span class="vpi-claude" data-v-7b50bfdd></span><span data-v-7b50bfdd>在 Claude 中打开 <span class="vpi-external-link" data-v-7b50bfdd></span><small data-v-7b50bfdd>向 Claude 提问有关此页面</small></span></a></li><li data-v-7b50bfdd><a href="https://perplexity.ai/?q=" target="_blank" rel="noopener noreferrer" aria-label="在 Perplexity 中打开" data-allow-mismatch data-v-7b50bfdd><span class="vpi-perplexity" data-v-7b50bfdd></span><span data-v-7b50bfdd>在 Perplexity 中打开 <span class="vpi-external-link" data-v-7b50bfdd></span><small data-v-7b50bfdd>向 Perplexity 提问有关此页面</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>约 3553 字</span><span data-v-42fa9e7c>大约 12 分钟</span></p><!----><!--[--><!--]--><p class="create-time" data-v-42fa9e7c><span class="vpi-clock icon" data-v-42fa9e7c></span><span data-v-42fa9e7c>2024-03-02</span></p></div><!--]--><!--[--><!--]--><!--[--><div class="_config_theme_ external-link-icon-enabled vp-doc plume-content" vp-content data-v-c2acd915><!--[--><!--]--><div data-v-c2acd915><h2 id="概述" tabindex="-1"><a class="header-anchor" href="#概述"><span>概述</span></a></h2><p>主题配置用于定制主题的各项功能,以控制主题的行为, 您可以在 <code>.vuepress/config.ts</code> 或者 <code>.vuepress/plume.config.ts</code> 中进行配置。</p><p>当字段说明包含以下声明时,表示该字段不支持在 <code>.vuepress/plume.config.ts</code> 中进行配置:</p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <code>plume.config.js</code><!--]--><!----></a> 中进行配置。</p></div><p>无以上声明的字段,您可以在 <code>.vuepress/config.ts</code> 或者 <code>.vuepress/plume.config.ts</code> 的任意一个文件中进行配置,一般情况下建议在 <code>.vuepress/plume.config.ts</code> 中进行配置。</p><div class="hint-container warning"><p class="hint-container-title">已经在一个配置文件中进行配置的字段,尽量不要在另一个配置文件中重复配置</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_d7cpuwqu_ybaf65" 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_0g0rij3r_ybaf65" 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_sh178ikk_ybaf65" 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_632tly8j_ybaf66" 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_jfzloeae_ybaf66" 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;"> // 主题配置</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_rkia97pt_ybaf67" 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_oac9tqup_ybaf67" 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;"> // 主题配置</span></span>
|
||
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre></div><!--]--></div><!--]--></div><h2 id="基础配置" tabindex="-1"><a class="header-anchor" href="#基础配置"><span>基础配置</span></a></h2><h3 id="configfile" tabindex="-1"><a class="header-anchor" href="#configfile"><span>configFile</span></a></h3><ul><li><p><strong>类型:</strong> <code>string</code></p></li><li><p><strong>默认值:</strong> <code>''</code></p></li><li><p><strong>详情:</strong></p><p>自定义主题配置文件的路径。</p><p>查看 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <code>plume.config.js</code><!--]--><!----></a> 了解更多。</p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong><code>PlumeThemePluginOptions</code></p></li><li><p><strong>默认值:</strong> <code>{}</code></p></li><li><p><strong>详情:</strong></p><p>对主题内部使用的插件进行自定义配置。</p><p>主题使用的插件默认已进行了配置,大多数情况下您不需要进行修改,如果需要使用到细致的定制化,请查阅 <a class="vp-link link" href="/config/plugins/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>MarkdownOptions</code></p></li><li><p><strong>默认值:</strong> <code>{}</code></p></li><li><p><strong>详情:</strong></p><p>Markdown 功能配置, 参考 <a class="vp-link link" href="/config/markdown/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | ShikiPluginOptions</code></p></li><li><p><strong>默认值:</strong> <code>{}</code></p></li><li><p><strong>详情:</strong></p><p>代码高亮配置, 参考 <a class="vp-link link" href="/guide/code/intro/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | SearchOptions</code></p></li><li><p><strong>默认值:</strong> <code>{ provider: 'local' }</code></p></li><li><p><strong>详情:</strong></p><p>搜索配置, 参考 <a class="vp-link link" href="/guide/features/content-search/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | CommentPluginOptions</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong></p><p>评论配置, 参考 <a class="vp-link link" href="/guide/features/comments/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | WatermarkPluginOptions</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong></p><p>水印配置, 参考 <a class="vp-link link" href="/guide/features/watermark/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | ReadingTimePluginOptions</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong></p><p>阅读时长配置, 参考 <a class="vp-link link" href="/config/plugins/reading-time/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | CopyCodePluginOptions</code></p></li><li><p><strong>默认值:</strong> <code>{}</code></p></li><li><p><strong>详情:</strong></p><p>复制代码配置, 参考 <a class="vp-link link" href="/guide/code/copy-code/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | ReplaceAssetsPluginOptions</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong></p><p>替换资源配置, 参考 <a class="vp-link link" href="/guide/features/replace-assets/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>string</code></p></li><li><p><strong>默认值:</strong> <code>''</code></p></li><li><p><strong>详情:</strong></p><p>部署站点域名。</p><p>当 <code>hostname</code> 配置为有效域名时,主题将会生成 <code>sitemap</code> 和 <code>seo</code> 相关的内容。</p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | AutoFrontmatterOptions</code></p></li><li><p><strong>详情:</strong></p><p>是否为 markdown 文件自动添加 frontmatter 配置</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;"> * 是否自动生成 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: 自动生成 permalink</span></span>
|
||
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - false: 不生成 permalink</span></span>
|
||
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - 'filepath': 根据文件路径生成 permalink</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;"> * 是否自动生成 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;"> * 默认读取 文件创建时间,`createTitme` 比 vuepress 默认的 `date` 时间更精准到秒</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;"> * 是否自动生成 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;"> * 默认读取文件名作为标题</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>类型:</strong> <code>false | 'memory' | 'filesystem'</code></p></li><li><p><strong>默认值:</strong> <code>filesystem</code></p></li><li><p><strong>详情:</strong></p><p>是否启用 编译缓存,或配置缓存方式</p><p>此配置项用于解决 VuePress 启动速度慢的问题,在首次启动服务时,对编译结果进行缓存,二次启动时 直接读取缓存,跳过编译,从而加快启动速度。</p><ul><li><code>false</code>:禁用 缓存</li><li><code>'memory'</code>:使用内存缓存,此方式可获得更快的启动速度,但随着项目文件数量增加,内存占用会增加, 适合文章数量较少的项目使用</li><li><code>'filesystem'</code>:使用文件系统缓存,此方式可获得相对快且稳定的启动速度,更适合内容多的项目使用</li></ul><div class="hint-container warning"><p class="hint-container-title">注意</p><p>该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <code>plume.config.js</code><!--]--><!----></a> 中进行配置。</p><p>为了使缓存能够生效,您应该 <strong>删除</strong> <code>package.json</code> 中 <code>vuepress dev</code> 开发服务启动脚本中的 <code>--clean-cache</code> 参数。</p></div></li></ul><h3 id="docsrepo" tabindex="-1"><a class="header-anchor" href="#docsrepo"><span>docsRepo</span></a></h3><ul><li><strong>类型:</strong> <code>string</code></li><li><strong>默认值:</strong> <code>''</code></li><li><strong>详情:</strong> 文档仓库配置, 用于生成 <code>Edit this page</code> 链接。</li></ul><h3 id="docsbranch" tabindex="-1"><a class="header-anchor" href="#docsbranch"><span>docsBranch</span></a></h3><ul><li><strong>类型:</strong> <code>string</code></li><li><strong>默认值:</strong> <code>''</code></li><li><strong>详情:</strong> 文档仓库分支配置,用于生成 <code>Edit this page</code> 链接。</li></ul><h3 id="docsdir" tabindex="-1"><a class="header-anchor" href="#docsdir"><span>docsDir</span></a></h3><ul><li><strong>类型:</strong> <code>string</code></li><li><strong>默认值:</strong> <code>''</code></li><li><strong>详情:</strong> 文档仓库目录配置,用于生成 <code>Edit this page</code> 链接。</li></ul><h3 id="editlink" tabindex="-1"><a class="header-anchor" href="#editlink"><span>editLink</span></a></h3><ul><li><p><strong>类型:</strong> <code>boolean</code></p></li><li><p><strong>默认值:</strong> <code>true</code></p></li><li><p><strong>详情:</strong> 是否启用 编辑链接</p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>false | LastUpdatedOptions</code></li><li><strong>默认值:</strong> <code>{ formatOptions: { dateStyle: 'short', timeStyle: 'short' } }</code></li><li><strong>详情:</strong> 最后更新时间</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;"> * 设置最后更新时间格式的选项。</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">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>boolean | ContributorsOptions</code></p></li><li><p><strong>默认值:</strong> <code>true</code></p></li><li><p><strong>详情:</strong> 是否显示贡献者</p><p>更多配置请参考 <a class="vp-link link" href="/guide/features/contributors/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>boolean | ChangelogOptions</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong> 是否显示页面变更历史</p><p>更多配置请参考 <a class="vp-link link" href="/guide/features/changelog/"><!--[-->此文档<!--]--><!----></a></p><div class="hint-container warning"><p class="hint-container-title">该字段不支持在 <a class="vp-link link" href="/config/intro/#%E4%B8%BB%E9%A2%98%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6"><!--[-->主题配置文件 <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>类型:</strong> <code>Record<string, ThemeLocaleData></code></li><li><strong>默认值:</strong> <code>{}</code></li><li><strong>详情:</strong> 多语言配置</li></ul><p>不同语言的文本配置,参考 <a class="vp-link link" href="/config/locales/"><!--[-->此文档<!--]--><!----></a></p><p>多语言配置支持以下 <a href="#locale-%E9%85%8D%E7%BD%AE">Locale</a> 所有配置选项以控制不同语言下的主题行为。</p><h2 id="locale-配置" tabindex="-1"><a class="header-anchor" href="#locale-配置"><span>Locale 配置</span></a></h2><div class="hint-container tip"><p class="hint-container-title">以下所有字段也均是基础配置字段,可以与 <code>locales</code> 等字段平级配置。</p></div><h3 id="home" tabindex="-1"><a class="header-anchor" href="#home"><span>home</span></a></h3><ul><li><strong>类型:</strong> <code>false | string</code></li><li><strong>默认值:</strong> <code>/</code></li><li><strong>详情:</strong> 首页的路径, 它将被用于: <ul><li>导航栏中 logo的链接;</li><li>404页面的 <em>返回首页</em> 的链接;</li></ul></li></ul><h3 id="logo" tabindex="-1"><a class="header-anchor" href="#logo"><span>logo</span></a></h3><ul><li>类型: <code>false | string</code></li><li><strong>默认值:</strong> <code>false</code></li><li><strong>详情:</strong> 导航栏中的logo。</li></ul><h3 id="logodark" tabindex="-1"><a class="header-anchor" href="#logodark"><span>logoDark</span></a></h3><ul><li>类型 <code>false | string</code></li><li><strong>默认值:</strong> <code>false</code></li><li><strong>详情:</strong> Dark模式下,导航栏中的logo。</li></ul><h3 id="appearance" tabindex="-1"><a class="header-anchor" href="#appearance"><span>appearance</span></a></h3><ul><li><strong>类型:</strong> <code>boolean | 'dark' | 'force-dark</code></li><li><strong>默认值:</strong> <code>true</code></li></ul><p>是否启用 深色模式。</p><ul><li>如果该选项设置为 <code>true</code>,则默认主题将由用户的首选配色方案决定。</li><li>如果该选项设置为 <code>dark</code>,则默认情况下主题将是深色的,除非用户手动切换它。</li><li>如果该选项设置为 <code>false</code>,用户将无法切换主题。</li><li>如果该选项设置为 <code>force-dark</code>,则用户将无法切换主题,但会强制将主题更改为深色。</li></ul><p>此选项注入一个内联脚本,从本地存储恢复用户设置。这确保在呈现页面之前应用 <code>[data-theme="dark"]</code> 以避免闪烁。</p><h3 id="profile" tabindex="-1"><a class="header-anchor" href="#profile"><span>profile</span></a></h3><ul><li><strong>类型:</strong> <code>ProfileOptions</code></li><li><strong>默认值:</strong> <code>{}</code></li><li><strong>详情:</strong> 配置站点博主的个人信息 <ul><li><code>profile.avatar</code>: 头像地址,用于右侧博主信息展示</li><li><code>profile.name</code>: 名称, 用于右侧博主信息展示</li><li><code>profile.description</code>: 个人描述,用于右侧博主信息展示</li><li><code>profile.circle</code>: 是否为圆形头像</li><li><code>profile.location</code>: 用户地理位置</li><li><code>profile.organization</code>: 用户所在组织/公司</li><li><code>profile.layout</code>: 个人信息展示在左侧还是右侧,<code>'left' | 'right'</code></li></ul></li></ul><p>示例:</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;">张三</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;">此处无银三百两,隔壁王二不曾偷</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;">杭州,中国</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公司</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>类型:</strong> <code>false | SocialLink[]</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong> 个人社交信息配置。</p><p>将作为 图标链接 展示在 导航栏最右侧。</p><p>支持 <a href="https://icon-sets.iconify.design/" target="_blank" rel="noopener noreferrer">Iconify</a> 任意图标,直接使用 iconify name 即可自动加载。</p><p>对于 <code>simple-icons</code> 集合下的图标,可以省略 <code>simple-icons:</code> 前缀,如 <code>simple-icons:github</code> 可以简写为 <code>github</code></p><p>常见的社交图标示例:</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">您可以在这里查看 <strong>simple-icons</strong> 所有可用图标</a></p></li></ul><p>如果 <strong>Iconify</strong> 无法满足您的需求,可以传入 <code>{ svg: string, name?: string }</code> 格式使用自定义图标,传入 SVG 源码字符串,可选 <code>name</code> 字段用于配置 <a href="#navbarsocialinclude"><code>navbarSocialInclude</code></a></p><p>示例:</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;"> // 使用 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;"> // 使用自定义图标</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>类型:</strong> <code>string[]</code></p></li><li><p><strong>默认值:</strong> <code>['github', 'twitter', 'discord', 'facebook']</code></p></li><li><p><strong>详情:</strong></p><p>允许显示在导航栏的社交链接。 该配置仅在 PC 端下有效。</p><p>如果 <a href="#social"><code>social</code></a> 配置为 <code>{ svg: string, name: string}</code> 则可将 <code>name</code> 作为 <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>类型:</strong> <code>NavItem[]</code></p></li><li><p><strong>默认值:</strong> <code>[]</code></p></li><li><p><strong>详情:</strong> 导航栏配置。</p><p>为了配置导航栏元素,你可以将其设置为 导航栏数组 ,其中的每个元素是 <code>string</code> 或 <code>NavItem</code> 对象</p><ul><li><code>NavItem</code> 对象应该有一个 text 字段和一个 link 字段,还有一个可选的 <code>activeMatch</code> 字段。</li><li><code>string</code> 表示是一个页面文件路径,或者是一个页面的访问路径。</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;"> * 当前分组的页面前缀</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;"> * 该分组下的导航项</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;"> * 支持 iconify 图标,直接使用 iconify name 即可自动加载</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;"> * 控制元素何时被激活</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>示例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;"> // 字符串 - 页面文件路径</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;"> // 可以直接省略后缀 `.md`</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>示例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;"> // 嵌套 Group - 最大深度为 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;"> // 控制元素何时被激活</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;"> // 该元素将一直处于激活状态</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;"> // 该元素在当前路由路径是 /foo/ 开头时激活</span></span>
|
||
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // 支持正则表达式</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>类型:</strong> <code>ThemeCollectionItem[]</code></p></li><li><p><strong>默认值:</strong> <code>[]</code></p></li><li><p><strong>详情:</strong> 文档集合配置</p><p><a class="vp-link link read-more" href="/guide/collection/"><!--[-->查看 <strong>集合指南</strong><!--]--><!----></a></p><p><a class="vp-link link read-more" href="/config/collections/"><!--[-->查看 <strong>集合配置</strong> 了解更多<!--]--><!----></a></p></li></ul><h3 id="sidebar" tabindex="-1"><a class="header-anchor" href="#sidebar"><span>sidebar</span></a></h3><ul><li><p><strong>类型:</strong> <code>false | SidebarMulti</code></p></li><li><p><strong>详情:</strong></p><p>侧边栏配置。<strong>主题更推荐在 <a class="vp-link link" href="/config/collections/"><!--[-->collections 配置<!--]--><!----></a> 中进行侧边栏配置。</strong></p><p>配置对象的 <code>key</code> 为侧边栏公共访问路径前缀。</p><p>对于 <code>value</code>:</p><ul><li><code>'auto'</code> 表示自动根据目录结构生成侧边栏</li><li><code>string</code> 表示侧边栏对应的页面文件路径</li><li><code>SidebarItem</code> 表示侧边栏单项配置</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;"> * 侧边栏文本</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;"> * 侧边栏链接</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;"> * 侧边栏图标</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;"> * 次级侧边栏分组</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;"> * 如果未指定,组不可折叠。</span></span>
|
||
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * 如果为`true`,组可折叠,并默认折叠。</span></span>
|
||
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * 如果为`false`,组可折叠,但默认展开。</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;"> * 当前分组的链接前缀</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>类型:</strong> <code>boolean</code></p></li><li><p><strong>默认值:</strong> <code>true</code></p></li><li><p><strong>详情:</strong> 是否显示侧边栏滚动条</p><p>设置为 <code>false</code> 时,仅隐藏滚动条,但不改变滚动行为。</p></li></ul><h3 id="aside" tabindex="-1"><a class="header-anchor" href="#aside"><span>aside</span></a></h3><ul><li><p><strong>类型:</strong> <code>boolean | 'left'</code></p></li><li><p><strong>默认值:</strong> <code>true</code></p></li><li><p><strong>详情:</strong></p><p>是否显示侧边栏</p><ul><li><code>false</code> 表示禁用 右侧边栏</li><li><code>true</code> 表示启用 右侧边栏</li><li><code>'left</code> 表示将有侧边栏移动到文章内容左侧,sidebar 右侧</li></ul><p>每个页面可以通过 <a class="vp-link link" href="/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>类型:</strong> <code>false | number | [number, number] | 'deep'</code></p></li><li><p><strong>默认值:</strong> <code>[2, 3]</code></p></li><li><p><strong>详情:</strong></p><p>要显示的标题级别。</p><p>单个数字表示只显示该级别的标题。</p><p>如果传递的是一个元组,第一个数字是最小级别,第二个数字是最大级别。</p><p><code>'deep'</code> 与 <code>[2, 6]</code> 相同,将显示从 <code><h2></code> 到 <code><h6></code> 的所有标题。</p><p>当 <a href="#aside">aside</a> 被禁用时,<code>outline</code> 也会被禁用</p><p>每个页面可以通过 <a class="vp-link link" href="/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>类型:</strong> <code>boolean | TransitionOptions</code></p></li><li><p><strong>默认值:</strong> <code>true</code></p></li><li><p><strong>详情:</strong></p><p>是否启用过渡动画。</p><p>传入 <code>boolean</code> 类型时,<code>true</code> 代表启用,<code>false</code> 代表禁用。</p><p>也可以传入一个对象,具体配置见下</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;"> * 是否启用 页面间跳转过渡动画</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;"> * 是否启用 博客文章列表过渡动画</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;"> * 是否启用 深色/浅色 模式切换过渡动画,</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:#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>类型:</strong> <code>false | { message: string; copyright: string }</code></li><li><strong>默认值:</strong> <code>false</code></li><li><strong>详情:</strong> 页脚配置。</li></ul><h3 id="bulletin" tabindex="-1"><a class="header-anchor" href="#bulletin"><span>bulletin</span></a></h3><ul><li><p><strong>类型:</strong> <code>boolean | BulletinOptions</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong> 公告板配置</p><p>详情请参考 <a class="vp-link link" href="/guide/features/bulletin/"><!--[-->公告板<!--]--><!----></a></p></li></ul><h3 id="editlinkpattern" tabindex="-1"><a class="header-anchor" href="#editlinkpattern"><span>editLinkPattern</span></a></h3><ul><li><p><strong>类型:</strong> <code>string</code></p></li><li><p><strong>默认值:</strong> <code>''</code></p></li><li><p><strong>详情:</strong> 编辑链接的正则表达式</p><p>示例: <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>类型:</strong> <code>boolean | CopyrightLicense | CopyrightOptions</code></p></li><li><p><strong>默认值:</strong> <code>false</code></p></li><li><p><strong>详情:</strong> 版权配置</p><p>详情请参考 <a class="vp-link link" href="/guide/features/copyright/"><!--[-->版权所有<!--]--><!----></a></p></li></ul><h3 id="prevpage" tabindex="-1"><a class="header-anchor" href="#prevpage"><span>prevPage</span></a></h3><ul><li><strong>类型:</strong> <code>boolean</code></li><li><strong>默认值:</strong> <code>true</code></li><li><strong>详情:</strong> 是否显示上一页</li></ul><h3 id="nextpage" tabindex="-1"><a class="header-anchor" href="#nextpage"><span>nextPage</span></a></h3><ul><li><strong>类型:</strong> <code>boolean</code></li><li><strong>默认值:</strong> <code>true</code></li><li><strong>详情:</strong> 是否显示下一页</li></ul><h3 id="createtime" tabindex="-1"><a class="header-anchor" href="#createtime"><span>createTime</span></a></h3><ul><li><p><strong>类型:</strong> <code>boolean | 'only-posts'</code></p></li><li><p><strong>默认值:</strong> <code>true</code></p></li><li><p><strong>详情:</strong> 是否显示创建时间</p><ul><li><code>false</code> - 不显示</li><li><code>'only-posts'</code> - 只显示在文章列表页面</li><li><code>true</code> - 显示在所有文章页面</li></ul></li></ul></div><!--[--><h2 id="doc-contributors" tabindex="-1"><a href="#doc-contributors" class="header-anchor"><span>贡献者</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><span target="_blank" rel="noreferrer" class="vp-contributor"><img src="https://gravatar.com/avatar/899a2a8091fc73ff6879f8a45f98a5a42ca8b9665bca19ce8af3a144e416ed11?d=retro" alt class="vp-contributor-avatar"><span class="vp-contributor-name">kangkang shang</span></span><a href="https://github.com/SherkeyXD" target="_blank" rel="noreferrer" class="vp-contributor"><img src="https://avatars.githubusercontent.com/SherkeyXD?v=4" alt class="vp-contributor-avatar"><span class="vp-contributor-name">SherkeyXD</span></a></div><!--]--><!--[--><h2 id="doc-changelog" tabindex="-1"><a href="#doc-changelog" class="header-anchor"><span>更新日志</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>2026/3/8 13:55</span></div><div><span class="vp-changelog-menu-icon"></span><span>查看所有更新日志</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/97a5ba20c3eb976864d8a9ec7342a061bb73c03b" target="_blank" rel="noreferrer"><code>97a5b</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">docs: fix typo</span><span class="vp-changelog-date" data-allow-mismatch>于 <time datetime="2026-03-08T13:55:27.000Z">2026/3/8</time></span></li><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>于 <time datetime="2026-01-19T13:43:41.000Z">2026/1/19</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>于 <time datetime="2025-12-12T12:40:50.000Z">2025/12/12</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>于 <time datetime="2025-10-15T04:34:16.000Z">2025/10/15</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/9ed4acc097ff691cff98afbbfcc8304d7500c714" target="_blank" rel="noreferrer"><code>9ed4a</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">docs: update docs</span><span class="vp-changelog-date" data-allow-mismatch>于 <time datetime="2025-10-07T18:20:31.000Z">2025/10/7</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/4d2361a7046214fe0f4e4af01831107fd00e38ad" target="_blank" rel="noreferrer"><code>4d236</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">feat(theme)!: add collections support (<a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/704" target="_blank" rel="noopener noreferrer">#704</a>)</span><span class="vp-changelog-date" data-allow-mismatch>于 <time datetime="2025-10-07T15:13:09.000Z">2025/10/7</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/0da7055c2bac0c00bc69cca05159c6ddcba0a248" target="_blank" rel="noreferrer"><code>0da70</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">feat(theme): add telegram social icon (<a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/678" target="_blank" rel="noopener noreferrer">#678</a>)</span><span class="vp-changelog-date" data-allow-mismatch>于 <time datetime="2025-08-20T16:46:20.000Z">2025/8/20</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/470513d07bcf85b0be973f63d6a86e04155756ec" target="_blank" rel="noreferrer"><code>47051</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">docs: fix typo error</span><span class="vp-changelog-date" data-allow-mismatch>于 <time datetime="2025-05-27T09:26:55.000Z">2025/5/27</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/45853ab51d4452a80ca2c4fddcafcf55c46aef30" target="_blank" rel="noreferrer"><code>45853</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">docs: fix document content issue (<a href="https://github.com/pengzhanbo/vuepress-theme-plume/issues/602" target="_blank" rel="noopener noreferrer">#602</a>)</span><span class="vp-changelog-date" data-allow-mismatch>于 <time datetime="2025-05-20T09:57:35.000Z">2025/5/20</time></span></li><li class="vp-changelog-item-commit"><a class="vp-changelog-hash" href="https://github.com/pengzhanbo/vuepress-theme-plume/commit/3b214f1b5840e1f8f453f7ad3f610cedf17fc09a" target="_blank" rel="noreferrer"><code>3b214</code></a><span class="vp-changelog-divider">-</span><span class="vp-changelog-message">docs: fix broken link</span><span class="vp-changelog-date" data-allow-mismatch>于 <time datetime="2025-04-30T17:17:34.000Z">2025/4/30</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/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> 编辑此页<!--]--><!----></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="/config/intro/" data-v-393f5f4b><!--[--><span class="desc" data-v-393f5f4b>上一页</span><span class="title" data-v-393f5f4b><!----><span data-v-393f5f4b>配置说明</span></span><!--]--><!----></a></div><div class="pager" data-v-393f5f4b><a class="vp-link link pager-link next" href="/config/locales/" data-v-393f5f4b><!--[--><span class="desc" data-v-393f5f4b>下一页</span><span class="title" data-v-393f5f4b><!----><span data-v-393f5f4b>多语言配置</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-CponcA4I.js" defer></script></body></html> |