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

الانتقال إلى التثبيت

المستودع: jeremylongshore/claude-code-plugins-plus-skills
آخر نشاط في المصدر: ١٧ يوليو ٢٠٢٦ في ٢٢:١٨
لغة SKILL.md المكتشفة: الإنجليزية
النجوم: ٢٬٦٠٤
التفرعات: ٣٧٨

خيارات التثبيت

يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.

التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.

يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.

npx skills add https://github.com/jeremylongshore/claude-code-plugins-plus-skills --skill obsidian-core-workflow-a

يبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.

تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.

مراجعة ملفات المصدر

اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.

مستكشف الملفات

2 ملفات

SKILL.md

تعليمات المصدر · معاينة للقراءة فقط

العودة إلى البحث العودة إلى التثبيت

Obsidian Core Workflow A: Create a Plugin from Scratch

Overview

Build a complete Obsidian plugin from an empty directory. By the end you will have a working plugin with a ribbon icon, command palette entries, a settings tab, and a production esbuild build. Every file is shown in full -- no stubs.

Prerequisites

Node.js 18+ installed

Obsidian desktop app installed

A vault to test in (create a fresh vault at ~/ObsidianDev if needed)

Instructions

Step 1: Scaffold the project

set -euo pipefail PLUGIN_NAME="my-obsidian-plugin" mkdir -p "$PLUGIN_NAME/src" cd "$PLUGIN_NAME" # Initialize Node project npm init -y # Install Obsidian types and build tool npm install --save-dev obsidian@latest typescript@latest esbuild@latest \ @types/node@latest tslib@latest # TypeScript config cat > tsconfig.json << 'TSEOF' { "compilerOptions": { "baseUrl": ".", "inlineSourceMap": true, "inlineSources": true, "module": "ESNext", "target": "ES2018", "allowJs": true, "noImplicitAny": true, "moduleResolution": "node", "importHelpers": true, "isolatedModules": true, "strictNullChecks": true, "lib": ["DOM", , ] }, : [] } TSEOF

name	obsidian-core-workflow-a
description	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".
allowed-tools	Read, Write, Edit, Bash(npm:), Bash(mkdir:), Bash(ln:*), Glob
version	1.13.0
license	MIT
author	Jeremy Longshore <jeremy@intentsolutions.io>
tags	["obsidian","plugin-development","typescript","scaffolding"]
compatibility	Designed for Claude Code, also compatible with Codex and OpenClaw

Obsidian Core Workflow A: Create a Plugin from Scratch

Overview

Prerequisites

Node.js 18+ installed
Obsidian desktop app installed
A vault to test in (create a fresh vault at ~/ObsidianDev if needed)

Instructions

Step 1: Scaffold the project

set -euo pipefail

PLUGIN_NAME="my-obsidian-plugin"
mkdir -p "$PLUGIN_NAME/src"
cd "$PLUGIN_NAME"

# Initialize Node project
npm init -y

# Install Obsidian types and build tool
npm install --save-dev obsidian@latest typescript@latest esbuild@latest \
  @types/node@latest tslib@latest

# TypeScript config
cat > tsconfig.json << 'TSEOF'
{
  "compilerOptions": {
    "baseUrl": ".",
    "inlineSourceMap": true,
    "inlineSources": true,
    "module": "ESNext",
    "target": "ES2018",
    "allowJs": true,
    "noImplicitAny": true,
    "moduleResolution": "node",
    "importHelpers": true,
    "isolatedModules": true,
    "strictNullChecks": true,
    "lib": ["DOM", , ]
  },
  : []
}
TSEOF

