| .github | ||
| content | ||
| docs | ||
| quartz | ||
| .gitattributes | ||
| .gitignore | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| CODE_OF_CONDUCT.md | ||
| Dockerfile | ||
| globals.d.ts | ||
| index.d.ts | ||
| LICENSE.txt | ||
| package-lock.json | ||
| package.json | ||
| pnpm-lock.yaml | ||
| quartz.config.ts | ||
| quartz.layout.ts | ||
| README.md | ||
| tsconfig.json | ||
DND Four Keeps
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.
Enveloppe Plugin Setup
- Install and enable Obsidian Enveloppe plugin
- Configure github access
- Create fine-grained token with read/write access to
Contentsin the repository - If syncing repository to git, add
/.obsidian/plugins/obsidian-mkdocs-publisher/envwhich 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:
Quartz Local Setup
Install pnpm
Install pnpm to manage node versions and packages.
Install node
pnpm env use --global 20
Install dependencies
pnpm install
Configure
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
Run
npx quartz build --serve
Configure deployment
Followed https://quartz.jzhao.xyz/hosting#github-pages
Quartz v4
“[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/