Skip to content

Repository files navigation

WisdomCompiler

A free, open library of spiritual wisdom — books, teachers, and 600+ curated quotes — published as a static site from an Obsidian vault.

Live site: wisdomcompiler.com

What This Is

WisdomCompiler is a curated collection of spiritual resources spanning Advaita Vedanta, Sufism, Christianity, Sikhism, Zen, and other traditions of inner inquiry. Each book page includes a link to read the full text online for free where available.

Built with Quartz v4 on top of an Obsidian vault. Content is authored in Obsidian, built to static HTML by Quartz, and deployed to Cloudflare Pages.

Content Structure

content/
  Books/                  # 30+ spiritual texts with curated passages and free reading links
    index.md              # Books landing page (customizes folder listing)
    Ashtavakra Gita.md    # Individual book pages with [[wikilinks]] to quote notes
    ...
  Teachers/               # Teacher pages (Ramana Maharshi, etc.) with passage links
  Wisdom Quotes/          # Landing page for quotes collection
    index.md
  Screenshots/            # Raw quote data — hidden from site navigation
    Notes/                # 650+ transcribed quote notes (.md files)
    Images/               # 654 source images (photos of book pages)
  YouTube/                # Video teachings (draft — not yet published)
  Websites/               # Spiritual website directory (draft — not yet published)
  index.md                # Homepage

How quotes work: Each quote is a markdown note in Screenshots/Notes/ with a source field linking it to a book or teacher. Book and teacher pages contain [[wikilinks]] to these notes. Quartz resolves them using shortest-path matching.

Draft control: Any file with draft: true in frontmatter is excluded from the published site. The Screenshots/ folder is hidden from the Explorer sidebar via a custom filterFn in quartz.layout.ts, but its pages are still built for link resolution.

Build Pipeline

Prerequisites

  • Node.js (for Quartz and Wrangler)
  • Python (for the book-link generation script)
  • Cloudflare account with wrangler authenticated

Local Development

# Preview the site locally (builds + serves at http://localhost:8080)
npx quartz build --serve

Full Build & Deploy

# 1. (Optional) Regenerate book/teacher passage links from screenshot notes
python scripts/generate-book-links.py

# 2. Build the site (~50-60 seconds, outputs to public/)
npx quartz build

# 3. Deploy to Cloudflare Pages
npx wrangler pages deploy public --project-name=wisdom-compiler --commit-dirty=true --branch=v4

One-liner:

npx quartz build && npx wrangler pages deploy public --project-name=wisdom-compiler --commit-dirty=true --branch=v4

If you get Cloudflare auth errors:

unset CF_API_TOKEN && unset CLOUDFLARE_API_TOKEN

Git Workflow

Single branch: v4. Push to origin/v4:

git add <files> && git commit -m "description" && git push origin v4

Note: The .github/workflows/ CI files are inherited from upstream Quartz and gated for jackyzha0/quartz — they do not run on this fork.

Key Files

File Purpose
production/WORKFLOW.md Full human workflow: editing, publishing, adding content
quartz.config.ts Site config: title, base URL, theme colors, plugins
quartz.layout.ts Page layout: Explorer filter, sidebar components, RandomQuote placement
quartz/styles/custom.scss Custom CSS: mobile responsiveness, touch targets, text wrapping
quartz/styles/variables.scss Breakpoints ($mobile: 800px, $desktop: 1200px), grid layouts
quartz/components/RandomQuote.tsx Random wisdom quote component (shown on homepage only)
quartz/components/scripts/randomquote.inline.ts 149 vault-sourced quotes with randomization logic
scripts/generate-book-links.py Scans screenshot notes, regenerates passage lists on book/teacher pages
scripts/generate-quotes.py Extracts quotes from vault for the RandomQuote component
production/ai/SESSION-*.md AI-assisted development session notes
production/templates/NEW-BOOK.md Template and guide for adding a new book page
production/templates/NEW-TEACHER.md Template and guide for adding a new teacher page
production/QUOTE-DESIGN-DOC.md Design spec for wisdom quote file structure

Customization Details

Explorer Filtering

The sidebar Explorer hides certain folders via filterFn in quartz.layout.ts:

filterFn: (node) => {
  const name = node.name?.toLowerCase()
  if (!name) return true
  const excluded = ["tags", "screenshots", "social-media", "lakshmi the cow", "about"]
  return !excluded.includes(name)
}

The optional chaining (node.name?.) is required — some Quartz tree nodes have undefined names.

Mobile Responsiveness

All mobile CSS lives in quartz/styles/custom.scss inside @media all and ($mobile). Key rules:

  • overflow-x: hidden on html/body/.page to prevent horizontal scroll
  • word-break: break-word on article content and links
  • 44px touch targets for sidebar and footer links
  • Scaled-down headings for small screens

Theme

Warm, parchment-inspired color scheme (see quartz.config.ts theme section):

  • Light mode: cream background (#faf8f0), brown accents (#8b5e3c)
  • Dark mode: deep brown (#1a1510), gold accents (#c49a6c)

Hosting

  • Platform: Cloudflare Pages
  • Project name: wisdom-compiler
  • Branch: v4
  • Domain: wisdomcompiler.com

Built On

About

A living library of spiritual wisdom — guiding seekers to gurus, scriptures, and free resources

Resources

Code of conduct

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages