A beautiful digital garden built with Quartz v4 - a free, open-source alternative to Obsidian Publish.
-
Prerequisites
- Node.js (v18 or later)
- Git
-
Installation
git clone <your-repo-url> cd Quartz-Obsi npm install
-
Development
npx quartz build --serve
Visit
http://localhost:8080
to see your garden!
Quartz-Obsi/
├── content/ # Your markdown content
│ ├── index.md # Home page
│ ├── Getting Started with Quartz.md
│ ├── Digital Gardening Philosophy.md
│ ├── Markdown Tips and Tricks.md
│ └── Publishing Your Garden.md
├── quartz/ # Quartz engine (don't modify)
├── quartz.config.ts # Site configuration
├── quartz.layout.ts # Layout configuration
└── package.json # Dependencies
- 🔗 Bidirectional Links: Connect ideas with
[[wiki-links]]
- 🔍 Full-text Search: Find content across your garden
- 📱 Mobile Responsive: Looks great on all devices
- ⚡ Fast Loading: Static site generation
- 🎨 Customizable: Themes and layouts
- 📊 Graph View: Visualize connections
- 🏷️ Tags: Organize and categorize content
All standard markdown syntax is supported, plus:
- Wiki-style links:
[[Page Name]]
- Tags in frontmatter:
tags: [tag1, tag2]
- Callouts:
> [!info] This is important
- Math equations:
$E = mc^2$
---
tags:
- example
- tutorial
date: 2024-01-15
---
# My Example Note
This is a note that links to [[Another Note]].
> [!tip] Pro Tip
> Use wiki links to connect your ideas!
Edit quartz.config.ts
to customize:
- Site title and description
- Base URL
- Theme colors
- Analytics
- Plugins
Create custom CSS in quartz/styles/custom.scss
- Push to GitHub
- Enable GitHub Pages
- Set up deployment workflow
- Netlify
- Vercel
- Custom hosting
See [[Publishing Your Garden]] for detailed instructions.
Feel free to suggest improvements or report issues!
This project is open source and available under the MIT License.
Happy gardening! 🌿✨