1# sublimated for Obsidian
2
3Sync status, version history, and deep links for [sublimated.com](https://sublimated.com) vaults.
4
5- source: https://sublimated.com/sublimated/code/obsidian
6- GitHub mirror (for Obsidian community plugin submission): https://github.com/sublimates/obsidian
7
8## features
9
10- status bar showing sync status, version, and author for the current file
11- click status bar to open the file on sublimated.com
12- version history sidebar grouped by day with author, timestamp, and per-version web links
13- commands: open on web, show versions, copy web link
14- URI handler for deep linking from sublimated.com back to Obsidian
15- works without an account — reads local file metadata from xattrs, fetches version history anonymously for public files
16
17## setup
18
191. install the plugin from Obsidian community plugins
202. open your sublimated folder (or any subfolder, Finder → CloudStorage → Sublimated-*) as an Obsidian vault
213. open any synced file — the plugin reads sublimated xattrs and shows sync info in the status bar automatically
22
23## version history
24
25- public files: no token required, version history is fetched anonymously
26- private files: add an API token in Settings → sublimated
27  1. go to sublimated.com/settings/tokens and generate a token
28  2. paste it in the plugin settings
29- open via the "sublimated: show versions" command or the ribbon history icon
30- versions are listed newest first, grouped by day (Today, Yesterday, N days ago)
31
32## authentication
33
34**current:** API token (paste in settings)
35
36**planned:** OAuth sign-in — click "Sign in with sublimated" in settings, authenticate in browser, token flows back automatically via `obsidian://sublimated?action=auth&token=...`
37
38## commands
39
40- `sublimated: open on sublimated.com` — open current file in browser
41- `sublimated: show versions` — open version history sidebar
42- `sublimated: copy web link` — copy sublimated.com URL to clipboard
43
44## URI handler
45
46```
47obsidian://sublimated?action=open&file=path/to/note.md
48```
49
50opens the specified file in your vault. used by sublimated.com's "Open in Obsidian" feature.
51
52## platform support
53
54- macOS only for now (iOS later)
55- no Windows/Linux support — sublimated is macOS/iOS only
56
57## development
58
59### first time setup
60
61```bash
62# install dependencies
63npm install
64
65# build the plugin
66npm run build
67```
68
69### test locally
70
711. pick a vault to test with (e.g. open `~/Library/CloudStorage/sublimated-dev-sublimated` as a vault in Obsidian)
72
732. create the plugin directory in that vault:
74```bash
75mkdir -p ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated
76```
77
783. symlink the build output so changes are picked up automatically:
79```bash
80ln -sf "$(pwd)/main.js" ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated/main.js
81ln -sf "$(pwd)/manifest.json" ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated/manifest.json
82ln -sf "$(pwd)/styles.css" ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated/styles.css
83```
84
854. in Obsidian: Settings > Community plugins > enable "Sublimated"
86
875. start watch mode for live rebuilds:
88```bash
89npm run dev
90```
91
926. after each rebuild: Cmd+P > "Reload app without saving" (or Cmd+R) to pick up changes