https://github.com/qbject/obsidian-canvas-link-optimizer

An Obsidian plugin that optimizes canvas links by displaying a page thumbnail.
https://github.com/qbject/obsidian-canvas-link-optimizer

obsidian obsidian-md obsidian-plugin typescript

Last synced: 2 days ago
JSON representation

An Obsidian plugin that optimizes canvas links by displaying a page thumbnail.

• Host: GitHub
• URL: https://github.com/qbject/obsidian-canvas-link-optimizer
• Owner: Qbject
• License: mit
• Created: 2024-02-06T22:19:10.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-10-28T15:10:04.000Z (17 days ago)
• Last Synced: 2024-10-28T15:52:41.388Z (17 days ago)
• Topics: obsidian, obsidian-md, obsidian-plugin, typescript
• Language: TypeScript
• Homepage:
• Size: 2.23 MB
• Stars: 16
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Canvas Link Optimizer Plugin

This is a lightweight Obsidian plugin designed to enhance the user experience with canvas link nodes. By default, link nodes in Obsidian canvas load the web page content as they come into view. The plugin modifies this behavior by displaying a preview thumbnail instead, which significantly reduces resource consumption. Users can still access the full web page by clicking on the thumbnail if they need more detailed information.

Here's the default behavior of link nodes in Obsidian:

![](doc/img/showcase-no-plugin.gif)

With the Canvas Link Optimizer Plugin enabled, it looks like this:

![](doc/img/showcase-with-plugin.gif)

This plugin does not modify your vault data. All thumbnails are cached locally in the `.obsidian/plugins/canvas-link-optimizer/data` directory, which can be safely cleared if necessary.

## Installation

You can install the plugin from the official [Obsidian Plugin Market](https://obsidian.md/plugins?id=canvas-link-optimizer). Alternatively, you can download the latest release from this repository and move its files `main.js`, `manifest.json` and `styles.css` to folder `.obsidian/plugins/canvas-link-optimizer` within your vault.

## Keep In Mind

To generate a page thumbnail, the plugin initially performs a standard page load. Thus, it won't immediately optimize pre-existing link nodes as well as newly created ones.

## Why Use This Plugin?

Link nodes provide convenient previews of linked content without having to open the link itself. However, the auto-loading feature comes with its drawbacks, including:

- **Performance Impact**: Auto-loading is akin to opening additional browser tabs, which can significantly increase CPU and RAM usage. This can lead to performance issues, particularly on less powerful devices.

- **Security Concerns**: Autoloading pages can inadvertently load malicious content, posing potential risks such as cryptocurrency mining or sandbox escape attempts.

- **Visual Distractions**: The auto-loading of links can create flickering and other visual disturbances that interrupt your workflow and focus.

- **Loading Delays**: Full page loads can be sluggish, particularly with a slow internet connection, leading to a less streamlined experience.

- **Unexpected Autoplay**: Autoloaded pages, such as YouTube channel homepages, may contain autoplay content, which can be disruptive if audio begins playing unexpectedly while navigating the canvas.