Files
bens-obsidian-boilerplate/README.md

27 lines
1.4 KiB
Markdown

# Obsidian Starter Kit
An opinionated starter kit to help people get up and running as quickly as possible.
## Getting Up and Running
1. Download and install [Obsidian](https://obsidian.md/)
2. [Download](https://github.com/bencodezen/obsidian-starter-kit/archive/refs/heads/main.zip) or clone a fork of this repo
3. Open Obsidian and you should see a prompt like below:
<img src="/assets/obsidian-prompt.png" alt="Obsidian open prompt" width="300" />
4. Click on the `Open` button next to "Open folder as vault"
5. Select the folder you've downloaded / cloned from Step #2.
6. 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
7. 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)
<img src="/assets/preferences-panel.png" alt="Obsidian Preferences panel" width="300" />
8. Go to "Community Plugins"
9. Ensure all "Installed Plugins" by are enabled. If not, toggle the switch on each one to turn everything on
10. And you're good to go!
## Next Steps
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!