PluginManifest

Official

Both Official Unofficial

Both Own Inherited

Metadata about a Community plugin.

Import:

import type { PluginManifest } from 'obsidian';

Signature:

export interface PluginManifest

Properties

	Property	Type	Description
	author	string	The author's name.
	authorUrl?	string	A URL to the author's website.
	description	string	A description of the plugin.
	dir?	string	obsidian#Vault path to the plugin folder in the config directory.
	fundingUrl?	string	URL for funding the author.
	id	string	The plugin ID.
	isDesktopOnly?	boolean	Whether the plugin can be used only on desktop.
	minAppVersion	string	The minimum required Obsidian version to run this plugin.
	name	string	The display name.
	version	string	The current version, using https://semver.org/ Semantic Versioning.

---

Links to this page:

• Plugin
• PluginsManifestsRecord
• PluginUpdateManifest