Obsidian Plugin Development

Obsidian Plugin Development

Build Obsidian.md plugins following official API patterns, TypeScript best practices, and plugin review guidelines.

Claude / Claude Code
GitHub Copilot
Cursor
VS Code
OpenAI Codex
DevelopmentDeveloper

What it does

Claude doesn't know the Obsidian plugin API — it generates plugins that use methods that don't exist, attach event listeners incorrectly, access the file system in ways that conflict with Obsidian's virtual file system, and fail the community plugin review process for security or API misuse reasons. This skill loads the correct Obsidian API patterns: `Plugin` and `PluginSettingTab` class structure, `TFile`/`TFolder` usage, the correct event system, Markdown post-processing, and the review guidelines that determine whether a plugin gets listed in the community directory.

Use case

Building a plugin for Obsidian.md — either for personal use or for submission to the community plugin directory. Made by gapmiss, an Obsidian plugin developer.

The Prompt

Copy and use immediately
"Build an Obsidian plugin that automatically adds a date stamp to new notes."
"Create a plugin that links related notes based on shared tags."
"Build a plugin with a settings panel for configuring note templates."
"My plugin works locally but the community review is flagging API misuse — diagnose it."
"Add a command palette entry to my plugin that runs a custom script on the active note."

How to use

  1. 1

    Describe the plugin you want to build: what it does, when it activates, and any settings it needs.

  2. 2

    Claude generates a complete plugin with correct API usage — manifest.json, main.ts, and settings tab.

  3. 3

    For community submission: Claude checks against the review guidelines before generating the final code.

Input / Output

Input

A description of the plugin: what it does, what triggers it, what settings it exposes, and whether it's for personal use or community submission.

Output

A complete Obsidian plugin: manifest.json with correct metadata, main.ts using the correct API, settings panel if needed, and code that passes the community plugin review guidelines.

Added 15 Mar 2026Submitted by gapmiss👁 51📋 0

Details

Platforms
Claude / Claude CodeGitHub CopilotCursorVS CodeOpenAI Codex
Category
Development
License
apache-2.0
Author
gapmiss

Stats

📋 Copies0
👁 Views51
👍 Upvotes0

Install with skills.sh

npx skillsadd gapmiss/skills/obsidian-plugin-dev

Requires skills.sh CLI

Community Notes

Sign in with GitHub to leave a note.

No notes yet. Be the first to contribute.