0319c28 ←249d3b9antonApr 8, 2026 api

edit README.md via macOS

✎ modified code block # install dependencies npm install # build the plugin npm r...
✎ modified code block mkdir -p ~/Library/CloudStorage/sublimated-dev-sublimated/.o...
+ inserted heading first time setup
+ inserted heading test locally
+ inserted list item pick a vault to test with (e.g. open ~/Library/CloudStorage/...
+ inserted list item create the plugin directory in that vault:
+ inserted list item symlink the build output so changes are picked up automatica...
+ inserted code block ln -sf "$(pwd)/main.js" ~/Library/CloudStorage/sublimated-de...
+ inserted list item in Obsidian: Settings > Community plugins > enable "Sublimat...
+ inserted list item start watch mode for live rebuilds:
+ inserted code block npm run dev
+ inserted list item after each rebuild: Cmd+P > "Reload app without saving" (or ...
M /sublimated/undefined +27 -0
53 unmodified lines
54- no Windows/Linux support — sublimated is macOS/iOS only
55
56## development
57
58### first time setup
59
60```bash
61# install dependencies
62npm install
60npm run build # one-time build
61npm run dev # watch mode
63
64# build the plugin
65npm run build
66```
67
64copy `main.js`, `manifest.json`, and `styles.css` to your vault's `.obsidian/plugins/sublimated/` folder.
68### test locally
69
701. pick a vault to test with (e.g. open `~/Library/CloudStorage/sublimated-dev-sublimated` as a vault in Obsidian)
71
722. create the plugin directory in that vault:
73```bash
74mkdir -p ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated
75```
76
773. symlink the build output so changes are picked up automatically:
78```bash
79ln -sf "$(pwd)/main.js" ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated/main.js
80ln -sf "$(pwd)/manifest.json" ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated/manifest.json
81ln -sf "$(pwd)/styles.css" ~/Library/CloudStorage/sublimated-dev-sublimated/.obsidian/plugins/sublimated/styles.css
82```
83
844. in Obsidian: Settings > Community plugins > enable "Sublimated"
85
865. start watch mode for live rebuilds:
87```bash
88npm run dev
89```
90
916. after each rebuild: Cmd+P > "Reload app without saving" (or Cmd+R) to pick up changes