// src/main.ts import { App, Editor, MarkdownView, Notice, Plugin, PluginSettingTab, Setting, } from "obsidian"; // ── Settings ──────────────────────────────────────────────────────── interface MyPluginSettings { greeting: string; showRibbon: boolean; } const DEFAULT_SETTINGS: MyPluginSettings = { greeting: "Hello from My Plugin!", showRibbon: true, }; // ── Plugin ────────────────────────────────────────────────────────── export default class MyPlugin extends Plugin { settings: MyPluginSettings; async onload() { await this.loadSettings(); // Ribbon icon -- shows a Notice when clicked if (this.settings.showRibbon) { this.addRibbonIcon("sparkles", "My Plugin: Greet", () => { new Notice(this.settings.greeting); }); } // Command: show greeting as Notice this.addCommand({ id: "show-greeting", name: "Show greeting", callback: () => { new Notice(this.settings.greeting); }, }); // Command: insert greeting at cursor (only available in editor) this.addCommand({ id: "insert-greeting", name: "Insert greeting at cursor", editorCallback: (editor: Editor, view: MarkdownView) => { editor.replaceSelection(this.settings.greeting); }, }); // Command: count words in current note this.addCommand({ id: "count-words", name: "Count words in current note", editorCallback: (editor: Editor) => { const text = editor.getValue(); const count = text.split(/\s+/).filter(Boolean).length; new Notice(`Word count: ${count}`); }, }); // Status bar item const statusEl = this.addStatusBarItem(); statusEl.setText("Plugin loaded"); // Settings tab this.addSettingTab(new MyPluginSettingTab(this.app, this)); console.log("MyPlugin loaded"); } onunload() { console.log("MyPlugin unloaded"); } async loadSettings() { this.settings = Object.assign( {}, DEFAULT_SETTINGS, await this.loadData() ); } async saveSettings() { await this.saveData(this.settings); } } // ── Settings Tab ──────────────────────────────────────────────────── class MyPluginSettingTab extends PluginSettingTab { plugin: MyPlugin; constructor(app: App, plugin: MyPlugin) { super(app, plugin); this.plugin = plugin; } display(): void { const { containerEl } = this; containerEl.empty(); new Setting(containerEl) .setName("Greeting message") .setDesc("Text shown by the greet command and ribbon icon.") .addText((text) => text .setPlaceholder("Hello from My Plugin!") .setValue(this.plugin.settings.greeting) .onChange(async (value) => { this.plugin.settings.greeting = value; await this.plugin.saveSettings(); }) ); new Setting(containerEl) .setName("Show ribbon icon") .setDesc("Toggle the sparkles icon in the left ribbon.") .addToggle((toggle) => toggle .setValue(this.plugin.settings.showRibbon) .onChange(async (value) => { this.plugin.settings.showRibbon = value; await this.plugin.saveSettings(); new Notice("Reload plugin to apply ribbon change."); }) ); } }

Error	Cause	Fix
`Cannot find module 'obsidian'`	Missing dev dependency	`npm install --save-dev obsidian`
Plugin not in list	`manifest.json` missing or invalid	Verify `id` field matches folder name
Ribbon icon missing	Invalid icon name	Use a Lucide icon name (sparkles, file-text, search, etc.)
Settings not persisting	Forgot `await this.saveData()`	Always await `saveData` in onChange
`editorCallback` command greyed out	No active editor	Open a markdown note first
Build fails with external error	Forgot to externalize obsidian	Check `external` array in esbuild config

obsidian-core-workflow-a

خيارات التثبيت

مراجعة ملفات المصدر

Obsidian Core Workflow A: Create a Plugin from Scratch

Overview

Prerequisites

Instructions

Step 1: Scaffold the project

Obsidian Core Workflow A: Create a Plugin from Scratch

Overview

Prerequisites

Instructions

Step 1: Scaffold the project

Step 2: Create manifest.json

Step 3: Write the esbuild config

Step 4: Write main.ts -- the full plugin

Step 5: Add npm scripts and build

Step 6: Install into your vault and test

Output

Error Handling

Examples

Resources

Next Steps

obsidian-core-workflow-a

معلومات المصدر

خيارات التثبيت

مراجعة ملفات المصدر

المزيد من هذا المستودع

المزيد من هذا المستودع

Obsidian Core Workflow A: Create a Plugin from Scratch

Overview

Prerequisites

Instructions

Step 1: Scaffold the project

Obsidian Core Workflow A: Create a Plugin from Scratch

Overview

Prerequisites

Instructions

Step 1: Scaffold the project

Step 2: Create manifest.json

Step 3: Write the esbuild config

Step 4: Write main.ts -- the full plugin

Step 5: Add npm scripts and build

Step 6: Install into your vault and test

Output

Error Handling

Examples

Resources

Next Steps