Astro Vault 🌱

A Digital Garden template powered by Astro and Obsidian. Designed to publish your notes as a static website with zero friction.

🚀 Features

• Obsidian Integration:
  • ✅ Wikilinks support ([[Note]] -> /vault/note).
  • ✅ Local Images support (![[image.png]] -> /vault-images/image.png).
  • ✅ Auto-Sync: Images are automatically copied to public/vault-images during build.
• Tech Stack:
  • Astro v5 (Content Layer API).
  • Tailwind CSS (Planned).
  • GitHub Pages (Auto-deploy via Actions).
• Architecture:
  • Source of Truth: src/content/vault (Your Obsidian Vault).
  • Build Output: Static HTML/CSS.

🛠️ Setup

1. Install Dependencies:

   npm install

2. Run Development Server:

   npm run dev

3. Clean Cache (if things get weird):

   npm run clean

📝 Workflow

1. Write your notes in Obsidian inside src/content/vault.
2. Use standard Wikilinks and drag-and-drop images.
3. Commit and Push to GitHub.
4. GitHub Actions will build and deploy your site automatically.

📂 Project Structure

/
├── public/
│   └── vault-images/  # Generated by sync-assets (Ignored by Git)
├── src/
│   ├── content/
│   │   └── vault/     # YOUR NOTES GO HERE
│   ├── integrations/  # Custom Astro Integrations (Sync)
│   ├── layouts/       # Page Layouts
│   ├── pages/         # Astro Routes
│   ├── plugins/       # Remark/Rehype Plugins
│   └── styles/        # Global CSS
└── astro.config.mjs   # Configuration