vuepress-theme-plume/assets/obsidian-jfCCYoo5.js

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";import"./custom-hero-BAaAOTF5.js";var l=JSON.parse(`{"path":"/en/guide/markdown/obsidian/","title":"Obsidian Compatibility | Guide","lang":"en-US","frontmatter":{"title":"Obsidian Compatibility","icon":"simple-icons:obsidian","createTime":"2026/04/17 21:56:55","permalink":"/en/guide/markdown/obsidian/","description":"Overview The theme provides compatibility support for Obsidian's official Markdown extension syntax through the vuepress-plugin-md-power plugin, enabling Obsidian users to write...","head":[["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Obsidian Compatibility\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2026-04-18T09:01:41.000Z\\",\\"author\\":[]}"],["meta",{"property":"og:url","content":"https://theme-plume.vuejs.press/en/guide/markdown/obsidian/"}],["meta",{"property":"og:site_name","content":"Plume Theme"}],["meta",{"property":"og:title","content":"Obsidian Compatibility"}],["meta",{"property":"og:description","content":"Overview The theme provides compatibility support for Obsidian's official Markdown extension syntax through the vuepress-plugin-md-power plugin, enabling Obsidian users to write..."}],["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-04-18T09:01:41.000Z"}],["meta",{"property":"article:modified_time","content":"2026-04-18T09:01:41.000Z"}],["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://theme-plume.vuejs.press/guide/markdown/obsidian/"}]]},"readingTime":{"minutes":2.77,"words":832},"git":{"createdTime":1776502901000,"updatedTime":1776502901000,"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":"bfd0c8409c4c55c82f6c55d681f6b3eaafeaddfb","time":1776502901000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(plugin-md-power): compat obsidian official markdown syntax (#890)"}]},"autoDesc":true,"filePathRelative":"en/guide/markdown/obsidian.md","headers":[],"bulletin":false}`),u={name:`obsidian.md`},d={class:`code-block-title`,"data-title":`.vuepress/config.ts`},f={class:`code-block-title-bar`},p={class:`title`},m={class:`vp-field-group`};function h(c,l,u,h,g,_){let v=t(`VPLink`),y=t(`ArtPlayer`),b=t(`VPIcon`),x=t(`VPField`);return n(),i(`div`,null,[l[6]||=o(`<h2 id="overview" tabindex="-1"><a class="header-anchor" href="#overview"><span>Overview</span></a></h2><p>The theme provides compatibility support for Obsidian&#39;s official Markdown extension syntax through the <code>vuepress-plugin-md-power</code> plugin, enabling Obsidian users to write documentation using familiar syntax.</p><p>Currently supported Obsidian extension syntax includes:</p><ul><li><a href="#wiki-links">Wiki Links</a> - Syntax for inter-page linking</li><li><a href="#embeds">Embeds</a> - Embed content from other files into the current page</li><li><a href="#comments">Comments</a> - Add comments visible only during editing</li></ul><div class="hint-container warning"><p class="hint-container-title">No plans to support extension syntax provided by Obsidian&#39;s third-party community plugins</p></div><h2 id="wiki-links" tabindex="-1"><a class="header-anchor" href="#wiki-links"><span>Wiki Links</span></a></h2><p>Wiki Links are syntax for linking to other notes in Obsidian.</p><h3 id="syntax" tabindex="-1"><a class="header-anchor" href="#syntax"><span>Syntax</span></a></h3><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;">filename</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">filename#heading</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">filename#heading#subheading</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">filename|alias</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">filename#heading|alias</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span></code></pre></div><h3 id="filename-search-rules" tabindex="-1"><a class="header-anchor" href="#filename-search-rules"><span>Filename Search Rules</span></a></h3><p>When using Wiki Links, filenames are matched according to the following rules:</p><p><strong>Match Priority:</strong></p><ol><li><strong>Page Title</strong> - Priority matching against page titles</li><li><strong>Full Path</strong> - Exact match against file paths</li><li><strong>Fuzzy Match</strong> - Match filenames at the end of paths</li></ol><p><strong>Path Resolution Rules:</strong></p><ul><li><strong>Relative paths</strong> (starting with <code>.</code>): Resolved relative to the current file&#39;s directory</li><li><strong>Absolute paths</strong> (not starting with <code>.</code>): Searched throughout the document tree, with shortest path taking precedence</li><li><strong>Directory form</strong> (ending with <code>/</code>): Matches <code>README.md</code> or <code>index.html</code> within that directory</li></ul><p><strong>Example:</strong></p><p>Assuming the following document structure:</p><div class="language-txt" data-highlighter="shiki" data-ext="txt" 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-txt"><span class="line"><span>docs/</span></span>
<span class="line"><span>├── README.md          (title: &quot;Home&quot;)</span></span>
<span class="line"><span>├── guide/</span></span>
<span class="line"><span>│   ├── README.md     (title: &quot;Guide&quot;)</span></span>
<span class="line"><span>│   └── markdown/</span></span>
<span class="line"><span>│       └── obsidian.md</span></span></code></pre></div><p>In <code>docs/guide/markdown/obsidian.md</code>:</p><table><thead><tr><th>Syntax</th><th>Match Result</th></tr></thead><tbody><tr><td><code>[[Home]]</code></td><td>Matches <code>docs/README.md</code> (via title)</td></tr><tr><td><code>[[Guide]]</code></td><td>Matches <code>docs/guide/README.md</code> (via title)</td></tr><tr><td><code>[[./]]</code></td><td>Matches <code>docs/guide/markdown/README.md</code> (relative path)</td></tr><tr><td><code>[[../]]</code></td><td>Matches <code>docs/guide/README.md</code> (parent directory)</td></tr><tr><td><code>[[guide/]]</code></td><td>Matches <code>docs/guide/README.md</code> (directory form)</td></tr></tbody></table><h3 id="examples" tabindex="-1"><a class="header-anchor" href="#examples"><span>Examples</span></a></h3><p><strong>External Links:</strong></p><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;">[[https://example.com|External Link]]</span></span></code></pre></div><p><strong>Output:</strong></p><p><a href="https://example.com" target="_blank" rel="noopener noreferrer">External Link</a></p><hr><p><strong>Internal Anchor Links:</strong></p><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;">[[QR Code]]  </span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">&lt;!-- Search by title --&gt;</span></span>
<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;">npm-to</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]  </span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">&lt;!-- Search by filename --&gt;</span></span>
<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;">guide/markdown/math</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]  </span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">&lt;!-- Search by file path --&gt;</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">[[#Wiki Links]]  </span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">&lt;!-- Heading on current page --&gt;</span></span>
<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;">file-tree#configuration</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]  </span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">&lt;!-- Search by filename, link to heading --&gt;</span></span></code></pre></div><p><strong>Output:</strong></p><p><a href="/QR Code" target="_blank" rel="noopener noreferrer">QR Code</a></p><p><a href="/npm-to" target="_blank" rel="noopener noreferrer">npm-to</a></p><p><a href="/guide/markdown/math" target="_blank" rel="noopener noreferrer">guide/markdown/math</a></p>`,34),s(`p`,null,[r(v,{href:`#wiki-links`},{"after-text":e(()=>[...l[0]||=[a(` > Wiki Links`,-1)]]),_:1})]),l[7]||=o(`<p><a href="/file-tree#configuration" target="_blank" rel="noopener noreferrer">file-tree &gt; configuration</a></p><p><a href="https://obsidian.md/en/help/links" class="readmore" target="_blank" rel="noopener noreferrer">Obsidian Official - <strong>Wiki Links</strong></a></p><h2 id="embeds" tabindex="-1"><a class="header-anchor" href="#embeds"><span>Embeds</span></a></h2><p>The embed syntax allows you to insert other file resources into the current page.</p><h3 id="syntax-1" tabindex="-1"><a class="header-anchor" href="#syntax-1"><span>Syntax</span></a></h3><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;">filename</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">filename#heading</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">filename#heading#subheading</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span></code></pre></div><p>Filename search rules are the same as <a href="#filename-search-rules">Wiki Links</a>.</p><div class="hint-container info"><p class="hint-container-title">Resources starting with <code>/</code> or having no path prefix like <code>./</code> are loaded from the <code>public</code> directory</p></div><h3 id="image-embeds" tabindex="-1"><a class="header-anchor" href="#image-embeds"><span>Image Embeds</span></a></h3><p><strong>Syntax:</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;">image.png</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">image.png|300</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">image.png|300x200</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span></code></pre></div><p>Supported formats: <code>jpg</code>, <code>jpeg</code>, <code>png</code>, <code>gif</code>, <code>avif</code>, <code>webp</code>, <code>svg</code>, <code>bmp</code>, <code>ico</code>, <code>tiff</code>, <code>apng</code>, <code>jfif</code>, <code>pjpeg</code>, <code>pjp</code>, <code>xbm</code></p><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;">images/custom-hero.jpg</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><img src="/images/custom-hero.jpg" alt="images/custom-hero.jpg" width="1000" height="525"><h3 id="pdf-embeds" tabindex="-1"><a class="header-anchor" href="#pdf-embeds"><span>PDF Embeds</span></a></h3><div class="hint-container note"><p class="hint-container-title">Note</p><p>PDF embeds require the <code>markdown.pdf</code> plugin to be enabled for proper functionality.</p></div><p><strong>Syntax:</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;">document.pdf</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">document.pdf#page=1</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">] </span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">&lt;!-- #page=1 means first page --&gt;</span></span>
<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;">document.pdf#page=1#height=300</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">] </span><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">&lt;!-- #height=300 means height of 300px --&gt;</span></span></code></pre></div><hr><h3 id="audio-embeds" tabindex="-1"><a class="header-anchor" href="#audio-embeds"><span>Audio Embeds</span></a></h3><div class="hint-container note"><p class="hint-container-title">Note</p><p>Audio embeds require the file path to be correct and the file to exist in the document directory.</p></div><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;">audio.mp3</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><audio controls="true" preload="metadata" aria-label="https://publish-01.obsidian.md/access/cf01a21839823cd6cbe18031acf708c0/Attachments/audio/Excerpt%20from%20Mother%20of%20All%20Demos%20(1968).ogg"><source src="https://publish-01.obsidian.md/access/cf01a21839823cd6cbe18031acf708c0/Attachments/audio/Excerpt%20from%20Mother%20of%20All%20Demos%20(1968).ogg"></audio><p>Supported formats: <code>mp3</code>, <code>flac</code>, <code>wav</code>, <code>ogg</code>, <code>opus</code>, <code>webm</code>, <code>acc</code></p><hr><h3 id="video-embeds" tabindex="-1"><a class="header-anchor" href="#video-embeds"><span>Video Embeds</span></a></h3><div class="hint-container note"><p class="hint-container-title">Note</p><p>Video embeds require the <code>markdown.artPlayer</code> plugin to be enabled for proper functionality.</p></div><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;">video.mp4</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>`,34),r(y,{src:`https://artplayer.org/assets/sample/video.mp4`,type:`mp4`,width:`100%`,fullscreen:!0,flip:!0,"playback-rate":!0,"aspect-ratio":!0,setting:!0,pip:!0,volume:.75}),l[8]||=o(`<p>Supported formats: <code>mp4</code>, <code>webm</code>, <code>mov</code>, etc.</p><hr><h3 id="content-fragment-embeds" tabindex="-1"><a class="header-anchor" href="#content-fragment-embeds"><span>Content Fragment Embeds</span></a></h3><p>Content fragments under a specified heading can be embedded using <code>#heading</code>:</p><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;">my-note</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">my-note#heading-one</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span>
<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;">my-note#heading-one#subheading</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">]</span><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">]</span></span></code></pre></div><p><a href="https://obsidian.md/en/help/embeds" class="readmore" target="_blank" rel="noopener noreferrer">Obsidian Official - Embeds</a><a href="https://obsidian.md/en/help/file-formats" class="readmore" target="_blank" rel="noopener noreferrer">Obsidian Official - File Formats</a></p><h2 id="comments" tabindex="-1"><a class="header-anchor" href="#comments"><span>Comments</span></a></h2><p>Content wrapped in <code>%%</code> is treated as a comment and will not be rendered on the page.</p><h3 id="syntax-2" tabindex="-1"><a class="header-anchor" href="#syntax-2"><span>Syntax</span></a></h3><p><strong>Inline Comments:</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;">This is an %%inline comment%% example.</span></span></code></pre></div><p><strong>Block Comments:</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>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">This is a block comment.</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">It can span multiple lines.</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">%%</span></span></code></pre></div><h3 id="examples-1" tabindex="-1"><a class="header-anchor" href="#examples-1"><span>Examples</span></a></h3><p><strong>Inline Comments:</strong></p><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;">This is an %%inline comment%% example.</span></span></code></pre></div><p><strong>Output:</strong></p><p>This is an example.</p><hr><p><strong>Block Comments:</strong></p><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;">Content before the comment</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">%%</span></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">This is a block comment.</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#393A34;--shiki-dark:#DBD7CAEE;">It can span multiple lines.</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;">Content after the comment</span></span></code></pre></div><p><strong>Output:</strong></p><p>Content before the comment</p><p>Content after the comment</p><blockquote><p>Related Documentation: <a href="https://obsidian.md/en/help/syntax#%E6%B3%A8%E9%87%8B" target="_blank" rel="noopener noreferrer">Obsidian Official - Comments</a></p></blockquote><h2 id="configuration" tabindex="-1"><a class="header-anchor" href="#configuration"><span>Configuration</span></a></h2><p>You can enable or disable these plugins in the theme configuration:</p>`,30),s(`div`,d,[s(`div`,f,[s(`span`,p,[r(b,{provider:`iconify`,name:`vscode-icons:file-type-typescript`}),l[1]||=a(`.vuepress/config.ts`,-1)])]),l[2]||=o(`<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;">    plugins</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">      mdPower</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
<span class="line"><span style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">        // Obsidian compatibility plugin configuration</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">        obsidian</span><span style="--shiki-light:#999999;--shiki-dark:#666666;">: {</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">          wikiLink</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 style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">// Wiki Links</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">          embedLink</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 style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">// Embeds</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">          comment</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 style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">// Comments</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;">        pdf</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 style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">// PDF embed functionality</span></span>
<span class="line"><span style="--shiki-light:#998418;--shiki-dark:#B8A965;">        artPlayer</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 style="--shiki-light:#A0ADA0;--shiki-dark:#758575DD;">// Video embed functionality</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></div>`,1)]),l[9]||=s(`h3`,{id:`configuration-options`,tabindex:`-1`},[s(`a`,{class:`header-anchor`,href:`#configuration-options`},[s(`span`,null,`Configuration Options`)])],-1),s(`div`,m,[r(x,{name:`wikiLink`,optional:``,type:`boolean`,"default-value":`true`},{default:e(()=>[...l[3]||=[s(`p`,null,`Enable Wiki Links syntax`,-1)]]),_:1}),r(x,{name:`embedLink`,optional:``,type:`boolean`,"default-value":`true`},{default:e(()=>[...l[4]||=[s(`p`,null,`Enable embed content syntax`,-1)]]),_:1}),r(x,{name:`comment`,optional:``,type:`boolean`,"default-value":`true`},{default:e(()=>[...l[5]||=[s(`p`,null,`Enable comment syntax`,-1)]]),_:1})]),l[10]||=o(`<h2 id="notes" tabindex="-1"><a class="header-anchor" href="#notes"><span>Notes</span></a></h2><ul><li>These plugins provide <strong>compatibility support</strong> and do not fully implement all of Obsidian&#39;s functionality</li><li>Some Obsidian-specific features (such as the graph view for internal links, bidirectional links, etc.) are outside the scope of this support</li><li>When embedding content, the embedded page also participates in the theme&#39;s build process</li><li>PDF embeds require the <code>pdf</code> plugin to be enabled simultaneously</li><li>Video embeds require the <code>artPlayer</code> plugin to be enabled simultaneously</li></ul>`,2)])}var g=c(u,[[`render`,h]]);export{l as _pageData,g as default};