An opinionated boilerplate for people using Obsidian.
If you're new to Obsidian, I'd recommend just using it without any plugins or configs. Just get familiar with the interface as a Markdown editor and linking things.
Once you're more acclimated to it, then feel free to take pieces of inspiration from the boilerplate!
- Download and install Obsidian
- Download or clone a fork of this repo
- Open Obsidian and you should see a prompt like below:
- Click on the
Open
button next to "Open folder as vault" - Select the folder you've downloaded / cloned from Step #2.
- When prompted with "Safe Mode," select
Turn off Safe Mode
which will enable you to utilize the third party plugins that are critical to this starter kit - You should be prompted with the "Preferences" pane, if not, you can open it by selecting the Settings (Cog) icon in the bottom left corner, or opening it with
Cmd + ,
(macOS) /Ctrl + ,
(Windows)
- Go to "Community Plugins"
- Ensure all "Installed Plugins" by are enabled. If not, toggle the switch on each one to turn everything on
- And you're good to go!
This resource is currently in development and more documentation will be created as time goes on, but if you have specific questions, don't hesitate to file an issue on the repo!