vuepress-theme-plume/assets/markdown-include-CnAQeMSJ.js

13 lines
7.5 KiB
JavaScript

import{B as e,P as t,_ as n,f as r,g as i,h as a,l as o}from"./runtime-core.esm-bundler-CZvn3YaB.js";import{t as s}from"./plugin-vue_export-helper-CxTVcLa7.js";var c=JSON.parse(`{"path":"/en/config/plugins/markdown-include/","title":"Markdown Include | Config","lang":"en-US","frontmatter":{"title":"Markdown Include","createTime":"2025/10/09 12:01:58","permalink":"/en/config/plugins/markdown-include/","description":"Overview Import content from other markdown files within Markdown files. Related plugin: @vuepress/plugin-markdown-include Configuration The theme enables markdownInclude by def...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Markdown Include\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2025-10-09T07:46:05.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://theme-plume.vuejs.press/en/config/plugins/markdown-include/"}],["meta",{"property":"og:site_name","content":"Plume Theme"}],["meta",{"property":"og:title","content":"Markdown Include"}],["meta",{"property":"og:description","content":"Overview Import content from other markdown files within Markdown files. Related plugin: @vuepress/plugin-markdown-include Configuration The theme enables markdownInclude by def..."}],["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-10-09T07:46:05.000Z"}],["meta",{"property":"article:modified_time","content":"2025-10-09T07:46:05.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://theme-plume.vuejs.press/config/plugins/markdown-include/"}]]},"readingTime":{"minutes":0.49,"words":148},"git":{"createdTime":1759995965000,"updatedTime":1759995965000,"contributors":[{"name":"pengzhanbo","username":"pengzhanbo","email":"volodymyr@foxmail.com","commits":1,"avatar":"https://avatars.githubusercontent.com/pengzhanbo?v=4","url":"https://github.com/pengzhanbo"}],"changelog":[{"hash":"385059f214cb07fc9a098859e889432fb81f998b","time":1759995965000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: update en docs (#708)"}]},"autoDesc":true,"filePathRelative":"en/config/plugins/markdown-include.md","headers":[],"bulletin":false}`),l={name:`markdown-include.md`},u={class:`code-block-title`,"data-title":`.vuepress/config.ts`},d={class:`code-block-title-bar`},f={class:`title`};function p(s,c,l,p,m,h){let g=e(`VPIcon`);return t(),r(`div`,null,[c[2]||=a(`<h2 id="overview" tabindex="-1"><a class="header-anchor" href="#overview"><span>Overview</span></a></h2><p>Import content from other markdown files within Markdown files.</p><p>Related plugin: <a href="https://ecosystem.vuejs.press/plugins/markdown/markdown-include.html" target="_blank" rel="noopener noreferrer">@vuepress/plugin-markdown-include</a></p><h2 id="configuration" tabindex="-1"><a class="header-anchor" href="#configuration"><span>Configuration</span></a></h2><p>The theme enables <code>markdownInclude</code> by default. You can further customize its behavior through configuration.</p>`,5),o(`div`,u,[o(`div`,d,[o(`span`,f,[n(g,{provider:`iconify`,name:`vscode-icons:file-type-typescript`}),c[0]||=i(`.vuepress/config.ts`,-1)])]),c[1]||=a(`<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;"> markdown</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> include</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;"> // ... options</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;"> // Can also be configured in \`plugins.markdownInclude\`, but not recommended</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> plugins</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;"> markdownInclude</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>`,1)]),c[3]||=a(`<h3 id="resolvepath" tabindex="-1"><a class="header-anchor" href="#resolvepath"><span>resolvePath</span></a></h3><ul><li>Type: <code>(path: string, cwd: string | null) =&gt; string</code></li><li>Default: <code>(path) =&gt; path</code></li><li>Details: Processes the include file path.</li></ul><h3 id="deep" tabindex="-1"><a class="header-anchor" href="#deep"><span>deep</span></a></h3><ul><li>Type: <code>boolean</code></li><li>Details: Whether to enable deep include support.</li></ul><h3 id="usecomment" tabindex="-1"><a class="header-anchor" href="#usecomment"><span>useComment</span></a></h3><ul><li>Type: <code>boolean</code></li><li>Default: <code>true</code></li><li>Details: Whether to use <code>&lt;!-- @include: xxx --&gt;</code> instead of <code>@include: xxx</code> for file inclusion.</li></ul><h3 id="resolveimagepath" tabindex="-1"><a class="header-anchor" href="#resolveimagepath"><span>resolveImagePath</span></a></h3><ul><li>Type: <code>boolean</code></li><li>Default: <code>true</code></li><li>Details: Whether to resolve relative image paths within the included Markdown files.</li></ul><h3 id="resolvelinkpath" tabindex="-1"><a class="header-anchor" href="#resolvelinkpath"><span>resolveLinkPath</span></a></h3><ul><li>Type: <code>boolean</code></li><li>Default: <code>true</code></li><li>Details: Whether to resolve relative file paths within the included Markdown files.</li></ul>`,10)])}var m=s(l,[[`render`,p]]);export{c as _pageData,m as default};