Astro Vault 🌱

A digital garden for your Markdown notes, powered by Astro. Publish with zero friction — then grow progressively into the full power of web development.

🚀 Features

• Extended Markdown Support:
  • ✅ Wikilinks ([[Note]] → /note) for easy note linking.
  • ✅ Image embeds (![[image.png]] → /assets/image.png) for visual content.
  • ✅ Smart Asset Sync: only referenced images copied during build.
• Tech Stack:
  • Astro v5 — static site generation.
  • GitHub Pages — auto-deploy via Actions.
• Progressive Architecture:
  • Start simple: Markdown files in src/pages/ become routes.
  • Grow naturally: Astro's full power (Content Collections, frameworks, islands) is always available when you're ready.

🛠️ Setup

npm install
npm run dev       # Local dev server
npm run build     # Static build
npm run preview   # Preview build output
npm run clean     # Clear caches (if things get weird)

📝 Workflow

1. Write Markdown notes in src/pages/ using your favorite editor (VS Code, Obsidian, iA Writer, etc.).
2. Use Wikilinks ([[Note]]) for linking and image embeds (![[image.png]]) for images.
3. Store images in src/assets/ (only referenced ones are synced).
4. Commit and push — GitHub Actions builds and deploys automatically.

📂 Project Structure

/
├── public/
│   └── assets/         # Auto-generated by sync-assets (git-ignored)
├── src/
│   ├── assets/         # YOUR IMAGES GO HERE
│   ├── integrations/   # Custom Astro Integrations (sync-assets)
│   ├── layouts/        # Page Layouts (BaseLayout.astro)
│   ├── pages/          # YOUR NOTES GO HERE (become routes)
│   ├── plugins/        # Remark plugins (wikilinks, image embeds)
│   └── styles/         # Global CSS
├── docs/               # Project docs (PRODUCT, TECHNICAL, PLANNING)
└── astro.config.mjs    # Astro + plugin configuration

📚 Docs

• PRODUCT.md — Visão, personas, princípios.
• TECHNICAL.md — Arquitetura, ADRs, stack.
• PLANNING.md — Roadmap e tarefas.
• LIMITATIONS.md — Trade-offs conscientes e jornada de progressão.