Obsidian Plugins and Ideas for Contributions ⬇️ Obsidian Ideas Drop Divide & Conquer Plugin Testing Obsidian Plugin Development Quickstart

Monetization

PLUGIN DEVELOPMENT WORKFLOW

yomaru.dev > 2 Obsidian Plugin 101

Prerequisites:

  1. Clone the Sample Repo:
    In your vault’s .obsidian/plugins folder, run:

    git clone https://github.com/HananoshikaYomaru/obsidian-sample-plugin
    

    This gives you a working template that automates a lot of the initial setup.

  2. Rename & Update:

    • Rename the folder: Change the folder name to your desired plugin name.
    • Update the manifest: Edit manifest.json to update the plugin ID, name, version, etc.
    • Adjust package.json & README: Replace any sample names with your plugin’s name and adjust scripts if needed.
  3. Change to your GitHub repo

    • Remove the original remote and add your own GitHub repo as the new remote:
	git remote remove origin
	git remote add origin https://github.com/yourusername/my-obsidian-plugin.git
	git push -u origin main
  1. Install Dependencies:
    Use Bun to install required packages:
	bun install
  1. Set Up Git (if not already):
    Initialize your repo and commit the changes:
	git init
	git add .
	git commit -m "Initial commit for my Obsidian plugin"
	git push origin main
  1. Build the plugin files from code

    The plugin code must be compiled into a main.js file that is consumed and ran by the Obsidian application.

    Run the below commands to build you main.js:

	bun run build
  1. Test Locally:

    Open Obsidian, enable Community Plugins, and enable your plugin from the development vault.

This method leverages the sample plugin to quickly scaffold your project, allowing you to focus on updating your plugin’s logic and details. For more detailed guidance, refer to the Obsidian Plugin 101 guide which outlines the full process.

Docs

Workflows

Tutorials