Attachment

Attachment link and embed card rendering for Obsidian wikilinks.

日本語

Overview

attachment() provides the renderAttachment hook that @riebeckite/plugin-obsidian-markdown uses when a wikilink resolves to a non-image file ([[report.pdf]], ![[report.pdf]], ...).

Without this plugin, those wikilinks fall back to a plain download link.

Usage

import { defineConfig } from "@riebeckite/core";
import { attachment } from "@riebeckite/plugin-attachment";
import { obsidianMarkdown } from "@riebeckite/plugin-obsidian-markdown";
 
export default defineConfig({
  // ...
  plugins: [obsidianMarkdown(), attachment()],
});

Rendering

Link (non-embed)

<a class="wikilink wikilink-attachment" href="..." download>label</a>

Embed (![[file]])

<aside class="attachment-card rr-attachment" data-attachment-path="...">
  <div class="attachment-card__meta">
    <span class="attachment-card__format">PDF</span>
    <span class="attachment-card__size">1.2 MB</span>
  </div>
  <div class="attachment-card__name">report.pdf</div>
  <a class="attachment-card__download" href="..." download>label</a>
</aside>

• Format is the uppercased file extension
• Size is read from disk under config.content.directory (path-traversal safe) and omitted when the file cannot be read
• The embed card carries the stable rr-attachment root hook that themes may target

Styles ship in style.css (inline attachment links also get a ↓ suffix).

Options

Exports

• attachment(options?) / attachmentPlugin — plugin factory
• Type: AttachmentOptions

See also

• Plugin guide
• @riebeckite/plugin-obsidian-markdown