mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-23 10:58:13 +08:00
15 lines
20 KiB
JavaScript
15 lines
20 KiB
JavaScript
import{$ as e,B as t,P as n,_ as r,f as i,g as a,h as o,l as s}from"./runtime-core.esm-bundler-TY2dTQsQ.js";import{t as c}from"./plugin-vue_export-helper-PrwMxFSs.js";var l=JSON.parse(`{"path":"/en/config/frontmatter/basic/","title":"General Configuration | Config","lang":"en-US","frontmatter":{"title":"General Configuration","createTime":"2025/10/09 20:01:09","permalink":"/en/config/frontmatter/basic/","description":"Overview General Frontmatter configuration applicable to all articles. Example: Configuration pageLayout Type: false | 'home' | 'doc' | 'custom' | 'page' | 'friends' | string De...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"General Configuration\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-11-25T17:13:24.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://theme-plume.vuejs.press/en/config/frontmatter/basic/"}],["meta",{"property":"og:site_name","content":"Plume Theme"}],["meta",{"property":"og:title","content":"General Configuration"}],["meta",{"property":"og:description","content":"Overview General Frontmatter configuration applicable to all articles. Example: Configuration pageLayout Type: false | 'home' | 'doc' | 'custom' | 'page' | 'friends' | string De..."}],["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":"2025-11-25T17:13:24.000Z"}],["meta",{"property":"article:modified_time","content":"2025-11-25T17:13:24.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://theme-plume.vuejs.press/config/frontmatter/basic/"}]]},"readingTime":{"minutes":3.1,"words":930},"git":{"createdTime":1741490087000,"updatedTime":1764090804000,"contributors":[{"name":"zhenghaoyang24","username":"zhenghaoyang24","email":"95458562+zhenghaoyang24@users.noreply.github.com","commits":1,"avatar":"https://avatars.githubusercontent.com/zhenghaoyang24?v=4","url":"https://github.com/zhenghaoyang24"},{"name":"pengzhanbo","username":"pengzhanbo","email":"volodymyr@foxmail.com","commits":6,"avatar":"https://avatars.githubusercontent.com/pengzhanbo?v=4","url":"https://github.com/pengzhanbo"}],"changelog":[{"hash":"fc3676d6dcb89ab4f175c8e54d3b61697e0f9233","time":1764090804000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme): add support for <code>{data-outline=\\"level\\"}</code> attribute syntax for headings, close #757 (#759)"},{"hash":"ddb77a06a5bea91593d797ee307fcf2f115dd60b","time":1763644166000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme): add <code>footer</code> frontmatter"},{"hash":"385059f214cb07fc9a098859e889432fb81f998b","time":1759995965000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: update en docs (#708)"},{"hash":"4d2361a7046214fe0f4e4af01831107fd00e38ad","time":1759849989000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme)!: add collections support (#704)"},{"hash":"0fd6cac57412002f4d72dc10378789b529adc357","time":1742063370000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"refactor(theme): improve types and flat config (#524)"},{"hash":"a4ac3a30e0b74175b3cd4fd82c52b2321b013926","time":1741490087000,"email":"95458562+zhenghaoyang24@users.noreply.github.com","author":"zhenghaoyang24","message":"docs: add en-US docs (#514)","coAuthors":[{"name":"pengzhanbo","email":"volodymyr@foxmail.com"}]}]},"autoDesc":true,"filePathRelative":"en/config/frontmatter/basic.md","headers":[],"bulletin":false}`),u={name:`basic.md`};function d(c,l,u,d,f,p){let m=t(`VPLink`);return n(),i(`div`,null,[l[15]||=o(`<h2 id="overview" tabindex="-1"><a class="header-anchor" href="#overview"><span>Overview</span></a></h2><p>General Frontmatter configuration applicable to all articles.</p><p>Example:</p><div class="language-md" data-highlighter="shiki" data-ext="md" 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-md"><span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">---</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">title</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;"> Title</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">createTime</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;"> 2024/03/02 20:01:09</span></span>
|
|
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">permalink</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">:</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;"> /config/frontmatter/basic/</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">---</span></span></code></pre></div><h2 id="configuration" tabindex="-1"><a class="header-anchor" href="#configuration"><span>Configuration</span></a></h2><h3 id="pagelayout" tabindex="-1"><a class="header-anchor" href="#pagelayout"><span>pageLayout</span></a></h3><ul><li><p>Type: <code>false | 'home' | 'doc' | 'custom' | 'page' | 'friends' | string</code></p></li><li><p>Default: <code>doc</code></p></li><li><p>Details:</p><p>Page layout mode.</p><ul><li><code>'home'</code>: Homepage layout</li><li><code>'doc'</code>: Documentation page layout, including left sidebar, article content, right sidebar, navbar, comments, etc.</li><li><code>'page'</code>: Includes only the navbar and MD file content. Use this layout for custom page content.</li><li><code>'friends'</code>: Friends link page layout</li><li><code>'custom'</code>: Includes only MD file content. Use this layout for fully custom page content.</li><li><code>false</code>: Equivalent to <code>custom</code></li><li><code>string</code>: A global component name can be passed, which will be applied as the layout component.</li></ul></li></ul><h3 id="pageclass" tabindex="-1"><a class="header-anchor" href="#pageclass"><span>pageClass</span></a></h3><ul><li><p>Type: <code>string</code></p></li><li><p>Default: <code>''</code></p></li><li><p>Details:</p><p>Additional custom CSS class name for the page.</p></li></ul><h3 id="title" tabindex="-1"><a class="header-anchor" href="#title"><span>title</span></a></h3><ul><li><p>Type: <code>string</code></p></li><li><p>Default: <code>''</code></p></li><li><p>Details:</p><p>Article title.</p><p>The theme automatically populates the current filename as the article title upon file creation.</p></li></ul><h3 id="badge" tabindex="-1"><a class="header-anchor" href="#badge"><span>badge</span></a></h3><ul><li>Type: <code>string | { text: string, type?: 'info' | 'tip' | 'warning' | 'danger' }</code></li></ul><p>Display a badge on the right side of the article title.</p><h3 id="createtime" tabindex="-1"><a class="header-anchor" href="#createtime"><span>createTime</span></a></h3><ul><li><p>Type: <code>string</code></p></li><li><p>Default: <code>''</code></p></li><li><p>Details:</p><p>Article creation time.</p><p>The theme automatically populates the current time as the article creation time upon file creation.</p></li></ul><h3 id="permalink" tabindex="-1"><a class="header-anchor" href="#permalink"><span>permalink</span></a></h3><ul><li><p>Type: <code>string</code></p></li><li><p>Default: <code>''</code></p></li><li><p>Details:</p><p>Article permanent link.</p><p>Upon file creation, the theme automatically populates:</p><ul><li>For blog-type articles: <code>/article/</code> + <code>8-character random string generated by nanoid</code> as the permanent link.</li><li>For articles under the notes directory: The permanent link is automatically populated based on the notes configuration.</li></ul></li></ul><h3 id="externallinkicon" tabindex="-1"><a class="header-anchor" href="#externallinkicon"><span>externalLinkIcon</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the external link icon for external links within the current article.</p></li></ul><h3 id="backtotop" tabindex="-1"><a class="header-anchor" href="#backtotop"><span>backToTop</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the back-to-top button for the current article.</p></li></ul><h3 id="comments" tabindex="-1"><a class="header-anchor" href="#comments"><span>comments</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether the current article is commentable. Only takes effect when the comment feature is enabled.</p></li></ul><h3 id="aside" tabindex="-1"><a class="header-anchor" href="#aside"><span>aside</span></a></h3><ul><li><p>Type: <code>boolean | 'left'</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the right sidebar for the current article.</p><p>When set to <code>'left'</code>, the right sidebar will be displayed on the left side.</p></li></ul><h3 id="navbar" tabindex="-1"><a class="header-anchor" href="#navbar"><span>navbar</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the navigation bar for the current article.</p></li></ul><h3 id="outline" tabindex="-1"><a class="header-anchor" href="#outline"><span>outline</span></a></h3><ul><li><p>Type: <code>false | number | [number, number] | 'deep'</code></p></li><li><p>Default: <code>[2, 3]</code></p></li><li><p>Details:</p><p>The heading levels to display.</p><p>A single number indicates displaying only headings of that level.</p><p>If a tuple is passed, the first number is the minimum level and the second number 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></li></ul><div class="hint-container tip"><p class="hint-container-title">Tips</p><p>In markdown content, using the attribute syntax <code>{data-outline="level"}</code> / <code>{outline="level"}</code> after a heading allows you to reset the maximum display level for descendant headings under the current heading.</p><p><strong>For example</strong>:</p><div class="language-md line-numbers-mode" data-highlighter="shiki" data-ext="md" 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-md"><span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">##</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Heading 1 </span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;" class="highlighted-word">{data-outline="5"}</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> </span><span style="--shiki-light:#A0ADA0;--shiki-light-font-weight:bold;--shiki-dark:#758575DD;--shiki-dark-font-weight:bold;"><!-- Only affects descendant headings of the current heading --></span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">###</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Level 3 Heading</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">####</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Level 4 Heading</span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">#####</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Level 5 Heading </span><span style="--shiki-light:#A0ADA0;--shiki-light-font-weight:bold;--shiki-dark:#758575DD;--shiki-dark-font-weight:bold;"><!-- Level 3, 4, and 5 headings will appear in the sidebar --></span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">######</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Level 6 Heading </span><span style="--shiki-light:#A0ADA0;--shiki-light-font-weight:bold;--shiki-dark:#758575DD;--shiki-dark-font-weight:bold;"><!-- This heading will NOT appear in the sidebar --></span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">##</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Heading 2 </span><span style="--shiki-light:#A0ADA0;--shiki-light-font-weight:bold;--shiki-dark:#758575DD;--shiki-dark-font-weight:bold;"><!-- Headings at the same level are not affected --></span></span>
|
|
<span class="line"></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">###</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Level 3 Heading </span><span style="--shiki-light:#A0ADA0;--shiki-light-font-weight:bold;--shiki-dark:#758575DD;--shiki-dark-font-weight:bold;"><!-- By default, only up to level 3 headings are shown --></span></span>
|
|
<span class="line"><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">####</span><span style="--shiki-light:#1C6B48;--shiki-light-font-weight:bold;--shiki-dark:#4D9375;--shiki-dark-font-weight:bold;"> Level 4 Heading </span><span style="--shiki-light:#A0ADA0;--shiki-light-font-weight:bold;--shiki-dark:#758575DD;--shiki-dark-font-weight:bold;"><!-- Level 4 headings are not shown --></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><p>Note that the value of <code>level</code> should be greater than the level of the current heading; otherwise, it will not take effect.</p></div><h3 id="prev" tabindex="-1"><a class="header-anchor" href="#prev"><span>prev</span></a></h3><ul><li><p>Type: <code>string | { text: string, link: string, icon?: string }</code></p></li><li><p>Default: <code>''</code></p></li><li><p>Details:</p><p>Customize the previous article for the current article.</p><ul><li>For blog-type articles: The theme automatically populates the title and link of the previous article based on chronological order.</li><li>For notes-type articles: The theme automatically populates the title and link of the previous article based on the note sidebar configuration.</li></ul></li></ul><h3 id="next" tabindex="-1"><a class="header-anchor" href="#next"><span>next</span></a></h3><ul><li><p>Type: <code>string | { text: string, link: string, icon?: string }</code></p></li><li><p>Default: <code>''</code></p></li><li><p>Details:</p><p>Customize the next article for the current article.</p><ul><li>For blog-type articles: The theme automatically populates the title and link of the next article based on chronological order.</li><li>For notes-type articles: The theme automatically populates the title and link of the next article based on the note sidebar configuration.</li></ul></li></ul><h3 id="readingtime" tabindex="-1"><a class="header-anchor" href="#readingtime"><span>readingTime</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the reading time for the current article.</p></li></ul><h3 id="lastupdated" tabindex="-1"><a class="header-anchor" href="#lastupdated"><span>lastUpdated</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the last updated time for the current article. The last updated time is automatically populated based on the git commit time.</p></li></ul><h3 id="contributors" tabindex="-1"><a class="header-anchor" href="#contributors"><span>contributors</span></a></h3>`,40),s(`ul`,null,[l[6]||=s(`li`,null,[s(`p`,null,[a(`Type: `),s(`code`,null,`boolean | string | string[]`)])],-1),l[7]||=s(`li`,null,[s(`p`,null,[a(`Default: `),s(`code`,null,`true`)])],-1),s(`li`,null,[l[3]||=s(`p`,null,`Details:`,-1),l[4]||=s(`p`,null,`Whether to display contributors for the current article. Contributors are automatically populated based on git committers.`,-1),l[5]||=s(`p`,null,`If your article originates from a third party and git commits cannot fully list all authors, you can supplement contributors here.`,-1),s(`p`,null,[l[1]||=a(`For additional information, please refer to `,-1),r(m,{href:`../../guide/features/contributors.md#info`},{default:e(()=>[...l[0]||=[a(`contributors`,-1)]]),_:1}),l[2]||=a(`.`,-1)])])]),l[16]||=o(`<h3 id="changelog" tabindex="-1"><a class="header-anchor" href="#changelog"><span>changelog</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>false</code></p></li><li><p>Details:</p><p>Whether to display the page change history for the current page.</p></li></ul><h3 id="copyright" tabindex="-1"><a class="header-anchor" href="#copyright"><span>copyright</span></a></h3>`,3),s(`ul`,null,[l[13]||=s(`li`,null,[s(`p`,null,[a(`Type: `),s(`code`,null,`boolean | CopyrightLicense | CopyrightFrontmatter`)])],-1),l[14]||=s(`li`,null,[s(`p`,null,[a(`Default: `),s(`code`,null,`false`)])],-1),s(`li`,null,[l[11]||=s(`p`,null,`Details:`,-1),l[12]||=s(`p`,null,`Whether to display copyright information for the current article.`,-1),s(`p`,null,[l[9]||=a(`For complete information, please refer to `,-1),r(m,{href:`../../guide/features/copyright.md`},{default:e(()=>[...l[8]||=[a(`copyright`,-1)]]),_:1}),l[10]||=a(`.`,-1)])])]),l[17]||=o(`<h3 id="editlink" tabindex="-1"><a class="header-anchor" href="#editlink"><span>editLink</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the article edit button for the current article.</p></li></ul><h3 id="watermark" tabindex="-1"><a class="header-anchor" href="#watermark"><span>watermark</span></a></h3><ul><li><p>Type: <code>boolean | WatermarkOptions</code></p></li><li><p>Default: <code>undefined</code> (When the theme does not enable watermarks, or when global watermarks are not enabled, the default value is <code>false</code>. If global watermarks are enabled, the default is <code>true</code>.)</p></li><li><p>Details: Configure the watermark for the current article.</p><p>When the type is boolean, it indicates whether to enable the watermark.</p><p>When the type is WatermarkOptions, it represents the watermark configuration for the current page.</p><p>You can refer to <a href="https://zhensherlock.github.io/watermark-js-plus/zh/config/" target="_blank" rel="noopener noreferrer">watermark-js-plus</a>.</p></li></ul><h3 id="footer" tabindex="-1"><a class="header-anchor" href="#footer"><span>footer</span></a></h3><ul><li><p>Type: <code>boolean</code></p></li><li><p>Default: <code>true</code></p></li><li><p>Details:</p><p>Whether to display the footer for the current article.</p></li></ul>`,6)])}var f=c(u,[[`render`,d]]);export{l as _pageData,f as default}; |