Skip to content

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.

Import:

import { deployToObsidianPluginsFolder } from '@mnaoumov/obsidian-dev-toolkit/bundlers/obsidian-plugins-folder-deployment';

Signature:

function deployToObsidianPluginsFolder(params: DeployToObsidianPluginsFolderParams): Promise<void>

Parameters:

Parameter Type Description
params DeployToObsidianPluginsFolderParams The DeployToObsidianPluginsFolderParams.

Returns: Promise<void> — A Promise that resolves once the plugin is deployed.


Links to this page: