Skip to content

ObsidianPluginDeploymentOptions

Where a development build is deployed and how Obsidian picks it up. Every bundler adapter takes these.

Import:

import type { ObsidianPluginDeploymentOptions } from '@mnaoumov/obsidian-dev-toolkit/bundlers/obsidian-plugin-build';

Signature:

export interface ObsidianPluginDeploymentOptions

Properties

PropertyTypeDescription
obsidianConfigFolder?stringA folder for Obsidian configuration. Defaults to the OBSIDIAN_CONFIG_FOLDER environment variable, read from the process or from a .env file in the project root.
reload?ObsidianPluginReloadHow a development build is reloaded in Obsidian once it is copied into the vault. Defaults to 'hot-reload-plugin'.

Links to this page: