obsidian-reference-architecture

Featured

Implement Obsidian reference architecture with best-practice project layout. Use when designing new plugins, reviewing project structure, or establishing architecture standards for Obsidian development. Trigger with phrases like "obsidian architecture", "obsidian project structure", "obsidian best practices", "organize obsidian plugin".

AI & Automation 2,926 stars 433 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Obsidian Reference Architecture ## Overview Architecture patterns for complex Obsidian plugins: modular project structure with separate files for views, commands, settings, and services; state management; a service layer for vault operations; command registry; view manager; and CSS scoping. ## Prerequisites - TypeScript and Obsidian API familiarity - Working build pipeline (esbuild recommended) - Plugin scaffolding complete (`manifest.json`, `package.json`, `tsconfig.json`) ## Instructions ### Step 1: Project Structure ``` my-plugin/ ├── src/ │ ├── main.ts # Plugin entry — thin orchestrator │ ├── types.ts # Shared interfaces and type definitions │ ├── constants.ts # Plugin-wide constants │ ├── commands/ │ │ ├── index.ts # Command registry │ │ ├── insert-template.ts │ │ └── toggle-sidebar.ts │ ├── views/ │ │ ├── index.ts # View registry │ │ ├── sidebar-view.ts │ │ └── modal-view.ts │ ├── settings/ │ │ ├── settings.ts # Settings interface and defaults │ │ └── settings-tab.ts # Settings UI tab │ └── services/ │ ├── vault-service.ts # File read/write/search operations │ ├── metadata-service.ts # Frontmatter and cache operations │ └── sync-service.ts # External sync or background tasks ├── styles.css ├── manifest.json ├── versions.json ├── package.json ├── tsconfig.json └── esbuild.config.mjs ``` ### Step 2: Thin Main Entry Point ```typescript // ...

Details

Author
jeremylongshore
Repository
jeremylongshore/claude-code-plugins-plus-skills
Created
1 years ago
Last Updated
yesterday
Language
Python
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category