README file from
GithubBacklink Cache
[!WARNING]
Backlink Cacheno longer does anything but point to its successor. Install Advanced Metadata Cache instead: it carries the backlink cache this plugin used to keep, and more. Once it is enabled, uninstallBacklink Cache.
This plugin used to keep a backlink index for Obsidian, so that app.metadataCache.getBacklinksForFile() answered without rescanning the vault. That cache now lives in Advanced Metadata Cache, and since version 3.0.0 every part of it is gone from here.
Demo vault
The documentation is an interactive demo vault. Its one feature note explains both notices and lets you bring the suggestion back.
Start reading here — it is plain markdown, so it works on GitHub with nothing installed.
A copy of the vault ships with every release. You can access it via any of the following:
- Downloading
backlink-cache-demo-vault.zipfrom the Releases. It unzips into a singlebacklink-cache-demo-vault-<version>folder. - Browsing its source in
demo-vault/in this repository.
What it does
- It suggests installing
Advanced Metadata Cachewhile that plugin is not enabled, with a notice on load and a banner in its settings. 01 Successor suggestion - It asks to be removed once
Advanced Metadata Cacheis enabled, with exactly two buttons: uninstallBacklink Cache, or disable it. 01 Successor suggestion
Nothing else. It no longer patches getBacklinksForFile(), indexes canvases, or registers any command.
Installation
Do not install this plugin: install Advanced Metadata Cache from the official Community Plugins repository instead.
Debugging
By default, debug messages for this plugin are hidden.
To show them, run the following command in the DevTools Console:
window.DEBUG.enable('backlink-cache');
For more details, refer to the documentation.
Changelog
All notable changes to this project will be documented in the CHANGELOG.
Contributing
Contributions are welcome — see CONTRIBUTING to get set up.
Support
My other Obsidian resources
See my other Obsidian resources.