PluginManifest

Defined in: obsidian.d.ts:3243

Metadata about a Community plugin.

See

https://docs.obsidian.md/Reference/Manifest

Properties

author

author: string

Defined in: obsidian.d.ts:3263

The author’s name.

---

authorUrl?

optional authorUrl: string

Defined in: obsidian.d.ts:3283

A URL to the author’s website.

---

description

description: string

Defined in: obsidian.d.ts:3278

A description of the plugin.

---

dir?

optional dir: string

Defined in: obsidian.d.ts:3248

Vault path to the plugin folder in the config directory.

---

fundingUrl?

optional fundingUrl: string

Defined in: src/obsidian/augmentations/PluginManifest.d.ts:24

URL for funding the author

---

id

id: string

Defined in: obsidian.d.ts:3253

The plugin ID.

---

isDesktopOnly?

optional isDesktopOnly: boolean

Defined in: obsidian.d.ts:3289

Whether the plugin can be used only on desktop.

---

minAppVersion

minAppVersion: string

Defined in: obsidian.d.ts:3273

The minimum required Obsidian version to run this plugin.

---

name

name: string

Defined in: obsidian.d.ts:3258

The display name.

---

version

version: string

Defined in: obsidian.d.ts:3268

The current version, using Semantic Versioning.