update readme with obsidian directions

This commit is contained in:
Corey 2023-10-20 10:51:41 -04:00
parent c50f8f952d
commit 8b1e0e4050
1 changed files with 24 additions and 1 deletions

View File

@ -22,4 +22,27 @@ For now, this process is quite manual, purposely. In order to solidify the forma
If you see a type or broken link, PRs are always welcome :)
If there is information you'd like to see included that isn't here, create and issue :)
If there is information you'd like to see included that isn't here, create and issue :)
### Using Obsidian
Quartz is created to serve a static site off of an [Obsidian](https://obsidian.md) vault, and thus is the preferred way to manage content locally. In order for all it to function properly, a things need to be done properly.
First and foremost, Quartz uses links references with `content` as the root direction, so when opening in Obsidian, open the content folder, and _not_ the repo directory.
Then the following vault settings need to be configured
- under `Options --> Files and Links`
- enable `Automatically update internal links`
- `Link format` should be set to `Absolute path in vault`
- enable `use Wikilinks`
In order to use the templates in the `Templates` folder for auto populating commmon files,
- Install and enable `Templater` in the Community Plugins
- set the `Templates folder` to `templates`
- enable `automatic jump to cursor`
- enable `Trigger Templater on new file creation`
- enable `Folder templates`
- assign whichever templates you want to be triggered when a new file is created in a given folder.
Refer the [Templater documentation](https://silentvoid13.github.io/Templater/) for how to create your own templates.