{"repo":"obsidianmd/obsidian-sample-plugin","free":true,"listed":false,"github":"https://github.com/obsidianmd/obsidian-sample-plugin","clone":"git clone https://github.com/obsidianmd/obsidian-sample-plugin.git","description":"Template for Obsidian community plugins with build configuration and development best practices.","language":"TypeScript","stars":4472,"topics":["obsidian","obsidian-md","obsidian-plugin","plugin"],"license":"0BSD","category":"productivity","readme_excerpt":"Obsidian Sample Plugin This is a sample plugin for Obsidian (https://obsidian.md). This project uses TypeScript to provide type checking and documentation. The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does. This sample plugin demonstrates some of the basic functionality the plugin API can do. - Adds a ribbon icon, which shows a Notice when clicked. - Adds a command \"Open modal (simple)\" which opens a Modal. - Adds a plugin setting tab to the settings page. - Registers a global click event and outputs a Notice on click. - Registers a global interval which logs 'setInterval' to the console. First time developing plugins? Quick starting guide for new plugin devs: - Check if someone already developed a plugin for what you want! There might be an existing plugin similar enough that you can partner up with. - Make a copy of this repo as a template with the \"Use this template\" button (login to GitHub if you don't see it). - Clone your repo to a local development folder. For convenience, you can place this folder in your .obsidian/plugins/your-plugin-name folder. - Install NodeJS, then run npm i in the command line under your repo folder. - Run npm run dev to compile your plugin from src/main.ts to main.js . - Make changes to src/main.ts (or create new .ts files). Those changes should be automatically compiled into main.js . - Reload Obsidian to load the new version of your plugin. - Enable","default_branch":null,"files":null,"tree":[],"storefront":"/r/obsidianmd","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/obsidianmd/obsidian-sample-plugin/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}