veka — Astro Starter Template

SHA-256: b7a0fd9deda49277e21c31877cf85d7fbc6836821fb75667d727196cefae4070

2026-10-02T20:19:06.636Z

# 🌲 Veka

**The Minimalist Digital Garden & Wiki Starter for Astro.**

Veka is not a competitor to massive documentation frameworks. It is the antithesis. Built specifically for those who want a fast, organic place to take notes — a digital garden or personal wiki — free from rigid routing configuration.

Drop your Markdown files into the folder, and let the system weave them together automatically.

![Astro](https://img.shields.io/badge/Astro-3.0+-FF7E33?style=flat-square&logo=astro&logoColor=white)
![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-v4-38B2AC?style=flat-square&logo=tailwind-css&logoColor=white)
![Pagefind](https://img.shields.io/badge/Search-Pagefind-blue?style=flat-square)

![Veka Dashboard Preview](./public/preview-home.png)
![Note Preview](./public/preview-note.png)
![Note Preview](./public/preview-note-2.png)

Production demo available at [demo-veka.khoirul.me](https://demo-veka.khoirul.me) or [wiki.khoirul.me](https://wiki.khoirul.me)

---

## ⚡ Why Veka?

- **Zero-Config Routing:** No need to register navigation in a config file. Create folders as deep as you like (e.g. `src/content/wiki/koding/arsitektur/`), and URLs with sidebar navigation are generated automatically.
- **Ultra-Fast Static Search:** Powered by [Pagefind](https://pagefind.app/). Search is indexed locally during the build process — no third-party services required.
- **Zod Schema Validation:** Frontmatter is strictly validated. No more build errors from a missing title or incorrectly formatted date.
- **"Digital Garden" Concept:** Comes with a `growthStage` property (`seedling`, `budding`, `evergreen`) to track the maturity level of each note.
- **100% Lighthouse Score:** The UI is built selectively using minimal components and vanilla JS for interactivity, ensuring zero runtime bloat.

---

## 🚀 Quick Start (Under 1 Minute)

Run these commands in your terminal to clone the template and start a local server:

```bash
# 1. Clone this repository (or use degit)
pnpm dlx degit masmuss/veka my-wiki

# 2. Enter the directory
cd my-wiki

# 3. Install dependencies
pnpm install

# 4. Start the local server
pnpm run dev
```

Important Note for Search Features: Pagefind search works by reading the static build output. To test search locally, you must run npm run build followed by npm run preview.

## 📝 How to Write Notes

All your notes live in the `src/content/wiki/` directory. Feel free to create new sub-directories. Every `.md` or `.mdx` file must include the following frontmatter:

```plaintext
---
title: "Your Note Title"
description: "Brief description for SEO and search snippets."
createdAt: 2026-07-05
updatedAt: 2026-07-05
tags: ["concept", "idea"]
isPinned: false
growthStage: "seedling" # Options: seedling | budding | evergreen
---

Write your thoughts here using Markdown...
```

## 🏗️ Project Structure

```plaintext
├── src/
│   ├── components/
│   │   ├── seo/             # Seo.astro, JsonLd.astro
│   │   └── shell/           # BaseHead.astro, Header.astro
│   ├── content/
│   │   ├── config.ts        # Zod schema validation
│   │   └── wiki/            # Your markdown files and folders
│   ├── layouts/
│   │   ├── BaseLayout.astro # HTML shell, delegates head to BaseHead
│   │   └── WikiLayout.astro # 3-Column Grid (Nav, Content, TOC)
│   ├── lib/
│   │   ├── seo.ts           # Title/description normalization & canonical URL
│   │   └── site-config.ts   # Site-wide configuration (name, URL, OG image, etc.)
│   └── pages/
│       ├── index.astro      # Dashboard / Home
│       └── wiki/
│           └── [...slug].astro # Dynamic routing engine
└── astro.config.mjs
```

## ⚙️ Configuration

Edit `src/lib/site-config.ts` to customize your site identity. All fields are used for SEO meta tags, Open Graph, and JSON-LD structured data.

```ts
export const SITE = {
  name: "Veka", // Site name (used in <title> suffix & og:site_name)
  title: "Veka", // Default page title
  description: "Minimalist Digital Garden", // Fallback meta description
  author: "Veka", // JSON-LD author
  url: "https://veka-9tg.pages.dev", // Canonical base URL
  image: "/og-image.png", // Default Open Graph image
  favicon: "/favicon.svg", // Favicon path
};
```

SEO features (auto-generated per page):

- `<title>` normalization — appends `" | Veka"` if not present, truncates at 60 chars
- Description normalization — enforces 120–160 character range
- Open Graph tags (`og:title`, `og:description`, `og:image`, `og:type`, `og:url`, `og:site_name`)
- Twitter Card tags (`twitter:card`, `twitter:title`, `twitter:description`, `twitter:image`)
- Canonical URL — strips hash and trailing slash
- JSON-LD structured data — `WebSite` for all pages, `Article` for wiki notes (with `datePublished`, `dateModified`, `keywords`)
- Article metadata — `article:published_time`, `article:modified_time`, `article:tag` for wiki pages

## 🌍 Deployment

Veka is configured as a Static Site Generator (SSG) by default. Deployment is seamless on platforms like Vercel, Netlify, or Cloudflare Pages.
Make sure your build command on the target platform is set to: `pnpm run build`
This command will automatically run `astro build` and trigger the pagefind integration to build the search index.