PluginManifest
Interface: PluginManifest
Section titled “Interface: PluginManifest”Defined in: plugin.ts:40
Properties
Section titled “Properties”author
Section titled “author”author:
string
Defined in: plugin.ts:64
The author’s name.
authorUrl?
Section titled “authorUrl?”
optionalauthorUrl?:string
Defined in: plugin.ts:88
A URL to the author’s website.
description
Section titled “description”description:
string
Defined in: plugin.ts:82
A description of the plugin.
optionaldir?:string
Defined in: plugin.ts:46
Vault path to the plugin folder in the config directory.
executionHints?
Section titled “executionHints?”
optionalexecutionHints?:Record<string,unknown>
Defined in: plugin.ts:118
Optional host-specific execution hints for future sidecar scheduling.
id:
string
Defined in: plugin.ts:52
The plugin ID.
isDesktopOnly?
Section titled “isDesktopOnly?”
optionalisDesktopOnly?:boolean
Defined in: plugin.ts:95
Whether the plugin can be used only on desktop.
lapis?
Section titled “lapis?”
optionallapis?:LapisExtensionManifest
Defined in: plugin.ts:126
Optional Lapis extension metadata. Existing Obsidian-compatible manifests can omit this namespace and continue to load unchanged.
minAppVersion
Section titled “minAppVersion”minAppVersion:
string
Defined in: plugin.ts:76
The minimum required Obsidian version to run this plugin.
name:
string
Defined in: plugin.ts:58
The display name.
requiredCapabilities?
Section titled “requiredCapabilities?”
optionalrequiredCapabilities?:HostedPluginCapability[]
Defined in: plugin.ts:111
Structured host capabilities required before the plugin can be evaluated.
supportedRuntimes?
Section titled “supportedRuntimes?”
optionalsupportedRuntimes?:string[]
Defined in: plugin.ts:104
Runtime host IDs this plugin explicitly supports.
Missing or empty values preserve baseline Obsidian manifest behavior.
version
Section titled “version”version:
string
Defined in: plugin.ts:70
The current version, using Semantic Versioning.