obsidian-plugin-development

Build and debug Obsidian plugins using the TypeScript API.

515|64|Updated Oct 23, 2024
One-click install
npx skills add https://github.com/allenhutchison/obsidian-gemini --skill obsidian-plugin-development-allenhutchison
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-plugin-development
Source: https://github.com/allenhutchison/obsidian-gemini/tree/main/.agents/skills/obsidian-plugin-development
Command: npx skills add https://github.com/allenhutchison/obsidian-gemini --skill obsidian-plugin-development-allenhutchison

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill provides a practical framework for building, modifying, and debugging Obsidian plugins using the TypeScript API. It consolidates guidance on plugin anatomy, core APIs, UI components, and lifecycle patterns to streamline development within Obsidian.

Core Features & Use Cases

  • End-to-end plugin scaffolding: from main.ts to manifest.json, styles, build config, and packaging.
  • API-focused development: Vault, Workspace, MetadataCache, Markdown rendering, events, and CLI tooling for automation.
  • Real-world use: Create a new plugin to automate vault tasks, customize UI, or extend Obsidian's capabilities.

Quick Start

Install this skill in your Obsidian workspace and begin scaffolding your first plugin with a TypeScript-based project.

Frequently Asked Questions about obsidian-plugin-development

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build Obsidian plugins using the TypeScript API?

You develop Obsidian plugins using the TypeScript API by scaffolding a project from main.ts and manifest.json, configuring the build environment, and utilizing the obsidian npm package to implement plugin logic.

What is the structure of an Obsidian plugin project?

The structure of an Obsidian plugin project requires a main.ts entry point, a manifest.json file for metadata, build configuration, and associated styles to define the plugin anatomy and lifecycle patterns.

Do I need Node.js and npm to develop Obsidian plugins?

Yes, you need Node.js, npm, TypeScript, and the obsidian npm package installed in your environment to develop, build, and debug Obsidian plugins effectively.

How do I access vault workflows and metadata in an Obsidian plugin?

You access vault workflows and metadata in an Obsidian plugin by utilizing core APIs including the Vault, Workspace, and MetadataCache to manage files, handle events, and render markdown content.

What's the best way to debug an Obsidian plugin during development?

The best way to debug an Obsidian plugin during development is to use the TypeScript API lifecycle patterns and CLI workflows to streamline maintenance and identify issues within the workspace.

Can I create custom UI components for Obsidian vault workflows?

Yes, you can create custom UI components for Obsidian vault workflows by extending the TypeScript API to customize the interface and automate tasks within the workspace.