Please open an issue for bugs or suggestions for improvement. All feedback is welcome.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Fork the Vault Explorer repository from GitHub
Install Bun.sh for your operating system
Clone the forked repository
git clone https://github.com/<your-username>/obsidian-vault-explorer.gitChange directories to the repository on your machine
cd obsidian-vault-explorerInstall dependencies
bun installBuild the project. This will create a dist folder
bun run buildThe repository that you cloned contains a folder called test-vault. This is what will be used for development.
The test-vault contains a .obsidian/plugins/vault-explorer folder with a data.json file but it is missing the main.js, manifest.json and styles.css.
We need to create symbolic links for each of these folders
cd test-vault/.obsidian/plugins/vault-explorerln -s ../../../../dist/main.js .ln -s ../../../../dist/manifest.json .ln -s ../../../../dist/styles.css .Checkout the dev branch and make a child branch off of it.
git pull devgit checkout devgit checkout -b <your-branch-name>Important
Please make sure that you make a branch off of dev instead of master. This will help reduce merge conflicts by making sure that you have the latest code changes.
Run esbuild in development mode
bun run devMake some code changes
Restart your Obsidian application to see your code changes in action
Once you have commited your changes, push your code to GitHub and open a pull request.
Please choose your branch and dev as the branch you want to merge into.
Your pull request will be reviewed. Once it is approved, it will be merged.