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,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 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
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