obsidian

Apply official Obsidian plugin guidelines for safe, maintainable plugin development.

182|15|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/gapmiss/obsidian-plugin-skill --skill obsidian-gapmiss
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian
Source: https://github.com/gapmiss/obsidian-plugin-skill/tree/main/.claude/skills/obsidian
Command: npx skills add https://github.com/gapmiss/obsidian-plugin-skill --skill obsidian-gapmiss

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Consolidates official Obsidian plugin development guidelines into a practical playbook, helping teams apply ESLint rules, memory-management practices, API usage patterns, accessibility standards, and submission requirements across projects.

Core Features & Use Cases

  • Comprehensive coverage of the 27 ESLint rules from eslint-plugin-obsidianmd and Obsidian API best practices.
  • Structured reference material on memory management, type safety, UI/UX, file operations, CSS styling, accessibility, code quality, and submission guidelines.
  • Real-world use cases include evaluating existing plugins for compliance, guiding new plugin scaffolding, and preparing submissions for the community directory.

Quick Start

Open SKILL.md to view the overview and consult the reference folder for deeper topics, then apply the guidelines to your plugin project.

Frequently Asked Questions about obsidian

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

FAQPage Schema
What are the official Obsidian plugin development guidelines for memory management and type safety?

Obsidian plugin guidelines enforce strict memory management and type safety to prevent leaks and ensure API compatibility. Adhering to these rules produces safe, maintainable plugins that function reliably across all supported platforms.

How do I configure ESLint rules for an Obsidian plugin project?

Configure ESLint for Obsidian plugins by applying the 27 specific rules from eslint-plugin-obsidianmd. This enforces code quality, API best practices, and structural standards required for passing official community directory submissions.

What is the required project structure for submitting a plugin to the Obsidian community directory?

Submitting to the Obsidian community directory requires a specific project structure, adherence to accessibility standards, and correct UI/UX patterns. Meeting these submission requirements ensures your plugin passes official review.

How do I evaluate an existing Obsidian plugin for compliance with API usage and accessibility standards?

Evaluate existing Obsidian plugins for compliance by auditing them against official API usage patterns, CSS styling rules, and accessibility standards. This structured review identifies maintenance gaps and ensures submission readiness.

Can I use standard file operations and CSS styling when building Obsidian plugins?

Standard file operations and CSS styling are allowed in Obsidian plugins but must follow official API best practices and accessibility standards. This ensures safe execution and consistent UI/UX across desktop and mobile targets.