1
0
Fork 0
obsidian-vault-starter/README.md

47 lines
No EOL
1.8 KiB
Markdown

# README
A simple starter for [obsidian.md](https://obsidian.md).
* Daily Notes
* Daily Planner with Timeline
* Templater (e.g. for _Daily_ notes)
* Kanban support
## Getting started
Clone repository and copy all contents including potential hidden `.` files
to the vault location you like to use.
After you've opened your vault location in Obsidian, plugins and panes might not
be aligned:
* Turn off safe mode to enable community plugins on _first_ start
* Restart Obsidian and panes should be in place correctly, if not, then adjust manually
* With the command palette `ctrl + p`, _Calendar: Show_
* With the command palette `ctrl + p`, _Day Planner: Show Timeline_
* Open `_Dashboard` file and drag the top left icon after the title to the position you like
The result should look similar to:
![obsidian_preview](./../_Attachments/preview.png)
## Best Practices
* By default, all files will be opened in `source` mode. Switch to preview mode with `ctrl + e` dynamically, you'll get used to it
* Start your day
* by creating your `Daily Note/` with the icon located left in the sidebar or via action menu `ctrl + p` looking for _Daily Note: Open today's daily note_
* link this opened file as your _daily_ for the timeline to work with `ctrl + p` looking for _Day Planner: Link ..._
## Custom hotkeys
| Key | Effect |
|:--------------|----------------------------------:|
| ctrl + e | switch source and preview mode |
| ctrl + t | task menu while cursor under text |
| ctrl + l | insert internal link |
| ctrl + r | toggle _live preview_ mode |
## Git Integration
It's worth mentioning, that git integration can be achieved with [obsidian-git](https://github.com/denolehov/obsidian-git) which might suit your use case for synchronization.