Get Started
This template is an alternative setup to using Quartz to publish an Obsdian vault.
Quartz requires at least Node v20 to function correctly. Ensure you have this installed on your machine before continuing.
First Steps
- Initialize a local project using github’s Use this template button.
- Re-initialize the quartz subtree with
yarn quartz:init - Install necessary packages with
yarn install. A preinstall script will make sure the Quartz dependencies are also retrieved. - Apply the desired Quartz Customizations
- (Optional/Recommended) Rename your vault directory to be more descriptive.
- Run the dev server with
yarn dev - Open your vault directory (not the repo directory) as an obsidian vault and begin editing.
- (Optional) Enable encryption
- Deploy!