Skip to content

DeployToObsidianPluginsFolderParams

Parameters for deployToObsidianPluginsFolder.

Import:

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

Signature:

export interface DeployToObsidianPluginsFolderParams

Properties

PropertyTypeDescription
distFolderstringThe folder where the built files are located.
isProductionBuildbooleanA boolean indicating whether the build is a production build.
obsidianConfigFolderstringThe folder of the Obsidian configuration. If not provided, the plugin will not copy files.
pluginNamestringThe name of the Obsidian plugin.
reload?ObsidianPluginReloadHow the deployed build is reloaded in Obsidian. Defaults to 'hot-reload-plugin'.

Links to this page: