1# sublimated for Obsidian
2
3Sync status, version history, and deep links for [sublimated.com](https://sublimated.com) vaults.
4
5## features
6
7- status bar showing version, sync status, and author for the current file
8- click status bar to open the file on sublimated.com
9- version history sidebar with author, timestamp, and web links
10- commands: open on web, show versions, copy web link
11- URI handler for deep linking from sublimated.com back to Obsidian
12- works without an account for basic features (reads local file metadata)
13
14## setup
15
161. install the plugin from Obsidian community plugins
172. open your sublimated folder (Finder → CloudStorage → Sublimated) as an Obsidian vault
183. the plugin detects the `.sbl/` folder and starts showing sync info in the status bar
19
20## version history
21
22version history requires an API token:
23
241. go to sublimated.com/settings/tokens and generate a token
252. in Obsidian, go to Settings → sublimated → paste the token
263. use "sublimated: show versions" command or click the ribbon icon
27
28## authentication
29
30**current:** API token (paste in settings)
31
32**planned:** OAuth sign-in — click "Sign in with sublimated" in settings, authenticate in browser, token flows back automatically via `obsidian://sublimated?action=auth&token=...`
33
34## commands
35
36- `sublimated: open on sublimated.com` — open current file in browser
37- `sublimated: show versions` — open version history sidebar
38- `sublimated: copy web link` — copy sublimated.com URL to clipboard
39
40## URI handler
41
42```
43obsidian://sublimated?action=open&file=path/to/note.md
44```
45
46opens the specified file in your vault. used by sublimated.com's "Open in Obsidian" feature.
47
48## platform support
49
50- macOS: full features (xattr-based status bar + API features)
51- Windows/Linux: API-only mode (version history works, status bar requires API token)
52
53## development
54
55```bash
56npm install
57npm run build     # one-time build
58npm run dev       # watch mode
59```
60
61copy `main.js`, `manifest.json`, and `styles.css` to your vault's `.obsidian/plugins/sublimated/` folder.