vuepress-theme-plume/assets/extensions-DLpi15Xr.js

22 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-CZvn3YaB.js";import{t as c}from"./plugin-vue_export-helper-CxTVcLa7.js";var l=JSON.parse(`{"path":"/en/guide/markdown/extensions/","title":"Extensions | Guide","lang":"en-US","frontmatter":{"title":"Extensions","icon":"fluent-mdl2:auto-enhance-on","createTime":"2025/03/03 14:04:34","permalink":"/en/guide/markdown/extensions/","tags":["Guide","markdown"],"description":"Header Anchors Headers automatically have anchors applied. Custom Anchors To specify a custom anchor for a header instead of using the auto-generated one, add a suffix to the he...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Extensions\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2026-03-08T13:55:27.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://theme-plume.vuejs.press/en/guide/markdown/extensions/"}],["meta",{"property":"og:site_name","content":"Plume Theme"}],["meta",{"property":"og:title","content":"Extensions"}],["meta",{"property":"og:description","content":"Header Anchors Headers automatically have anchors applied. Custom Anchors To specify a custom anchor for a header instead of using the auto-generated one, add a suffix to the he..."}],["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-03-08T13:55:27.000Z"}],["meta",{"property":"article:tag","content":"markdown"}],["meta",{"property":"article:tag","content":"Guide"}],["meta",{"property":"article:modified_time","content":"2026-03-08T13:55:27.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://theme-plume.vuejs.press/guide/markdown/extensions/"}]]},"readingTime":{"minutes":1.4,"words":421},"git":{"createdTime":1741490087000,"updatedTime":1772978127000,"contributors":[{"name":"zhenghaoyang24","username":"zhenghaoyang24","email":"95458562+zhenghaoyang24@users.noreply.github.com","commits":2,"avatar":"https://avatars.githubusercontent.com/zhenghaoyang24?v=4","url":"https://github.com/zhenghaoyang24"},{"name":"pengzhanbo","username":"pengzhanbo","email":"volodymyr@foxmail.com","commits":7,"avatar":"https://avatars.githubusercontent.com/pengzhanbo?v=4","url":"https://github.com/pengzhanbo"}],"changelog":[{"hash":"97a5ba20c3eb976864d8a9ec7342a061bb73c03b","time":1772978127000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: fix typo"},{"hash":"db8a46eb4cdc6c4bcb15f0e38a5aacfef565975a","time":1764559833000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: optimize and completion docs (#766)"},{"hash":"4d2361a7046214fe0f4e4af01831107fd00e38ad","time":1759849989000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme)!: add collections support (#704)"},{"hash":"497fe23001a7d0dc5c68e63ec0f2c8869a769440","time":1743208215000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: fix markdown formatting and update snippet path in usage guide"},{"hash":"9f99ae3ca72b3085c6cd383a9084f42be299c400","time":1743080813000,"email":"95458562+zhenghaoyang24@users.noreply.github.com","author":"zhenghaoyang24","message":"docs: add en <code>markdown</code> doc (#538)","coAuthors":[{"name":"pengzhanbo","email":"volodymyr@foxmail.com"}]},{"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/guide/markdown/extensions.md","headers":[],"bulletin":false}`),u={name:`extensions.md`},d={class:`table-of-contents`};function f(c,l,u,f,p,m){let h=t(`VPLink`),g=t(`router-link`);return n(),i(`div`,null,[l[13]||=o(`<h2 id="header-anchors" tabindex="-1"><a class="header-anchor" href="#header-anchors"><span>Header Anchors</span></a></h2><p>Headers automatically have anchors applied.</p><h3 id="custom-anchors" tabindex="-1"><a class="header-anchor" href="#custom-anchors"><span>Custom Anchors</span></a></h3><p>To specify a custom anchor for a header instead of using the auto-generated one, add a suffix to the header:</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-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;"> Using a Custom Anchor {#my-anchor}</span></span></code></pre></div><p>This allows linking to the header as <code>#my-anchor</code> instead of the default <code>#using-a-custom-anchor</code>.</p><h2 id="links" tabindex="-1"><a class="header-anchor" href="#links"><span>Links</span></a></h2><p>Internal and external links are specially processed.</p><p>The theme automatically generates a new link for each md file and stores it in the <code>permalink</code> of the corresponding md file&#39;s frontmatter. You can modify these links at any time. You can also disable this feature via the <code>theme.autoFrontmatter</code> option, reverting to VuePress&#39;s default behavior.</p><h3 id="internal-links" tabindex="-1"><a class="header-anchor" href="#internal-links"><span>Internal Links</span></a></h3><p>There are three ways to use internal links:</p><ul><li>Use the generated <code>permalink</code> as the target for the internal link.</li><li>Use the relative path of the md file as the target for the internal link.</li><li>Use the absolute path of the md file as the target for the internal link. The absolute path <code>/</code> indicates starting from the <code>\${sourceDir}</code> directory.</li></ul><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 style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Markdown</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">](</span><span style="--shiki-light:#393A3490;--shiki-light-text-decoration:underline;--shiki-dark:#DEDCD590;--shiki-dark-text-decoration:underline;">/guide/markdown/</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">Markdown</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">](</span><span style="--shiki-light:#393A3490;--shiki-light-text-decoration:underline;--shiki-dark:#DEDCD590;--shiki-dark-text-decoration:underline;">./basic.md</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">)</span></span></code></pre></div><p>Renders as:</p>`,14),s(`p`,null,[r(h,{href:`/guide/markdown/`},{default:e(()=>[...l[0]||=[a(`Markdown`,-1)]]),_:1})]),s(`p`,null,[r(h,{href:`./basic.md`},{default:e(()=>[...l[1]||=[a(`Markdown`,-1)]]),_:1})]),l[14]||=o(`<h3 id="external-links" tabindex="-1"><a class="header-anchor" href="#external-links"><span>External Links</span></a></h3><p>External links have <code>target=&quot;_blank&quot; rel=&quot;noreferrer&quot;</code>:</p><p><a href="https://v2.vuepress.vuejs.org/" target="_blank" rel="noopener noreferrer">VuePress</a></p><h2 id="github-style-tables" tabindex="-1"><a class="header-anchor" href="#github-style-tables"><span>GitHub-Style Tables</span></a></h2><p><strong>Input:</strong></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 style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> Tables </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> Are </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> Cool </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:#999999;--shiki-dark:#666666;"> |</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> :-----------:</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> |</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 style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> col 3 is </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> right-aligned </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> $1600 </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:#393A34;--shiki-dark:#DBD7CAEE;"> col 2 is </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> centered </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> $12 </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:#393A34;--shiki-dark:#DBD7CAEE;"> zebra stripes </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> are neat </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> $1 </span><span style="--shiki-light:#999999;--shiki-dark:#666666;">|</span></span></code></pre></div><p><strong>Output:</strong></p><table><thead><tr><th>Tables</th><th style="text-align:center;">Are</th><th style="text-align:right;">Cool</th></tr></thead><tbody><tr><td>col 3 is</td><td style="text-align:center;">right-aligned</td><td style="text-align:right;">$1600</td></tr><tr><td>col 2 is</td><td style="text-align:center;">centered</td><td style="text-align:right;">$12</td></tr><tr><td>zebra stripes</td><td style="text-align:center;">are neat</td><td style="text-align:right;">$1</td></tr></tbody></table><h2 id="table-of-contents" tabindex="-1"><a class="header-anchor" href="#table-of-contents"><span>Table of Contents</span></a></h2><p><strong>Input:</strong></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:#393A34;--shiki-dark:#DBD7CAEE;">[</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">TOC</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span></code></pre></div><p><strong>Output:</strong></p>`,12),s(`nav`,d,[s(`ul`,null,[s(`li`,null,[r(g,{to:`#header-anchors`},{default:e(()=>[...l[2]||=[a(`Header Anchors`,-1)]]),_:1}),s(`ul`,null,[s(`li`,null,[r(g,{to:`#custom-anchors`},{default:e(()=>[...l[3]||=[a(`Custom Anchors`,-1)]]),_:1})])])]),s(`li`,null,[r(g,{to:`#links`},{default:e(()=>[...l[4]||=[a(`Links`,-1)]]),_:1}),s(`ul`,null,[s(`li`,null,[r(g,{to:`#internal-links`},{default:e(()=>[...l[5]||=[a(`Internal Links`,-1)]]),_:1})]),s(`li`,null,[r(g,{to:`#external-links`},{default:e(()=>[...l[6]||=[a(`External Links`,-1)]]),_:1})])])]),s(`li`,null,[r(g,{to:`#github-style-tables`},{default:e(()=>[...l[7]||=[a(`GitHub-Style Tables`,-1)]]),_:1})]),s(`li`,null,[r(g,{to:`#table-of-contents`},{default:e(()=>[...l[8]||=[a(`Table of Contents`,-1)]]),_:1})]),s(`li`,null,[r(g,{to:`#superscripts-and-subscripts`},{default:e(()=>[...l[9]||=[a(`Superscripts and Subscripts`,-1)]]),_:1})]),s(`li`,null,[r(g,{to:`#custom-alignment`},{default:e(()=>[...l[10]||=[a(`Custom Alignment`,-1)]]),_:1})]),s(`li`,null,[r(g,{to:`#task-lists`},{default:e(()=>[...l[11]||=[a(`Task Lists`,-1)]]),_:1})]),s(`li`,null,[r(g,{to:`#footnotes`},{default:e(()=>[...l[12]||=[a(`Footnotes`,-1)]]),_:1})])])]),l[15]||=o(`<h2 id="superscripts-and-subscripts" tabindex="-1"><a class="header-anchor" href="#superscripts-and-subscripts"><span>Superscripts and Subscripts</span></a></h2><ul><li>Use <code>^ ^</code> for superscript notation.</li><li>Use <code>~ ~</code> for subscript notation.</li></ul><p><strong>Input:</strong></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:#A65E2B;--shiki-dark:#D4976C;">-</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> 19^th^</span></span>
<span class="line"><span style="--shiki-light:#A65E2B;--shiki-dark:#D4976C;">-</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> H~2~O</span></span></code></pre></div><p><strong>Output:</strong></p><ul><li>19<sup>th</sup></li><li>H<sub>2</sub>O</li></ul><h2 id="custom-alignment" tabindex="-1"><a class="header-anchor" href="#custom-alignment"><span>Custom Alignment</span></a></h2><p><strong>Input:</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:#393A34;--shiki-dark:#DBD7CAEE;">::: left</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">Left-aligned content</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">:::</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">::: center</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">Centered content</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">:::</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">::: right</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">Right-aligned content</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">:::</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><strong>Output:</strong></p><div style="text-align:left;"><p>Left-aligned content</p></div><div style="text-align:center;"><p>Centered content</p></div><div style="text-align:right;"><p>Right-aligned content</p></div><h2 id="task-lists" tabindex="-1"><a class="header-anchor" href="#task-lists"><span>Task Lists</span></a></h2><p><strong>Input:</strong></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:#A65E2B;--shiki-dark:#D4976C;">-</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> [ ] Task 1</span></span>
<span class="line"><span style="--shiki-light:#A65E2B;--shiki-dark:#D4976C;">-</span><span style="--shiki-light:#999999;--shiki-dark:#666666;"> [</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">x</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> Task 2</span></span>
<span class="line"><span style="--shiki-light:#A65E2B;--shiki-dark:#D4976C;">-</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;"> [ ] Task 3</span></span></code></pre></div><p><strong>Output:</strong></p><ul class="task-list-container"><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" id="task-item-0" disabled="disabled"><label class="task-list-item-label" for="task-item-0"> Task 1</label></li><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" id="task-item-1" checked="checked" disabled="disabled"><label class="task-list-item-label" for="task-item-1"> Task 2</label></li><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" id="task-item-2" disabled="disabled"><label class="task-list-item-label" for="task-item-2"> Task 3</label></li></ul><h2 id="footnotes" tabindex="-1"><a class="header-anchor" href="#footnotes"><span>Footnotes</span></a></h2><p><strong>Input:</strong></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:#393A34;--shiki-dark:#DBD7CAEE;">The farthest distance in the world Is not the distance between life and death But you don&#39;t know I love you when I stand in front of you.</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">^footnote1</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">.</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#999999;--shiki-dark:#666666;">[</span><span style="--shiki-light:#B56959;--shiki-dark:#C98A7D;">^footnote1</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">: From India.Rabindranath Tagore </span><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">**</span><span style="--shiki-light:#393A34;--shiki-light-font-weight:bold;--shiki-dark:#DBD7CAEE;--shiki-dark-font-weight:bold;">The Farthest Distance in the World</span><span style="--shiki-light:#999999;--shiki-light-font-weight:bold;--shiki-dark:#666666;--shiki-dark-font-weight:bold;">**</span></span></code></pre></div><p><strong>Output:</strong></p><p>The farthest distance in the world Is not the distance between life and death But you don&#39;t know I love you when I stand in front of you.<sup class="footnote-ref"><a href="#footnote1">[1]</a><a class="footnote-anchor" id="footnote-ref1"></a></sup>.</p><hr class="footnotes-sep"><section class="footnotes"><ol class="footnotes-list"><li id="footnote1" class="footnote-item"><p>From India.Rabindranath Tagore <strong>The Farthest Distance in the World</strong> <a href="#footnote-ref1" class="footnote-backref">↩︎</a></p></li></ol></section>`,25)])}var p=c(u,[[`render`,f]]);export{l as _pageData,p as default};