mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-23 10:58:13 +08:00
219 lines
115 KiB
JavaScript
219 lines
115 KiB
JavaScript
import{$ as e,B as t,P as ee,_ as n,f as te,g as r,h as i,l as a}from"./runtime-core.esm-bundler-CZvn3YaB.js";import{t as ne}from"./plugin-vue_export-helper-CxTVcLa7.js";var o=JSON.parse(`{"path":"/en/config/theme/","title":"Theme Configuration | Config","lang":"en-US","frontmatter":{"title":"Theme Configuration","createTime":"2025/10/09 18:07:03","permalink":"/en/config/theme/","description":"Overview Theme configuration is used to customize various features of the theme and control its behavior. You can configure it in either .vuepress/config.ts or .vuepress/plume.c...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Theme Configuration\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2026-01-19T13:43:41.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://theme-plume.vuejs.press/en/config/theme/"}],["meta",{"property":"og:site_name","content":"Plume Theme"}],["meta",{"property":"og:title","content":"Theme Configuration"}],["meta",{"property":"og:description","content":"Overview Theme configuration is used to customize various features of the theme and control its behavior. You can configure it in either .vuepress/config.ts or .vuepress/plume.c..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2026-01-19T13:43:41.000Z"}],["meta",{"property":"article:modified_time","content":"2026-01-19T13:43:41.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://theme-plume.vuejs.press/config/theme/"}]]},"readingTime":{"minutes":8.63,"words":2590},"git":{"createdTime":1759995965000,"updatedTime":1768830221000,"contributors":[{"name":"pengzhanbo","username":"pengzhanbo","email":"volodymyr@foxmail.com","commits":4,"avatar":"https://avatars.githubusercontent.com/pengzhanbo?v=4","url":"https://github.com/pengzhanbo"}],"changelog":[{"hash":"a3d8e225b96b8950d72ba6bb1a43cfecd926afd5","time":1768830221000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme): add filepath permalink support for auto frontmatter, #815 (#822)"},{"hash":"95d345bf6d3f738f1c44ac6db5cbe95f68d590e4","time":1765543250000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"refactor(theme): social icon support all iconify icons, close #781 (#790)"},{"hash":"1503a20fbe41f5ba73f975ef16a602583b1d8f35","time":1760502856000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme): optimize view transition (#725)"},{"hash":"385059f214cb07fc9a098859e889432fb81f998b","time":1759995965000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: update en docs (#708)"}]},"autoDesc":true,"filePathRelative":"en/config/theme.md","headers":[],"bulletin":false}`),re={name:`theme.md`},ie={class:`hint-container warning`},s={class:`hint-container-title`},c={class:`language-ts`,"data-highlighter":`shiki`,"data-ext":`ts`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},l={class:`shiki shiki-themes vitesse-light vitesse-dark vp-code twoslash lsp`},u={class:`language-ts`},d={class:`line`},f={style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},p={class:`line`},m={style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},h={class:`line`},g={style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},_={class:`line`},v={style:{"--shiki-light":`#998418`,"--shiki-dark":`#B8A965`}},y={style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},b={class:`language-ts`,"data-highlighter":`shiki`,"data-ext":`ts`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},x={class:`shiki shiki-themes vitesse-light vitesse-dark vp-code twoslash lsp`},S={class:`language-ts`},C={class:`line`},w={style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},T={class:`line`},E={style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},D={class:`hint-container warning`},O={class:`hint-container-title`},k={class:`hint-container warning`},A={class:`hint-container-title`},j={id:`markdown`,tabindex:`-1`},M={class:`header-anchor`,href:`#markdown`},N={class:`hint-container warning`},P={class:`hint-container-title`},F={id:`codehighlighter`,tabindex:`-1`},I={class:`header-anchor`,href:`#codehighlighter`},L={class:`hint-container warning`},R={class:`hint-container-title`},z={id:`search`,tabindex:`-1`},B={class:`header-anchor`,href:`#search`},V={class:`hint-container warning`},H={class:`hint-container-title`},U={id:`comment`,tabindex:`-1`},W={class:`header-anchor`,href:`#comment`},G={class:`hint-container warning`},K={class:`hint-container-title`},ae={id:`watermark`,tabindex:`-1`},q={class:`header-anchor`,href:`#watermark`},J={class:`hint-container warning`},oe={class:`hint-container-title`},se={id:`readingtime`,tabindex:`-1`},ce={class:`header-anchor`,href:`#readingtime`},le={class:`hint-container warning`},ue={class:`hint-container-title`},de={id:`copycode`,tabindex:`-1`},fe={class:`header-anchor`,href:`#copycode`},pe={class:`hint-container warning`},me={class:`hint-container-title`},he={id:`replaceassets`,tabindex:`-1`},ge={class:`header-anchor`,href:`#replaceassets`},_e={class:`hint-container warning`},ve={class:`hint-container-title`},ye={class:`hint-container warning`},be={class:`hint-container-title`},xe={class:`hint-container warning`},Se={class:`hint-container warning`},Ce={class:`hint-container-title`},we={class:`hint-container warning`},Te={class:`hint-container-title`},Ee={class:`hint-container warning`},De={class:`hint-container-title`},Y={class:`hint-container warning`},Oe={class:`hint-container-title`},ke={style:{margin:`16px 0`,display:`flex`,gap:`16px`}},Ae={style:{flex:`1`}},je={style:{flex:`1`}};function Me(ne,o,re,Me,Ne,Pe){let X=t(`VPLink`),Z=t(`VPIcon`),Q=t(`v-menu`),Fe=t(`CodeTabs`),$=t(`Badge`);return ee(),te(`div`,null,[o[288]||=a(`h2`,{id:`overview`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#overview`},[a(`span`,null,`Overview`)])],-1),o[289]||=a(`p`,null,[r(`Theme configuration is used to customize various features of the theme and control its behavior. You can configure it in either `),a(`code`,null,`.vuepress/config.ts`),r(` or `),a(`code`,null,`.vuepress/plume.config.ts`),r(`.`)],-1),o[290]||=a(`p`,null,[r(`When a field description includes the following statement, it indicates that the field is not supported for configuration in `),a(`code`,null,`.vuepress/plume.config.ts`),r(`:`)],-1),a(`div`,ie,[a(`p`,s,[o[1]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[0]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[2]||=r(`.`,-1)])]),o[291]||=a(`p`,null,[r(`For fields without the above declaration, you can configure them in either `),a(`code`,null,`.vuepress/config.ts`),r(` or `),a(`code`,null,`.vuepress/plume.config.ts`),r(`. It is generally recommended to configure them in `),a(`code`,null,`.vuepress/plume.config.ts`),r(`.`)],-1),o[292]||=a(`div`,{class:`hint-container warning`},[a(`p`,{class:`hint-container-title`},`Avoid reconfiguring a field that has already been configured in one configuration file within another configuration file.`)],-1),n(Fe,{id:`16`,data:[{id:`.vuepress/config.ts`},{id:`.vuepress/plume.config.ts`}],"tab-id":`configs`},{title0:e(({value:e,isActive:t})=>[n(Z,{provider:`iconify`,name:`vscode-icons:file-type-typescript`}),o[3]||=a(`span`,null,`.vuepress/config.ts`,-1)]),title1:e(({value:e,isActive:t})=>[n(Z,{provider:`iconify`,name:`vscode-icons:file-type-typescript`}),o[4]||=a(`span`,null,`.vuepress/plume.config.ts`,-1)]),tab0:e(({value:t,isActive:ee})=>[a(`div`,c,[a(`pre`,l,[a(`code`,u,[a(`span`,d,[o[7]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`import`,-1),o[8]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` {`,-1),o[9]||=a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` `,-1),a(`span`,f,[n(Q,{class:`twoslash-hover`,"popper-class":`shiki twoslash-floating vp-copy-ignore vp-code`,theme:`twoslash`},{popper:e(({})=>[...o[5]||=[a(`span`,{class:`twoslash-popup-container vp-copy-ignore`},[a(`code`,{class:`twoslash-popup-code`},[a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`const `),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`defineUserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: (`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},`config`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},`UserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`) => `),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},`UserConfig`)])],-1)]]),default:e(()=>[o[6]||=a(`span`,null,`defineUserConfig`,-1)]),_:1})]),o[10]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` }`,-1),o[11]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` from`,-1),o[12]||=a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},` '`,-1),o[13]||=a(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},`vuepress`,-1),o[14]||=a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},`'`,-1)]),o[38]||=r(`
|
|
`,-1),a(`span`,p,[o[17]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`import`,-1),o[18]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` {`,-1),o[19]||=a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` `,-1),a(`span`,m,[n(Q,{class:`twoslash-hover`,"popper-class":`shiki twoslash-floating vp-copy-ignore vp-code`,theme:`twoslash`},{popper:e(({})=>[...o[15]||=[a(`span`,{class:`twoslash-popup-container vp-copy-ignore`},[a(`code`,{class:`twoslash-popup-code`},[a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`function`),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` plumeTheme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`(`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},`options`),a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`?`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},`ThemeOptions`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`):`),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},` Theme`)]),a(`div`,{class:`twoslash-popup-docs vp-doc`,"vp-content":``},[a(`p`,null,`VuePress Theme Plume`),r(`
|
|
`),a(`p`,null,`VuePress 主题 Plume`)]),a(`div`,{class:`twoslash-popup-docs twoslash-popup-docs-tags vp-doc`,"vp-content":``},[a(`span`,{class:`twoslash-popup-docs-tag`},[a(`span`,{class:`twoslash-popup-docs-tag-name`},`@param`),a(`span`,{class:`twoslash-popup-docs-tag-value`},[a(`code`,null,`options`),r(` Theme options / 主题配置`)])]),a(`span`,{class:`twoslash-popup-docs-tag`},[a(`span`,{class:`twoslash-popup-docs-tag-name`},`@example`),a(`span`,{class:`twoslash-popup-docs-tag-value`},[a(`div`,{class:`language-ts`,"data-ext":`ts`,"data-title":`ts`,"data-highlighter":`shiki`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[a(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`},tabindex:`0`},[a(`code`,null,[a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`import`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` {`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` defineUserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` }`),a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` from`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},` '`),a(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},`vuepress`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},`'`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`import`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` {`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` plumeTheme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` }`),a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` from`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},` '`),a(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},`vuepress-theme-plume`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},`'`)]),r(`
|
|
`),a(`span`,{class:`line`}),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`export`),a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` default`),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` defineUserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`({`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#998418`,"--shiki-dark":`#B8A965`}},` theme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`plumeTheme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`({`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#A0ADA0`,"--shiki-dark":`#758575DD`}},` // ...options`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` })`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`})`)])])])])])])])],-1)]]),default:e(()=>[o[16]||=a(`span`,null,`plumeTheme`,-1)]),_:1})]),o[20]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` }`,-1),o[21]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` from`,-1),o[22]||=a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},` '`,-1),o[23]||=a(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},`vuepress-theme-plume`,-1),o[24]||=a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},`'`,-1)]),o[39]||=r(`
|
|
`,-1),o[40]||=a(`span`,{class:`line`},null,-1),o[41]||=r(`
|
|
`,-1),a(`span`,h,[o[27]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`export`,-1),o[28]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` default`,-1),o[29]||=a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` `,-1),a(`span`,g,[n(Q,{class:`twoslash-hover`,"popper-class":`shiki twoslash-floating vp-copy-ignore vp-code`,theme:`twoslash`},{popper:e(({})=>[...o[25]||=[a(`span`,{class:`twoslash-popup-container vp-copy-ignore`},[a(`code`,{class:`twoslash-popup-code`},[a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`function`),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` defineUserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`(`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},`config`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},`UserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`):`),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},` UserConfig`)])],-1)]]),default:e(()=>[o[26]||=a(`span`,null,`defineUserConfig`,-1)]),_:1})]),o[30]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`({`,-1)]),o[42]||=r(`
|
|
`,-1),a(`span`,_,[o[35]||=a(`span`,{style:{"--shiki-light":`#998418`,"--shiki-dark":`#B8A965`}},` `,-1),a(`span`,v,[n(Q,{class:`twoslash-hover`,"popper-class":`shiki twoslash-floating vp-copy-ignore vp-code`,theme:`twoslash`},{popper:e(({})=>[...o[31]||=[a(`span`,{class:`twoslash-popup-container vp-copy-ignore`},[a(`code`,{class:`twoslash-popup-code`},[a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},`theme`),a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`?:`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` Theme`),a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},` |`),a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},` undefined`)]),a(`div`,{class:`twoslash-popup-docs vp-doc`,"vp-content":``},[a(`p`,null,`Vuepress theme`)]),a(`div`,{class:`twoslash-popup-docs twoslash-popup-docs-tags vp-doc`,"vp-content":``},[a(`span`,{class:`twoslash-popup-docs-tag`},[a(`span`,{class:`twoslash-popup-docs-tag-name`},`@required`)])])],-1)]]),default:e(()=>[o[32]||=a(`span`,null,`theme`,-1)]),_:1})]),o[36]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `,-1),a(`span`,y,[n(Q,{class:`twoslash-hover`,"popper-class":`shiki twoslash-floating vp-copy-ignore vp-code`,theme:`twoslash`},{popper:e(({})=>[...o[33]||=[a(`span`,{class:`twoslash-popup-container vp-copy-ignore`},[a(`code`,{class:`twoslash-popup-code`},[a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`function`),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` plumeTheme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`(`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},`options`),a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`?`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},`ThemeOptions`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`):`),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},` Theme`)]),a(`div`,{class:`twoslash-popup-docs vp-doc`,"vp-content":``},[a(`p`,null,`VuePress Theme Plume`),r(`
|
|
`),a(`p`,null,`VuePress 主题 Plume`)]),a(`div`,{class:`twoslash-popup-docs twoslash-popup-docs-tags vp-doc`,"vp-content":``},[a(`span`,{class:`twoslash-popup-docs-tag`},[a(`span`,{class:`twoslash-popup-docs-tag-name`},`@param`),a(`span`,{class:`twoslash-popup-docs-tag-value`},[a(`code`,null,`options`),r(` Theme options / 主题配置`)])]),a(`span`,{class:`twoslash-popup-docs-tag`},[a(`span`,{class:`twoslash-popup-docs-tag-name`},`@example`),a(`span`,{class:`twoslash-popup-docs-tag-value`},[a(`div`,{class:`language-ts`,"data-ext":`ts`,"data-title":`ts`,"data-highlighter":`shiki`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`}},[a(`pre`,{class:`shiki shiki-themes vitesse-light vitesse-dark`,style:{"--shiki-light":`#393a34`,"--shiki-dark":`#dbd7caee`,"--shiki-light-bg":`#ffffff`,"--shiki-dark-bg":`#121212`},tabindex:`0`},[a(`code`,null,[a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`import`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` {`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` defineUserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` }`),a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` from`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},` '`),a(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},`vuepress`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},`'`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`import`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` {`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` plumeTheme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` }`),a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` from`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},` '`),a(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},`vuepress-theme-plume`),a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},`'`)]),r(`
|
|
`),a(`span`,{class:`line`}),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`export`),a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` default`),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` defineUserConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`({`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#998418`,"--shiki-dark":`#B8A965`}},` theme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},`plumeTheme`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`({`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#A0ADA0`,"--shiki-dark":`#758575DD`}},` // ...options`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` })`)]),r(`
|
|
`),a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`})`)])])])])])])])],-1)]]),default:e(()=>[o[34]||=a(`span`,null,`plumeTheme`,-1)]),_:1})]),o[37]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`({`,-1)]),o[43]||=r(`
|
|
`,-1),o[44]||=a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#A0ADA0`,"--shiki-dark":`#758575DD`}},` // Theme configuration`)],-1),o[45]||=r(`
|
|
`,-1),o[46]||=a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` })`)],-1),o[47]||=r(`
|
|
`,-1),o[48]||=a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`})`)],-1)])])])]),tab1:e(({value:t,isActive:ee})=>[a(`div`,b,[a(`pre`,x,[a(`code`,S,[a(`span`,C,[o[51]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`import`,-1),o[52]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` {`,-1),o[53]||=a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},` `,-1),a(`span`,w,[n(Q,{class:`twoslash-hover`,"popper-class":`shiki twoslash-floating vp-copy-ignore vp-code`,theme:`twoslash`},{popper:e(({})=>[...o[49]||=[a(`span`,{class:`twoslash-popup-container vp-copy-ignore`},[a(`code`,{class:`twoslash-popup-code`},[a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`function`),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` defineThemeConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`(`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},`config`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},`ThemeConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`):`),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},` ThemeConfig`)]),a(`div`,{class:`twoslash-popup-docs vp-doc`,"vp-content":``},[a(`p`,null,[r(`Theme configuration helper function, used in separate `),a(`code`,null,`plume.config.ts`)]),r(`
|
|
`),a(`p`,null,[r(`主题配置,在单独的 `),a(`code`,null,`plume.config.ts`),r(` 中使用的类型帮助函数`)])])],-1)]]),default:e(()=>[o[50]||=a(`span`,null,`defineThemeConfig`,-1)]),_:1})]),o[54]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},` }`,-1),o[55]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` from`,-1),o[56]||=a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},` '`,-1),o[57]||=a(`span`,{style:{"--shiki-light":`#B56959`,"--shiki-dark":`#C98A7D`}},`vuepress-theme-plume`,-1),o[58]||=a(`span`,{style:{"--shiki-light":`#B5695977`,"--shiki-dark":`#C98A7D77`}},`'`,-1)]),o[65]||=r(`
|
|
`,-1),o[66]||=a(`span`,{class:`line`},null,-1),o[67]||=r(`
|
|
`,-1),a(`span`,T,[o[61]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},`export`,-1),o[62]||=a(`span`,{style:{"--shiki-light":`#1E754F`,"--shiki-dark":`#4D9375`}},` default`,-1),o[63]||=a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` `,-1),a(`span`,E,[n(Q,{class:`twoslash-hover`,"popper-class":`shiki twoslash-floating vp-copy-ignore vp-code`,theme:`twoslash`},{popper:e(({})=>[...o[59]||=[a(`span`,{class:`twoslash-popup-container vp-copy-ignore`},[a(`code`,{class:`twoslash-popup-code`},[a(`span`,{style:{"--shiki-light":`#AB5959`,"--shiki-dark":`#CB7676`}},`function`),a(`span`,{style:{"--shiki-light":`#59873A`,"--shiki-dark":`#80A665`}},` defineThemeConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`(`),a(`span`,{style:{"--shiki-light":`#B07D48`,"--shiki-dark":`#BD976A`}},`config`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`: `),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},`ThemeConfig`),a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`):`),a(`span`,{style:{"--shiki-light":`#2E8F82`,"--shiki-dark":`#5DA994`}},` ThemeConfig`)]),a(`div`,{class:`twoslash-popup-docs vp-doc`,"vp-content":``},[a(`p`,null,[r(`Theme configuration helper function, used in separate `),a(`code`,null,`plume.config.ts`)]),r(`
|
|
`),a(`p`,null,[r(`主题配置,在单独的 `),a(`code`,null,`plume.config.ts`),r(` 中使用的类型帮助函数`)])])],-1)]]),default:e(()=>[o[60]||=a(`span`,null,`defineThemeConfig`,-1)]),_:1})]),o[64]||=a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`({`,-1)]),o[68]||=r(`
|
|
`,-1),o[69]||=a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#A0ADA0`,"--shiki-dark":`#758575DD`}},` // Theme configuration`)],-1),o[70]||=r(`
|
|
`,-1),o[71]||=a(`span`,{class:`line`},[a(`span`,{style:{"--shiki-light":`#999999`,"--shiki-dark":`#666666`}},`})`)],-1)])])])]),_:1}),o[293]||=a(`h2`,{id:`basic-configuration`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#basic-configuration`},[a(`span`,null,`Basic Configuration`)])],-1),o[294]||=a(`h3`,{id:`configfile`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#configfile`},[a(`span`,null,`configFile`)])],-1),a(`ul`,null,[o[80]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`string`)])],-1),o[81]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`''`)])],-1),a(`li`,null,[o[78]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),o[79]||=a(`p`,null,`Custom path to the theme configuration file.`,-1),a(`p`,null,[o[73]||=r(`Refer to `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[72]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[74]||=r(` for more information.`,-1)]),a(`div`,D,[a(`p`,O,[o[76]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[75]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[77]||=r(`.`,-1)])])])]),o[295]||=a(`h3`,{id:`plugins`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#plugins`},[a(`span`,null,`plugins`)])],-1),a(`ul`,null,[o[90]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`PlumeThemePluginOptions`)])],-1),o[91]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`{}`)])],-1),a(`li`,null,[o[88]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),o[89]||=a(`p`,null,`Custom configuration for plugins used internally by the theme.`,-1),a(`p`,null,[o[83]||=r(`The plugins used by the theme are configured by default. In most cases, modification is not required. For detailed customization, please refer to `,-1),n(X,{href:`./plugins/README.md`},{default:e(()=>[...o[82]||=[r(`this documentation`,-1)]]),_:1}),o[84]||=r(`.`,-1)]),a(`div`,k,[a(`p`,A,[o[86]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[85]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[87]||=r(`.`,-1)])])])]),a(`h3`,j,[a(`a`,M,[a(`span`,null,[o[92]||=r(`markdown `,-1),n($,{type:`tip`,text:`1.0.0-rc.136 +`})])])]),a(`ul`,null,[o[100]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`MarkdownOptions`)])],-1),o[101]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`{}`)])],-1),a(`li`,null,[o[99]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[94]||=r(`Markdown feature configuration. Refer to `,-1),n(X,{href:`./markdown.md`},{default:e(()=>[...o[93]||=[r(`this documentation`,-1)]]),_:1}),o[95]||=r(`.`,-1)]),a(`div`,N,[a(`p`,P,[o[97]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[96]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[98]||=r(`.`,-1)])])])]),a(`h3`,F,[a(`a`,I,[a(`span`,null,[o[102]||=r(`codeHighlighter `,-1),n($,{type:`tip`,text:`1.0.0-rc.136 +`})])])]),a(`ul`,null,[o[110]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | ShikiPluginOptions`)])],-1),o[111]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`{}`)])],-1),a(`li`,null,[o[109]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[104]||=r(`Code highlighting configuration. Refer to `,-1),n(X,{href:`../guide/code/intro.md`},{default:e(()=>[...o[103]||=[r(`this documentation`,-1)]]),_:1}),o[105]||=r(`.`,-1)]),a(`div`,L,[a(`p`,R,[o[107]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[106]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[108]||=r(`.`,-1)])])])]),a(`h3`,z,[a(`a`,B,[a(`span`,null,[o[112]||=r(`search `,-1),n($,{type:`tip`,text:`1.0.0-rc.136 +`})])])]),a(`ul`,null,[o[120]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | SearchOptions`)])],-1),o[121]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`{ provider: 'local' }`)])],-1),a(`li`,null,[o[119]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[114]||=r(`Search configuration. Refer to `,-1),n(X,{href:`../guide/features/search.md`},{default:e(()=>[...o[113]||=[r(`this documentation`,-1)]]),_:1}),o[115]||=r(`.`,-1)]),a(`div`,V,[a(`p`,H,[o[117]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[116]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[118]||=r(`.`,-1)])])])]),a(`h3`,U,[a(`a`,W,[a(`span`,null,[o[122]||=r(`comment `,-1),n($,{type:`tip`,text:`1.0.0-rc.136 +`})])])]),a(`ul`,null,[o[130]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | CommentPluginOptions`)])],-1),o[131]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[129]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[124]||=r(`Comment configuration. Refer to `,-1),n(X,{href:`../guide/features/comments.md`},{default:e(()=>[...o[123]||=[r(`this documentation`,-1)]]),_:1}),o[125]||=r(`.`,-1)]),a(`div`,G,[a(`p`,K,[o[127]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[126]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[128]||=r(`.`,-1)])])])]),a(`h3`,ae,[a(`a`,q,[a(`span`,null,[o[132]||=r(`watermark `,-1),n($,{type:`tip`,text:`1.0.0-rc.136 +`})])])]),a(`ul`,null,[o[140]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | WatermarkPluginOptions`)])],-1),o[141]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[139]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[134]||=r(`Watermark configuration. Refer to `,-1),n(X,{href:`../guide/features/watermark.md`},{default:e(()=>[...o[133]||=[r(`this documentation`,-1)]]),_:1}),o[135]||=r(`.`,-1)]),a(`div`,J,[a(`p`,oe,[o[137]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[136]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[138]||=r(`.`,-1)])])])]),a(`h3`,se,[a(`a`,ce,[a(`span`,null,[o[142]||=r(`readingTime `,-1),n($,{type:`tip`,text:`1.0.0-rc.136 +`})])])]),a(`ul`,null,[o[150]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | ReadingTimePluginOptions`)])],-1),o[151]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[149]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[144]||=r(`Reading time configuration. Refer to `,-1),n(X,{href:`./plugins/reading-time.md`},{default:e(()=>[...o[143]||=[r(`this documentation`,-1)]]),_:1}),o[145]||=r(`.`,-1)]),a(`div`,le,[a(`p`,ue,[o[147]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[146]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[148]||=r(`.`,-1)])])])]),a(`h3`,de,[a(`a`,fe,[a(`span`,null,[o[152]||=r(`copyCode `,-1),n($,{type:`tip`,text:`1.0.0-rc.136 +`})])])]),a(`ul`,null,[o[160]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | CopyCodePluginOptions`)])],-1),o[161]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`{}`)])],-1),a(`li`,null,[o[159]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[154]||=r(`Copy code configuration. Refer to `,-1),n(X,{href:`../guide/code/copy-code.md`},{default:e(()=>[...o[153]||=[r(`this documentation`,-1)]]),_:1}),o[155]||=r(`.`,-1)]),a(`div`,pe,[a(`p`,me,[o[157]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[156]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[158]||=r(`.`,-1)])])])]),a(`h3`,he,[a(`a`,ge,[a(`span`,null,[o[162]||=r(`replaceAssets `,-1),n($,{type:`tip`,text:`1.0.0-rc.139 +`})])])]),a(`ul`,null,[o[170]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | ReplaceAssetsPluginOptions`)])],-1),o[171]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[169]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[164]||=r(`Replace assets configuration. Refer to `,-1),n(X,{href:`../guide/features/replace-assets.md`},{default:e(()=>[...o[163]||=[r(`this documentation`,-1)]]),_:1}),o[165]||=r(`.`,-1)]),a(`div`,_e,[a(`p`,ve,[o[167]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[166]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[168]||=r(`.`,-1)])])])]),o[296]||=a(`h3`,{id:`hostname`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#hostname`},[a(`span`,null,`hostname`)])],-1),a(`ul`,null,[o[178]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`string`)])],-1),o[179]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`''`)])],-1),a(`li`,null,[o[175]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),o[176]||=a(`p`,null,`Deployment site domain name.`,-1),o[177]||=a(`p`,null,[r(`When `),a(`code`,null,`hostname`),r(` is configured to a valid domain, the theme will generate `),a(`code`,null,`sitemap`),r(` and SEO-related content.`)],-1),a(`div`,ye,[a(`p`,be,[o[173]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[172]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[174]||=r(`.`,-1)])])])]),o[297]||=i(`<h3 id="autofrontmatter" tabindex="-1"><a class="header-anchor" href="#autofrontmatter"><span>autoFrontmatter</span></a></h3><ul><li><p><strong>Type:</strong> <code>false | AutoFrontmatterOptions</code></p></li><li><p><strong>Details:</strong></p><p>Whether to automatically add frontmatter configuration to markdown files.</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> AutoFrontmatterOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to automatically generate permalink</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> true</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - true: auto generate permalink</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - false: do not generate permalink</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * - 'filepath': generate permalink based on file path</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> permalink</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">filepath</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to automatically generate createTime</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Reads file creation time by default. \`createTime\` is more precise (to the second) than the default VuePress \`date\` field.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> createTime</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to automatically generate title</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Uses the filename as the title by default.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> title</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h3 id="cache" tabindex="-1"><a class="header-anchor" href="#cache"><span>cache</span></a></h3>`,3),a(`ul`,null,[o[186]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | 'memory' | 'filesystem'`)])],-1),o[187]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`filesystem`)])],-1),a(`li`,null,[o[185]||=i(`<p><strong>Details:</strong></p><p>Whether to enable compilation cache, or configure the caching method.</p><p>This configuration item addresses the slow startup speed of VuePress. It caches the compilation results during the first service start. On subsequent starts, it reads the cache directly, skipping compilation to speed up startup.</p><ul><li><code>false</code>: Disable cache.</li><li><code>'memory'</code>: Use memory cache. This method provides faster startup speed but increases memory usage as the number of project files grows. Suitable for projects with fewer articles.</li><li><code>'filesystem'</code>: Use filesystem cache. This method provides a relatively fast and stable startup speed, more suitable for projects with substantial content.</li></ul>`,4),a(`div`,xe,[o[183]||=a(`p`,{class:`hint-container-title`},`Warning`,-1),a(`p`,null,[o[181]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[180]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[182]||=r(`.`,-1)]),o[184]||=a(`p`,null,[r(`For the cache to take effect, you should `),a(`strong`,null,`remove`),r(` the `),a(`code`,null,`--clean-cache`),r(` parameter from the `),a(`code`,null,`vuepress dev`),r(` development server startup script in your `),a(`code`,null,`package.json`),r(`.`)],-1)])])]),o[298]||=i(`<h3 id="docsrepo" tabindex="-1"><a class="header-anchor" href="#docsrepo"><span>docsRepo</span></a></h3><ul><li><strong>Type:</strong> <code>string</code></li><li><strong>Default:</strong> <code>''</code></li><li><strong>Details:</strong> Documentation repository configuration, used to generate the <code>Edit this page</code> link.</li></ul><h3 id="docsbranch" tabindex="-1"><a class="header-anchor" href="#docsbranch"><span>docsBranch</span></a></h3><ul><li><strong>Type:</strong> <code>string</code></li><li><strong>Default:</strong> <code>''</code></li><li><strong>Details:</strong> Documentation repository branch configuration, used to generate the <code>Edit this page</code> link.</li></ul><h3 id="docsdir" tabindex="-1"><a class="header-anchor" href="#docsdir"><span>docsDir</span></a></h3><ul><li><strong>Type:</strong> <code>string</code></li><li><strong>Default:</strong> <code>''</code></li><li><strong>Details:</strong> Documentation repository directory configuration, used to generate the <code>Edit this page</code> link.</li></ul><h3 id="editlink" tabindex="-1"><a class="header-anchor" href="#editlink"><span>editLink</span></a></h3>`,7),a(`ul`,null,[o[192]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`boolean`)])],-1),o[193]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`true`)])],-1),a(`li`,null,[o[191]||=a(`p`,null,[a(`strong`,null,`Details:`),r(` Whether to enable the edit link.`)],-1),a(`div`,Se,[a(`p`,Ce,[o[189]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[188]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[190]||=r(`.`,-1)])])])]),o[299]||=i(`<h3 id="lastupdated" tabindex="-1"><a class="header-anchor" href="#lastupdated"><span>lastUpdated</span></a></h3><ul><li><strong>Type:</strong> <code>false | LastUpdatedOptions</code></li><li><strong>Default:</strong> <code>{ formatOptions: { dateStyle: 'short', timeStyle: 'short' } }</code></li><li><strong>Details:</strong> Last updated time.</li></ul><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> LastUpdatedOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Options to set the format of the last updated time.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">see</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * { dateStyle: 'short', timeStyle: 'short' }</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> formatOptions</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">Intl</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">.</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">DateTimeFormatOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> & { </span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;">forceLocale</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div>`,3),a(`div`,we,[a(`p`,Te,[o[195]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[194]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[196]||=r(`.`,-1)])]),o[300]||=a(`h3`,{id:`contributors`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#contributors`},[a(`span`,null,`contributors`)])],-1),a(`ul`,null,[o[204]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`boolean | ContributorsOptions`)])],-1),o[205]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`true`)])],-1),a(`li`,null,[o[203]||=a(`p`,null,[a(`strong`,null,`Details:`),r(` Whether to display contributors.`)],-1),a(`p`,null,[o[198]||=r(`For more configuration, please refer to `,-1),n(X,{href:`../guide/features/contributors.md`},{default:e(()=>[...o[197]||=[r(`this documentation`,-1)]]),_:1}),o[199]||=r(`.`,-1)]),a(`div`,Ee,[a(`p`,De,[o[201]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[200]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[202]||=r(`.`,-1)])])])]),o[301]||=a(`h3`,{id:`changelog`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#changelog`},[a(`span`,null,`changelog`)])],-1),a(`ul`,null,[o[213]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`boolean | ChangelogOptions`)])],-1),o[214]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[212]||=a(`p`,null,[a(`strong`,null,`Details:`),r(` Whether to display page change history.`)],-1),a(`p`,null,[o[207]||=r(`For more configuration, please refer to `,-1),n(X,{href:`../guide/features/changelog.md`},{default:e(()=>[...o[206]||=[r(`this documentation`,-1)]]),_:1}),o[208]||=r(`.`,-1)]),a(`div`,Y,[a(`p`,Oe,[o[210]||=r(`This field is not supported for configuration in the `,-1),n(X,{href:`./intro.md#theme-config-file`},{default:e(()=>[...o[209]||=[r(`Theme Config File `,-1),a(`code`,null,`plume.config.js`,-1)]]),_:1}),o[211]||=r(`.`,-1)])])])]),o[302]||=i(`<h3 id="locales" tabindex="-1"><a class="header-anchor" href="#locales"><span>locales</span></a></h3><ul><li><strong>Type:</strong> <code>Record<string, ThemeLocaleData></code></li><li><strong>Default:</strong> <code>{}</code></li><li><strong>Details:</strong> Multi-language configuration.</li></ul>`,2),a(`p`,null,[o[216]||=r(`Text configuration for different languages. Refer to `,-1),n(X,{href:`./locales.md`},{default:e(()=>[...o[215]||=[r(`this documentation`,-1)]]),_:1}),o[217]||=r(`.`,-1)]),o[303]||=i(`<p>The multi-language configuration supports all configuration options under the following <a href="#locale-configuration">Locale</a> to control theme behavior in different languages.</p><h2 id="locale-configuration" tabindex="-1"><a class="header-anchor" href="#locale-configuration"><span>Locale Configuration</span></a></h2><div class="hint-container tip"><p class="hint-container-title">All the following fields are also basic configuration fields and can be configured at the same level as fields like <code>locales</code>.</p></div><h3 id="home" tabindex="-1"><a class="header-anchor" href="#home"><span>home</span></a></h3><ul><li><strong>Type:</strong> <code>false | string</code></li><li><strong>Default:</strong> <code>/</code></li><li><strong>Details:</strong> The path to the home page. It will be used for: <ul><li>The logo link in the navbar;</li><li>The <em>Back to Home</em> link on the 404 page;</li></ul></li></ul><h3 id="logo" tabindex="-1"><a class="header-anchor" href="#logo"><span>logo</span></a></h3><ul><li><strong>Type:</strong> <code>false | string</code></li><li><strong>Default:</strong> <code>false</code></li><li><strong>Details:</strong> Logo in the navbar.</li></ul><h3 id="logodark" tabindex="-1"><a class="header-anchor" href="#logodark"><span>logoDark</span></a></h3><ul><li><strong>Type:</strong> <code>false | string</code></li><li><strong>Default:</strong> <code>false</code></li><li><strong>Details:</strong> Logo in the navbar for Dark mode.</li></ul><h3 id="appearance" tabindex="-1"><a class="header-anchor" href="#appearance"><span>appearance</span></a></h3><ul><li><strong>Type:</strong> <code>boolean | 'dark' | 'force-dark'</code></li><li><strong>Default:</strong> <code>true</code></li></ul><p>Whether to enable dark mode.</p><ul><li>If this option is set to <code>true</code>, the default theme will be determined by the user's preferred color scheme.</li><li>If this option is set to <code>dark</code>, the theme will be dark by default unless the user manually toggles it.</li><li>If this option is set to <code>false</code>, the user will not be able to switch themes.</li><li>If this option is set to <code>force-dark</code>, the user will not be able to switch themes, and the theme will be forced to dark.</li></ul><p>This option injects an inline script that restores user settings from local storage. This ensures <code>[data-theme="dark"]</code> is applied before the page is rendered to avoid flashing.</p><h3 id="profile" tabindex="-1"><a class="header-anchor" href="#profile"><span>profile</span></a></h3><ul><li><strong>Type:</strong> <code>ProfileOptions</code></li><li><strong>Default:</strong> <code>{}</code></li><li><strong>Details:</strong> Configure the site owner's personal information. <ul><li><code>profile.avatar</code>: Avatar URL, used for displaying blogger information on the right.</li><li><code>profile.name</code>: Name, used for displaying blogger information on the right.</li><li><code>profile.description</code>: Personal description, used for displaying blogger information on the right.</li><li><code>profile.circle</code>: Whether the avatar is circular.</li><li><code>profile.location</code>: User's geographical location.</li><li><code>profile.organization</code>: User's organization/company.</li><li><code>profile.layout</code>: Whether to display personal information on the left or right, <code>'left' | 'right'</code>.</li></ul></li></ul><p>Example:</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;">plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> profile</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> avatar</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/avatar.jpg</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> name</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Zhang San</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> description</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Here is no silver three hundred two, next door Wang Er never stole</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> circle</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">true</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> location</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Hangzhou, China</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> organization</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">XXX Company</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> layout</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">right</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> })</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="social" tabindex="-1"><a class="header-anchor" href="#social"><span>social</span></a></h3>`,19),a(`ul`,null,[o[248]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | SocialLink[]`)])],-1),o[249]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[246]||=i(`<p><strong>Details:</strong> Personal social information configuration.</p><p>Displayed as icon links on the far right of the navbar.</p><p>Supports any icon from <a href="https://icon-sets.iconify.design/" target="_blank" rel="noopener noreferrer">Iconify</a>. Simply use the iconify name to load it automatically.</p><p>For icons in the <code>simple-icons</code> collection, you can omit the <code>simple-icons:</code> prefix. For example, <code>simple-icons:github</code> can be abbreviated as <code>github</code>.</p><p>Examples of common social icons:</p>`,5),a(`div`,ke,[a(`div`,Ae,[a(`ul`,null,[a(`li`,null,[o[218]||=r(`discord `,-1),n(Z,{provider:`iconify`,name:`simple-icons:discord`})]),a(`li`,null,[o[219]||=r(`telegram `,-1),n(Z,{provider:`iconify`,name:`simple-icons:telegram`})]),a(`li`,null,[o[220]||=r(`facebook `,-1),n(Z,{provider:`iconify`,name:`simple-icons:facebook`})]),a(`li`,null,[o[221]||=r(`github `,-1),n(Z,{provider:`iconify`,name:`simple-icons:github`})]),a(`li`,null,[o[222]||=r(`instagram `,-1),n(Z,{provider:`iconify`,name:`simple-icons:instagram`})]),a(`li`,null,[o[223]||=r(`linkedin `,-1),n(Z,{provider:`iconify`,name:`simple-icons:linkedin`})]),a(`li`,null,[o[224]||=r(`mastodon `,-1),n(Z,{provider:`iconify`,name:`simple-icons:mastodon`})]),a(`li`,null,[o[225]||=r(`npm `,-1),n(Z,{provider:`iconify`,name:`simple-icons:npm`})]),a(`li`,null,[o[226]||=r(`slack `,-1),n(Z,{provider:`iconify`,name:`simple-icons:slack`})]),a(`li`,null,[o[227]||=r(`twitter `,-1),n(Z,{provider:`iconify`,name:`simple-icons:twitter`})]),a(`li`,null,[o[228]||=r(`x `,-1),n(Z,{provider:`iconify`,name:`simple-icons:x`})]),a(`li`,null,[o[229]||=r(`youtube `,-1),n(Z,{provider:`iconify`,name:`simple-icons:youtube`})]),a(`li`,null,[o[230]||=r(`bluesky `,-1),n(Z,{provider:`iconify`,name:`simple-icons:bluesky`})]),a(`li`,null,[o[231]||=r(`tiktok `,-1),n(Z,{provider:`iconify`,name:`simple-icons:tiktok`})])])]),a(`div`,je,[a(`ul`,null,[a(`li`,null,[o[232]||=r(`qq `,-1),n(Z,{provider:`iconify`,name:`simple-icons:qq`})]),a(`li`,null,[o[233]||=r(`weibo `,-1),n(Z,{provider:`iconify`,name:`simple-icons:sinaweibo`})]),a(`li`,null,[o[234]||=r(`bilibili `,-1),n(Z,{provider:`iconify`,name:`simple-icons:bilibili`})]),a(`li`,null,[o[235]||=r(`gitlab `,-1),n(Z,{provider:`iconify`,name:`simple-icons:gitlab`})]),a(`li`,null,[o[236]||=r(`docker `,-1),n(Z,{provider:`iconify`,name:`simple-icons:docker`})]),a(`li`,null,[o[237]||=r(`juejin `,-1),n(Z,{provider:`iconify`,name:`simple-icons:juejin`})]),a(`li`,null,[o[238]||=r(`zhihu `,-1),n(Z,{provider:`iconify`,name:`simple-icons:zhihu`})]),a(`li`,null,[o[239]||=r(`douban `,-1),n(Z,{provider:`iconify`,name:`simple-icons:douban`})]),a(`li`,null,[o[240]||=r(`steam `,-1),n(Z,{provider:`iconify`,name:`simple-icons:steam`})]),a(`li`,null,[o[241]||=r(`stackoverflow `,-1),n(Z,{provider:`iconify`,name:`simple-icons:stackoverflow`})]),a(`li`,null,[o[242]||=r(`xbox `,-1),n(Z,{provider:`iconify`,name:`simple-icons:xbox`})]),a(`li`,null,[o[243]||=r(`kuaishou `,-1),n(Z,{provider:`iconify`,name:`simple-icons:kuaishou`})]),a(`li`,null,[o[244]||=r(`twitch `,-1),n(Z,{provider:`iconify`,name:`simple-icons:twitch`})]),a(`li`,null,[o[245]||=r(`xiaohongshu `,-1),n(Z,{provider:`iconify`,name:`simple-icons:xiaohongshu`})])])])]),o[247]||=i(`<p><a href="https://icon-sets.iconify.design/simple-icons/" class="readmore" target="_blank" rel="noopener noreferrer">You can view all available icons for <strong>simple-icons</strong> here</a></p><p>If <strong>Iconify</strong> does not meet your needs, you can pass in the format <code>{ svg: string, name?: string }</code> to use a custom icon. Pass in the SVG source code string, with the optional <code>name</code> field for configuring <a href="#navbarsocialinclude"><code>navbarSocialInclude</code></a>.</p>`,2)])]),o[304]||=i(`<p>Example:</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;">plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> social</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: [</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // use iconify name</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> { </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">icon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">github</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">, </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">https://github.com/zhangsan</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // use custom icon</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> icon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: { </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">svg</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;"><svg>xxxxx</svg></span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">, </span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">name</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">xxx</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">https://xxx.com</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ]</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> })</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="navbarsocialinclude" tabindex="-1"><a class="header-anchor" href="#navbarsocialinclude"><span>navbarSocialInclude</span></a></h3><ul><li><p><strong>Type:</strong> <code>string[]</code></p></li><li><p><strong>Default:</strong> <code>['github', 'twitter', 'discord', 'facebook']</code></p></li><li><p><strong>Details:</strong></p><p>Social links allowed to be displayed in the navbar. This configuration is only effective on PC.</p><p>If <a href="#social"><code>social</code></a> is configured as <code>{ svg: string, name: string}</code>, then <code>name</code> can be used as a value for <code>navbarSocialInclude</code>.</p></li></ul><h3 id="navbar" tabindex="-1"><a class="header-anchor" href="#navbar"><span>navbar</span></a></h3><ul><li><p><strong>Type:</strong> <code>NavItem[]</code></p></li><li><p><strong>Default:</strong> <code>[]</code></p></li><li><p><strong>Details:</strong> Navbar configuration.</p><p>To configure navbar elements, you can set it to a navbar array, where each element is a <code>string</code> or a <code>NavItem</code> object.</p><ul><li>A <code>NavItem</code> object should have a <code>text</code> field and a <code>link</code> field, with an optional <code>activeMatch</code> field.</li><li>A <code>string</code> represents a page file path or a page access path.</li></ul></li></ul><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">type</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> NavItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> =</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * The page prefix for the current group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> prefix</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Navigation items under this group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> items</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">NavItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[]</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Supports iconify icons. Use the iconify name directly and it will be loaded automatically.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> *</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">see</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> https://icon-sets.iconify.design/</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> icon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Controls when the element is active.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> activeMatch</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li><p>Example 1:</p><div class="language-js line-numbers-mode" data-highlighter="shiki" data-ext="js" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-js"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> navbar</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // NavbarItem</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Foo</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // NavbarGroup</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Group</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> prefix</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/group/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">bar/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // String - page file path</span></span>
|
|
<span class="line"><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/bar</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // The \`.md\` extension can be omitted directly.</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }),</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>Example 2:</p><div class="language-js line-numbers-mode" data-highlighter="shiki" data-ext="js" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-js"><span class="line"><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">export</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;"> default</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> defineUserConfig</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> theme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#59873A;--shiki-dark:#80A665;"> plumeTheme</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">({</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> navbar</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Nested Group - maximum depth is 2</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Group</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">SubGroup</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/group/sub/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/group/sub/bar/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Control when the element is active</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Group 2</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Always active</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // This element will always be active</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> activeMatch</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> text</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Active on /foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> link</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">/not-foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // This element is active when the current route path starts with /foo/</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // Supports regular expressions</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> activeMatch</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">^/foo/</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> },</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> ],</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }),</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">})</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h3 id="collections" tabindex="-1"><a class="header-anchor" href="#collections"><span>collections</span></a></h3>`,9),a(`ul`,null,[o[253]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`ThemeCollectionItem[]`)])],-1),o[254]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`[]`)])],-1),a(`li`,null,[o[252]||=a(`p`,null,[a(`strong`,null,`Details:`),r(` Documentation collections configuration.`)],-1),a(`p`,null,[n(X,{href:`../guide/quick-start/collection.md`,class:`read-more`},{default:e(()=>[...o[250]||=[r(`Check `,-1),a(`strong`,null,`Collections Guide`,-1)]]),_:1})]),a(`p`,null,[n(X,{href:`./collections.md`,class:`read-more`},{default:e(()=>[...o[251]||=[r(`Check `,-1),a(`strong`,null,`Collections Configuration`,-1),r(` to learn more`,-1)]]),_:1})])])]),o[305]||=a(`h3`,{id:`sidebar`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#sidebar`},[a(`span`,null,`sidebar`)])],-1),a(`ul`,null,[o[261]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | SidebarMulti`)])],-1),a(`li`,null,[o[259]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),a(`p`,null,[o[258]||=r(`Sidebar configuration. `,-1),a(`strong`,null,[o[256]||=r(`The theme recommends configuring the sidebar in `,-1),n(X,{href:`./collections.md`},{default:e(()=>[...o[255]||=[r(`collections configuration`,-1)]]),_:1}),o[257]||=r(`.`,-1)])]),o[260]||=i(`<p>The <code>key</code> of the configuration object is the common access path prefix for the sidebar.</p><p>For <code>value</code>:</p><ul><li><code>'auto'</code> means automatically generate the sidebar based on the directory structure.</li><li><code>string</code> represents the page file path corresponding to the sidebar.</li><li><code>SidebarItem</code> represents a single sidebar item configuration.</li></ul>`,3)])]),o[306]||=i(`<div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">type</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> ThemeIcon</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> =</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> svg</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">type</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> SidebarMulti</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> =</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> Record</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"><</span></span>
|
|
<span class="line"><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">,</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">auto</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> (</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)[]</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> items</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">auto</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | (</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)[],</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> prefix</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> }</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">></span></span>
|
|
<span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Sidebar text.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> text</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Sidebar link.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> link</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Sidebar icon.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> icon</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">ThemeIcon</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Nested sidebar group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> items</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">auto</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | (</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">SidebarItem</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)[]</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * If not specified, the group is not collapsible.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * If \`true\`, the group is collapsible and collapsed by default.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * If \`false\`, the group is collapsible but expanded by default.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> collapsed</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Link prefix for the current group.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> prefix</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> rel</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> target</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">string</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="sidebarscrollbar" tabindex="-1"><a class="header-anchor" href="#sidebarscrollbar"><span>sidebarScrollbar</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong> Whether to show the sidebar scrollbar.</p><p>When set to <code>false</code>, only the scrollbar is hidden, but the scrolling behavior remains unchanged.</p></li></ul><h3 id="aside" tabindex="-1"><a class="header-anchor" href="#aside"><span>aside</span></a></h3>`,4),a(`ul`,null,[o[268]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`boolean | 'left'`)])],-1),o[269]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`true`)])],-1),a(`li`,null,[o[265]||=a(`p`,null,[a(`strong`,null,`Details:`)],-1),o[266]||=a(`p`,null,`Whether to display the aside (right sidebar).`,-1),o[267]||=a(`ul`,null,[a(`li`,null,[a(`code`,null,`false`),r(` disables the right aside.`)]),a(`li`,null,[a(`code`,null,`true`),r(` enables the right aside.`)]),a(`li`,null,[a(`code`,null,`'left'`),r(` moves the right aside to the left side of the article content, to the right of the main sidebar.`)])],-1),a(`p`,null,[o[263]||=r(`Each page can override this global configuration via `,-1),n(X,{href:`./frontmatter/basic.md#aside`},{default:e(()=>[...o[262]||=[r(`frontmatter aside`,-1)]]),_:1}),o[264]||=r(`.`,-1)])])]),o[307]||=a(`h3`,{id:`outline`,tabindex:`-1`},[a(`a`,{class:`header-anchor`,href:`#outline`},[a(`span`,null,`outline`)])],-1),a(`ul`,null,[o[274]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`false | number | [number, number] | 'deep'`)])],-1),o[275]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`[2, 3]`)])],-1),a(`li`,null,[o[273]||=i(`<p><strong>Details:</strong></p><p>The heading levels to display.</p><p>A single number means only display headings of that level.</p><p>If a tuple is passed, the first number is the minimum level and the second is the maximum level.</p><p><code>'deep'</code> is the same as <code>[2, 6]</code>, which displays all headings from <code><h2></code> to <code><h6></code>.</p><p>When <a href="#aside">aside</a> is disabled, <code>outline</code> is also disabled.</p>`,6),a(`p`,null,[o[271]||=r(`Each page can override this global configuration via `,-1),n(X,{href:`./frontmatter/basic.md#outline`},{default:e(()=>[...o[270]||=[r(`frontmatter outline`,-1)]]),_:1}),o[272]||=r(`.`,-1)])])]),o[308]||=i(`<h3 id="transition" tabindex="-1"><a class="header-anchor" href="#transition"><span>transition</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | TransitionOptions</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong></p><p>Whether to enable transition animations.</p><p>When passing a <code>boolean</code>, <code>true</code> enables and <code>false</code> disables.</p><p>An object can also be passed for specific configuration, as shown below.</p><div class="language-ts line-numbers-mode" data-highlighter="shiki" data-ext="ts" style="--shiki-light:#393a34;--shiki-dark:#dbd7caee;--shiki-light-bg:#ffffff;--shiki-dark-bg:#121212;"><pre class="shiki shiki-themes vitesse-light vitesse-dark vp-code"><code class="language-ts"><span class="line"><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">interface</span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;"> TransitionOptions</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> {</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to enable page transition animations.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> true</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> page</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to enable blog post list transition animations.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> true</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> postList</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> /**</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * Whether to enable dark/light mode switch transition animations,</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * or configure the transition animation type.</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> * </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">@</span><span style="--shiki-light:#1E754F;--shiki-dark:#4D9375;">default</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;"> '</span><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;">fade</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> */</span></span>
|
|
<span class="line"><span style="--shiki-light:#B07D48;--shiki-dark:#BD976A;"> appearance</span><span style="--shiki-light:#AB5959;--shiki-dark:#CB7676;">?</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: </span><span style="--shiki-light:#2E8F82;--shiki-dark:#5DA994;">boolean</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">fade</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">circle-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">horizontal-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">vertical-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">skew-clip</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">blinds-vertical</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">blinds-horizontal</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">soft-blur-fade</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> | </span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">diamond-reveal</span><span style="--shiki-light:#B5695977;--shiki-dark:#C98A7D77;">'</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h3 id="footer" tabindex="-1"><a class="header-anchor" href="#footer"><span>footer</span></a></h3><ul><li><strong>Type:</strong> <code>false | { message: string; copyright: string }</code></li><li><strong>Default:</strong> <code>false</code></li><li><strong>Details:</strong> Footer configuration.</li></ul><h3 id="bulletin" tabindex="-1"><a class="header-anchor" href="#bulletin"><span>bulletin</span></a></h3>`,5),a(`ul`,null,[o[280]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`boolean | BulletinOptions`)])],-1),o[281]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[279]||=a(`p`,null,[a(`strong`,null,`Details:`),r(` Bulletin board configuration.`)],-1),a(`p`,null,[o[277]||=r(`For details, please refer to `,-1),n(X,{href:`../guide/features/bulletin.md`},{default:e(()=>[...o[276]||=[r(`Bulletin Board`,-1)]]),_:1}),o[278]||=r(`.`,-1)])])]),o[309]||=i(`<h3 id="editlinkpattern" tabindex="-1"><a class="header-anchor" href="#editlinkpattern"><span>editLinkPattern</span></a></h3><ul><li><p><strong>Type:</strong> <code>string</code></p></li><li><p><strong>Default:</strong> <code>''</code></p></li><li><p><strong>Details:</strong> Regular expression for the edit link.</p><p>Example: <code>':repo/edit/:branch/:path'</code></p></li></ul><h3 id="copyright" tabindex="-1"><a class="header-anchor" href="#copyright"><span>copyright</span></a></h3>`,3),a(`ul`,null,[o[286]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Type:`),r(),a(`code`,null,`boolean | CopyrightLicense | CopyrightOptions`)])],-1),o[287]||=a(`li`,null,[a(`p`,null,[a(`strong`,null,`Default:`),r(),a(`code`,null,`false`)])],-1),a(`li`,null,[o[285]||=a(`p`,null,[a(`strong`,null,`Details:`),r(` Copyright configuration.`)],-1),a(`p`,null,[o[283]||=r(`For details, please refer to `,-1),n(X,{href:`../guide/features/copyright.md`},{default:e(()=>[...o[282]||=[r(`Copyright`,-1)]]),_:1}),o[284]||=r(`.`,-1)])])]),o[310]||=i(`<h3 id="prevpage" tabindex="-1"><a class="header-anchor" href="#prevpage"><span>prevPage</span></a></h3><ul><li><strong>Type:</strong> <code>boolean</code></li><li><strong>Default:</strong> <code>true</code></li><li><strong>Details:</strong> Whether to show the previous page link.</li></ul><h3 id="nextpage" tabindex="-1"><a class="header-anchor" href="#nextpage"><span>nextPage</span></a></h3><ul><li><strong>Type:</strong> <code>boolean</code></li><li><strong>Default:</strong> <code>true</code></li><li><strong>Details:</strong> Whether to show the next page link.</li></ul><h3 id="createtime" tabindex="-1"><a class="header-anchor" href="#createtime"><span>createTime</span></a></h3><ul><li><p><strong>Type:</strong> <code>boolean | 'only-posts'</code></p></li><li><p><strong>Default:</strong> <code>true</code></p></li><li><p><strong>Details:</strong> Whether to display the creation time.</p><ul><li><code>false</code> - Do not display.</li><li><code>'only-posts'</code> - Only display on blog post list pages.</li><li><code>true</code> - Display on all article pages.</li></ul></li></ul>`,6)])}var Ne=ne(re,[[`render`,Me]]);export{o as _pageData,Ne as default}; |