Development

Pull requests and contributions are very welcome!

Set up

Clone the repository into your .obsidian\plugins\ folder.

It is also recommended that you install Hot Reload for Obsidian. This will reload the Obsidian plugin every time changes are made and save you from having to restart Obsidian every time.

Debugging

Run npm run dev to begin development and rebuild whenever code changes are made.

To see SCSS changes run npm run sass in a seperate terminal.

Release

The following is for maintainers.

Make sure to commit and push all changes first. After creating an pushing to a tag, go to GitHub.com and edit the draft version.

Create new tag

git tag -a <version> -m "<version>"

Push to tag

git push origin <version>

Delete pushed tag to retry action

git push --delete origin <version>
git tag -d <version>

926 B Raw Blame History