obsidian-plugin/gavvvr_obsidian-timecodes-plugin
1
0
Fork 0
mirror of https://github.com/gavvvr/obsidian-timecodes-plugin.git synced 2026-07-22 05:38:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add development instructions

Browse source
This commit is contained in:
Kirill Gavrilov 2025-01-21 19:45:55 +03:00
parent 0f2422bb5f
commit cf3b7937a1
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
DEVELOPMENT.md Normal file
View file

@ -0,0 +1,24 @@
# Development how-to
## Prerequisites
- Get a [Node.js](https://nodejs.org/)
- Execute `corepack enable` to enable PnPM package manager
## Development
- It is recommended to create a new Obsidian vault for development
- `git clone` the repo to any place on your filesystem and enter the directory you cloned
- `pnpm install` once to resolve project dependencies
- `pnpm run dev` to mount the plugin to Obsidian vault (where you would like to test it)
with hot-reload capability to get instant feedback on any change in your code
---
Special thanks to:
- @pjeby for [hot-reload plugin][hot-reload] which gives an instant feedback on code change
- @zephraph for his [tools for Obsidian plugin development][obsidian-utils] package which makes development a breeze
[obsidian-utils]: https://github.com/obsidian-tools/obsidian-tools/tree/main/packages/obsidian-utils
[hot-reload]: https://github.com/pjeby/hot-reload