Link Cards

An Obsidian plugin that fetches metadata from supported URLs and displays them as rich embed cards directly inside your notes.

Features

• 🔗 Detects URLs when pasted into Obsidian
• ✨ Lets you choose whether to create an embed
• 🎴 Renders metadata as embed cards
• 🎬 Supports movie and TV metadata through OMDb
• ▶️ Supports YouTube metadata through the YouTube Data API
• 🌐 Supports general website metadata through OpenGraph
• 🖼️ Displays thumbnails, descriptions, favicons, and other metadata
• 🌫️ Optional blurred background using the card's image
• ⚙️ Configurable API providers
• 🔐 API keys are stored using Obsidian's Secret Storage

Supported Providers

More providers may be added in the future.

How It Works

Paste a supported URL into an Obsidian note:

https://www.youtube.com/watch?v=...

Link Cards detects the URL and provides an option to create an embed.

The URL is then replaced with an embed code block:

```embed
title: "Learn English with Movies"
image: "https://example.com/image.jpg"
description: "A description of the content."
url: "https://www.youtube.com/watch?v=..."
favicon: "https://www.youtube.com/favicon.ico"
aspectRatio: auto
```

Obsidian renders the block as an embed card.

Installation

The plugin is currently under development.

Manual Installation

1. Download the latest release.

2. Extract the plugin files into:

   YourVault/.obsidian/plugins/obsidian-meta-embed/
   

3. Enable Link Cards from Settings → Community plugins.

Configuration

Open Settings → Link Cards

Configure the API keys for the providers you want to use.

Each provider can be configured independently, and API keys are stored using Obsidian's Secret Storage.

API Keys

You only need API keys for the providers you enable:

• YouTube Data API v3
• OMDb API
• OpenGraph

API keys should be entered through the plugin settings rather than stored directly in your notes or source code.

Development

Clone the repository:

git clone https://github.com/mainamirh/obsidian-meta-embed.git
cd obsidian-meta-embed

Install dependencies:

npm install

Start development mode:

npm run dev

Build the plugin:

npm run build

Architecture

Link Cards uses a provider-based architecture.

URL
 │
 ▼
Provider Detection
 │
 ├── YouTube ────────► YouTube Data API
 │
 ├── Movie / TV ─────► OMDb API
 │
 └── Other URLs ─────► OpenGraph
 │
 ▼
Normalized Metadata
 │
 ▼
Embed Code Block
 │
 ▼
Embed Card

Each provider is responsible for determining whether it supports a URL and fetching metadata in a common format.

export type Metadata = {
    title: string;
    description: string;
    image: string;
    url: string;
    favicon: string;
    aspectRatio: "video" | "auto";
};

This makes it possible to add additional providers without changing the core embed rendering system.

License

This project is licensed under the MIT License.

Acknowledgements

Obsidian Link Embed