README file from
GithubObsidian Contexts
Contexts allows you to save your open tabs as a "context" and switch between them seamlessly.
Contexts supports all file types including PDFs, Canvases, Images, and Markdown notes. It also works well across desktop and mobile.
Key Features
- Universal Support: Save and restore groups of tabs containing Markdown, PDF, Canvas, and Images.
- Cross-Device Friendly: Context data contains only the relative file paths in your Vault. This design avoids the
workspace.jsoninconsistency issue in Core Workspaces, particularly when syncing a vault across devices. Tab groups created on one device load consistently on the other without conflict. (Note: layout arrangement is not preserved.) - Safe Switching: Switches contexts smoothly without leaving empty panes or glitches.
- Save & Overwrite: Easily save your current layout. Includes protection against accidental overwrites.
- Management UI:
- View and delete saved contexts.
- Manually create contexts using a built-in File picker.
- Minimalist: Toggle the ribbon icon on/off via settings.
How to Use
1. Saving a Context
- Click the Save icon in the ribbon (or use the command
Contexts: Save current context). - Enter a name for your context (e.g., "Research Mode", "Project Alpha").
- Press Enter. Your current open tabs are now saved!
2. Switching Contexts
- Use the command
Contexts: switch context. - Select a context from the list and click Switch.
- Your current tabs will close, and the saved context will load instantly.
3. Managing Contexts
- Go to Settings > Contexts (or open Command Palette and select 'Contexts: Manage contexts').
- Click Manage contexts.
- In this modal, you can:
- Manually create a new context by selecting files from the File picker.
- Delete unwanted contexts.
Installation
Using BRAT
- Open Settings > Community plugins.
- Click Browse and install
BRAT. - Go to its own settings and find Beta plugin list.
- Click Add beta plugin and fill in the blank with
https://github.com/ba2slk/obsidian-contexts. BRATwill automatically track and download the latest version of Contexts for you, as long as you keep it enabled.
Manual Installation
- Download the
main.js,manifest.json, andstyles.cssfrom the latest release: https://github.com/ba2slk/obsidian-contexts/releases - Create a folder named
contextsinside your vault's plugin folder:.obsidian/plugins/. - Move the downloaded files into that folder.
- Reload Obsidian and enable the plugin in settings.
Contributing
Contributions are welcome! If you have ideas for improvements or bugs to report, please open an issue or submit a pull request.
License
MIT License