From 8b1e0e4050ad20a50486d030ac62ec4dda555fa0 Mon Sep 17 00:00:00 2001 From: Corey Petty Date: Fri, 20 Oct 2023 10:51:41 -0400 Subject: [PATCH] update readme with obsidian directions --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 28a5e3f46..4d22659eb 100644 --- a/README.md +++ b/README.md @@ -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 :) \ No newline at end of file +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.