Quartz v5 Template for GitHub pages

Quartz is a set of tools that helps you publish your digital garden and notes as a website for free.

This template repository

• wraps Quartz by Jacky Zhao into a git submodule, enabling automatic updates by dependabot.
• builds the website from the notes and publishes to GitHub pages by GitHub actions.
• is Obsidian-friendly (thanks to Quartz). Open the content folder as an Obsidian vault.

How-to

Click the big green Use this template button to create a repository. Clone the created repository using GitHub Desktop or the git clone command:

git clone --recursive https://github.com/$USER/$REPO.git

Open the content folder as an Obsidian vault, edit/add notes and use GitHub Desktop or git push command to commit and push the changes to GitHub. GitHub actions will build and publish the website automatically.

[!IMPORTANT] You need to enable GitHub pages in your repository settings -> pages -> selecting GitHub actions as the source.

Preview your Quartz website

(See Building your Quartz for details)

cp quartz.config.yaml runtime/
cd runtime
npm ci
npx quartz plugin install --from-config
npx quartz build -d ../content --serve

You can open the content folder in Obsidian (or other editors) to edit/add your notes.

Cloudflare pages settings

Cloudflare pages build configurations:

• Framework preset: None
• Build command : cp -vr quartz.config.yaml content/ runtime/ && cd runtime && npm install && npx quartz plugin install --from-config && npx quartz build
• Build output directory: runtime/public