x/swarnam-obsidian
1
0
Fork 0
mirror of https://github.com/runofthemillgeek/swarnam-obsidian.git synced 2024-11-16 15:30:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Lishid 2021-03-01 12:59:44 -05:00 committed by GitHub
parent ed0e0a6e90
commit ceb3837850
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -15,6 +15,16 @@ This sample plugin demonstrates some of the basic functionality the plugin API c
- Registers a global click event and output 'click' to the console. - Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console. - Registers a global interval which logs 'setInterval' to the console.
### First time developing plugins?
Quick starting guide for new plugin devs:
- Make a copy of this repo as a template with the "Use this template" button.
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugin/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 `main.ts` to `main.js`.
- Make changes to `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.
### Releasing new releases ### Releasing new releases