obsidian-hello-world

Featured

Create a minimal working Obsidian plugin with commands, settings, modals, and ribbon icons. Use when building your first plugin feature, testing your setup, or learning basic Obsidian plugin patterns. Trigger with phrases like "obsidian hello world", "first obsidian plugin", "obsidian quick start", "simple obsidian plugin".

AI & Automation 2,266 stars 315 forks Updated today 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 Hello World ## Overview Build a minimal working Obsidian plugin demonstrating the five core building blocks: commands (palette + editor + checkCallback), settings tab with typed config, ribbon icons, modals, and status bar. Every snippet uses real Obsidian API. ## Prerequisites - Completed `obsidian-install-auth` setup (symlinked dev vault, `npm run dev` working) - Build pipeline producing `main.js` from `src/main.ts` ## Instructions ### Step 1: Define Typed Settings ```typescript // src/main.ts — top of file import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting, TFile } from 'obsidian'; interface MyPluginSettings { greeting: string; showRibbon: boolean; dateFormat: string; } const DEFAULT_SETTINGS: MyPluginSettings = { greeting: 'Hello, Obsidian!', showRibbon: true, dateFormat: 'YYYY-MM-DD', }; ``` ### Step 2: Create the Plugin Class with Commands ```typescript export default class MyPlugin extends Plugin { settings: MyPluginSettings; async onload() { await this.loadSettings(); // Ribbon icon — shows greeting as Notice if (this.settings.showRibbon) { this.addRibbonIcon('sparkles', 'My Plugin: Greet', () => { new Notice(this.settings.greeting); }); } // Command: show greeting (available everywhere) this.addCommand({ id: 'show-greeting', name: 'Show greeting', callback: () => new Notice(this.settings.greeting), }); // Command: insert gr...

Details

Author
jeremylongshore
Repository
jeremylongshore/claude-code-plugins-plus-skills
Created
7 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Featured

obsidian-core-workflow-a

Create an Obsidian plugin from scratch with full project scaffolding. Covers Plugin class, ribbon icons, commands, settings tab, esbuild config, manifest.json, and building/testing. Use when starting a new plugin, scaffolding a project, or learning the plugin lifecycle. Trigger with "create obsidian plugin", "scaffold obsidian plugin", "new obsidian plugin", "obsidian plugin from scratch".

2,266 Updated today
jeremylongshore
AI & Automation Featured

obsidian-install-auth

Set up Obsidian plugin development environment with Node.js and TypeScript. Use when starting a new plugin project, configuring the dev environment, or initializing Obsidian plugin development from scratch. Trigger with phrases like "obsidian setup", "obsidian plugin dev", "create obsidian plugin", "obsidian development environment".

2,266 Updated today
jeremylongshore
AI & Automation Featured

obsidian-reference-architecture

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".

2,266 Updated today
jeremylongshore
Data & Documents Solid

obsidian

Comprehensive guidelines for Obsidian.md plugin development including ESLint rules from eslint-plugin-obsidianmd v0.3.0, TypeScript best practices, memory management, API usage (requestUrl vs fetch), UI/UX standards, popout window compatibility, community.obsidian.md submission process, and Scorecard optimization. Use when working with Obsidian plugins, main.ts files, manifest.json, Plugin class, MarkdownView, TFile, vault operations, or any Obsidian API development.

143 Updated 3 days ago
gapmiss
AI & Automation Featured

obsidian-core-workflow-b

Build advanced Obsidian plugin features: custom views (ItemView), modals, editor commands with selection manipulation, status bar, context menus, and Vault API file creation/modification. Use when adding UI components to a plugin, building sidebar views, or creating modal dialogs. Trigger with "obsidian modal", "obsidian custom view", "obsidian sidebar", "obsidian context menu", "obsidian editor command", "obsidian UI".

2,266 Updated today
jeremylongshore