Publish obsidian vault using a combination of two projects:
Enveloppe handles rendering dataview
which can't be done by quartz directly.
This repository stores only the published notes, syncing the edited notes is a separate concern handled by another repository.
- Install and enable Obsidian Enveloppe plugin
- Configure github access
- Create fine-grained token with read/write access to
Contents
in the repository - If syncing repository to git, add
/.obsidian/plugins/obsidian-mkdocs-publisher/env
which stores the secret to.gitignore
- In
File paths
, set:- File Tree in repository:
Obsidian Path
- Root folder:
content
- Folder note:
index.md
- File Tree in repository:
- In
Content
, set:- Dataview:
on
- Dataview:
Install pnpm
to manage node versions and packages.
pnpm env use --global 20
pnpm install
npx quartz create
Answered questions:
- Choose how to initialize the content? Empty Quartz
- Choose how Quartz should resolve links in your content. Treat links as relative paths
npx quartz build --serve
Followed https://quartz.jzhao.xyz/hosting#github-pages
“[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming
Quartz is a set of tools that helps you publish your digital garden and notes as a website for free. Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use.
🔗 Read the documentation and get started: https://quartz.jzhao.xyz/