Skip to content

bundlers/obsidian-plugins-folder-deployment

Deploys a development build into the vault: copies the output folder into <vault>/.obsidian/plugins, then reloads it the way the build’s reload option says. By default that installs and enables HotReload and the plugin in an Obsidian instance npm run dev owns; 'obsidian-cli' reloads it in the Obsidian the developer has open instead (obsidian-cli-reload.ts). Every bundler adapter calls it once each rebuild has written its output, so the latest build is always the one running.

Interface Description
DeployToObsidianPluginsFolderParams Parameters for deployToObsidianPluginsFolder.
Function Description
deployToObsidianPluginsFolder Copies a development build into the vault’s plugins folder and reloads it there, as the reload option says. Does nothing for a production build, or when no Obsidian config folder is configured.