README file from
GithubRefresh Any View
Obsidian renders a view once, when it opens. So a note showing a Dataview query, an embedded note, output from another plugin, or simply the current time keeps showing its original render — the content is stale and the only way to update it is to close the tab and open it again, losing your place.
This plugin re-renders any view in place, keeping your scroll position: from a toolbar button, from a command, or automatically on file change or on a timer.
Demo vault
The documentation is a demo vault. Every feature has a note that explains what it does and why you would want it, and walks you through it.
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:
- Running the Refresh Any View: Open demo vault command.
- Downloading
refresh-preview-demo-vault-<version>.zip(<version>is the release version) from the Releases. - Browsing its source in
demo-vault/in this repository.
What it does
- Refresh in place — a toolbar button on every view, plus commands for the active view, every visible view, or every open view. Your scroll position survives. 01 Refresh a view
- Refresh automatically — on file change, or on an interval, for content that should not wait for you to ask. 02 Settings
Installation
The plugin is available in the official Community Plugins repository.
Beta versions
To install the latest beta release of this plugin (regardless if it is available in the official Community Plugins repository or not), follow these steps:
- Ensure you have the BRAT plugin installed and enabled.
- Click Install via BRAT.
- An Obsidian pop-up window should appear. In the window, click the
Add pluginbutton 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:
window.DEBUG.enable('refresh-preview');
For more details, refer to the documentation.
Rebranding
This plugin was formerly known as Refresh Preview.
The plugin was extended to refresh any view, not just the preview, so it got a new name.
However, for backward compatibility, the previous id refresh-preview is still used internally and you might find it
- in the plugin folder name;
- in the plugin URL;
- in the Debugging section.
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.