📚 Obsidian + Quartz Setup

notes.shdwnet.org Setup Documentation

Personal knowledge base using Obsidian for editing and Quartz for publishing as a static site.

---

🏗️ Architecture

Obsidian (local) → Git push → GitHub → Cloudflare Pages → notes.shdwnet.org

---

💻 Local Setup

Component	Location
Vault/Quartz	~/Documents/notes.shdwnet.org/
Content	~/Documents/notes.shdwnet.org/content/
Quartz Version	4.5.2
Node Requirement	≥22

Launch Obsidian

flatpak run md.obsidian.Obsidian

Local Preview

cd ~/Documents/notes.shdwnet.org
npx quartz build --serve

Dev server runs at: http://localhost:8080

---

🐙 GitHub

Property	Value
Repo	red40mademedoit/notes.shdwnet.org
URL	git@github.com:red40mademedoit/notes.shdwnet.org.git
Branch	main
SSH Key	~/.ssh/github_ed25519

---

☁️ Cloudflare Pages

Property	Value
Project	notes-shdwnet-org
Preview URL	notes-shdwnet-org.pages.dev
Custom Domain	notes.shdwnet.org
Build Command	npm run quartz build
Output Dir	public
Node Version	22

---

🚀 Deploy Workflow

1. Edit notes in Obsidian (vault is content/)
2. Commit and push:

cd ~/Documents/notes.shdwnet.org
git add .
git commit -m "Update notes"
git push

3. Cloudflare Pages auto-rebuilds (~1-2 min)

---

📁 Vault Structure (PARA Method)

content/
├── 00-Inbox/          # Quick capture
├── 01-Projects/       # Active, time-bound work
├── 02-Areas/          # Ongoing interests
├── 03-Resources/      # Reference material
├── 04-Archive/        # Completed/dormant
├── 05-Documentation/  # Technical docs (infra, services, guides)
├── 06-Admin/          # Corporate, legal, IP registry
├── Daily/             # Daily notes
├── Maps/              # Maps of Content (MOCs)
├── Templates/         # Note templates
└── index.md           # Homepage

---

⚙️ Quartz Config

Setting	Value
Config file	quartz.config.ts
Layout	quartz.layout.ts
Base URL	notes.shdwnet.org
Analytics	Plausible
Ignored patterns	private, templates, .obsidian

Features enabled:

• SPA navigation
• Link popovers on hover
• LaTeX rendering (KaTeX)
• Syntax highlighting
• RSS feed & sitemap generation
• Custom OG images

---

🔧 Quick Commands

Build locally

npx quartz build

Serve with hot reload

npx quartz build --serve

Sync upstream Quartz updates

npx quartz update

---

🔗 Linking Conventions

Syntax	Usage
[[Page Name]]	Wiki-style internal link
[[folder/page|Display Text]]	Link with custom text
![[image.png]]	Embed image
#tag	Tag for categorization

---

📋 Frontmatter Template

---
title: "Note Title"
date: 2025-02-02
tags:
  - topic
  - category
draft: false
---

Set draft: true to hide a note from the published site.

---

🗺️ Maps of Content (MOCs)

MOCs serve as index pages for topics. Create new MOCs in Maps/ folder with naming convention MOC-TopicName.md.

---

🔧 Maintenance

Task	Command/Action
Update Quartz	npx quartz update
Check broken links	Review build warnings
Prune archive	Move stale items from Inbox → Archive
Backup vault	Git + ~/Documents/Obsidian-backup/

---

📚 Related Links

• Quartz v4 Documentation
• Cloudflare Pages Dashboard
• 📖 All Documentation

---

Last updated: 2025-02-02