Build Extensions for Obsidian
Complete TypeScript API definitions for creating plugins, custom views, and rich integrations with Obsidian
Get Started
Start building your first Obsidian plugin in minutes.Installation
Install the Obsidian API types in your project
Quickstart
Build your first plugin with a working example
Core Concepts
Understand the plugin lifecycle and architecture
Sample Plugin
Explore the official plugin template repository
Key Features
Everything you need to extend Obsidian’s functionality.Plugin Development
Create plugins with lifecycle hooks and automatic cleanup
File System Access
Read, write, and manage files in the vault
Workspace Control
Manage panes, tabs, and custom views
Editor Integration
Interact with the Markdown editor
UI Components
Build modals, settings, and custom UI
Metadata & Caching
Access cached file metadata and links
Popular APIs
Vault & Files
Work with files, folders, and vault operations
Workspace
Manage workspace layout, leaves, and views
Editor
Manipulate editor content and selections
Settings
Create plugin settings and configuration UI