obsidian-backlink-cache

KO | EN

gitlite — search

#javascript #python #machine-learning #typescript #android #java #react #paper #r #shiny #scala #spark

obsidian-backlink-cache

★ 52 Open GitHub ↗

Obsidian plugin that stores backlink cache to speed up app.metadataCache.getBacklinksForFile().

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Backlink Cache

[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/mnaoumov)
[![GitHub release](https://img.shields.io/github/v/release/mnaoumov/obsidian-backlink-cache)](https://github.com/mnaoumov/obsidian-backlink-cache/releases)
[![GitHub downloads](https://img.shields.io/github/downloads/mnaoumov/obsidian-backlink-cache/total)](https://github.com/mnaoumov/obsidian-backlink-cache/releases)
[![Coverage: 100%](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://github.com/mnaoumov/obsidian-backlink-cache)

This is a plugin for [Obsidian](https://obsidian.md/) that maintains backlink cache to speed up undocumented `app.metadataCache.getBacklinksForFile()` function.

It's mostly useful for users with the large vaults. On smaller vaults the difference might be unnoticeable.

It speeds up `Backlinks Pane` performance and plugins that deal with the backlinks.

This plugin the most likely will be useful for other plugin developers that deal with the backlinks.

Its idea came from the [forum](https://forum.obsidian.md/t/store-backlinks-in-metadatacache/67000).

Also the plugin includes canvas (`.canvas`) files in the backlinks for the referenced notes, and exposes a canvas file's links through `app.metadataCache.getCache()`. See [Canvas backlinks](#canvas-backlinks).

## Usage

### Fast version

The provided version is faster than the built-in version. Also the overload to accept `path` was added.

```js
const backlinks1 = app.metadataCache.getBacklinksForFile(file);
const backlinks2 = app.metadataCache.getBacklinksForFile(path);
```

### Safe version

If you want to ensure the all recent file changes are processed and the backlinks are 100% accurate.

```js
const backlinks1 = await app.metadataCache.getBacklinksForFile.safe(file);
const backlinks2 = await app.metadataCache.getBacklinksForFile.safe(path);
```

### Original version

You can access the original built-in version:

```js
const backlinks = app.metadataCache.getBacklinksForFile.originalFn(file);
```

### TypeScript typings

If you want to use the updated functions from your plugin, you can copy [types.d.ts](./types.d.ts) into your code.

### Canvas backlinks

Obsidian resolves canvas backlinks natively since `v1.12.4`: links from canvas file/text cards appear in the `Backlinks` pane and graph, and in `app.metadataCache.getBacklinksForFile()` and `resolvedLinks` / `unresolvedLinks`.

On top of that, the plugin keeps canvas files in its fast backlink index and additionally exposes each canvas file's links through `app.metadataCache.getCache()`, which Obsidian leaves empty for canvas files. This runs when the [`Canvas`](https://help.obsidian.md/plugins/canvas) core plugin is enabled.

### Backlinks panel

The plugin speeds up the Backlinks panel if [`Backlinks`](https://help.obsidian.md/plugins/backlinks) core plugin is enabled.

### Frontmatter markdown links

The plugin includes backlinks from the frontmatter markdown links if [`Frontmatter Markdown Links`](https://obsidian.md/plugins?id=frontmatter-markdown-links) community plugin is enabled. Example of such link:

```md
---
key: "[title](path/to/link.md)"
---
```

## Demo vault

A demo vault with usage examples ships with every release. You can access it via any of the following:

1. Running the **Backlink Cache: Open demo vault** command.
2. Downloading `backlink-cache-demo-vault-<version>.zip` (`<version>` is the release version) from the [Releases](https://github.com/mnaoumov/obsidian-backlink-cache/releases).
3. Browsing its source in [`demo-vault/`](./demo-vault/README.md) in this repository.

## Installation

The plugin is available in [the official Community Plugins repository](https://obsidian.md/plugins?id=backlink-cache).

### Beta versions

To install the latest beta release of this plugin (regardless if it is available in [the official Community Plugins repository](https://obsidian.md/plugins) or not), follow these steps:

1. Ensure you have the [BRAT plugin](https://obsidian.md/plugins?id=obsidian42-brat) installed and enabled.
2. Click [Install via BRAT](https://intradeus.github.io/http-protocol-redirector?r=obsidian://brat?plugin=https://github.com/mnaoumov/obsidian-backlink-cache).
3. An Obsidian pop-up window should appear. In the window, click the `Add plugin` button once and wait a few seconds for the plugin to install.

## Debugging

By default, debug messages for this plugin are hidden.

To show them, run the following command:

```js
window.DEBUG.enable('backlink-cache');
```

For more details, refer to the [documentation](https://mnaoumov.dev/obsidian-dev-utils/guides/debugging/).

## Support

## My other Obsidian resources

[See my other Obsidian resources](https://github.com/mnaoumov/obsidian-resources).

## License

obsidian-backlink-cache

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README