Skip to main content

obsidian-plugin

Basics - Hello world example​

Creating an Obsidian plugin is a great way to extend the editor's functionality. Obsidian plugins are essentially TypeScript applications that run inside an Electron environment.

Step 1 - start form template​

The easiest way to start is by using the official Obsidian plugin template.

  1. Go to the obsidian-sample-plugin repository on GitHub.
  2. Click "Use this template" to create your own repository.
  3. Clone your new repository to your local machine.
  4. Run the following commands in your terminal:
npm install
npm run dev

Creating