fuma-tui

The TUI-styled documentation template for your Obsidian vault.

Built on Fumadocs + Next.js. Styled like a terminal. Read by AI agents.

What you get

Drop your Obsidian vault into public/vault/ → ship to Vercel.

• 🔗 Wikilink graph — d3-force simulation + minimap
• 🤖 AI-friendly — llms.txt / llms-full.txt / llms.mdx endpoints
• 🖥️ Terminal aesthetic — VT323, CRT scanlines, zero border-radius, Utopia fluid scale
• ✅ Team-ready — Biome, rumdl, Vale, custom linters, git pre-commit hooks
• 🎨 One-config rebrand — site.config.ts → accent, logos, OG, scrollbars auto-derived
• ⚡ Zero env vars — deploy to Vercel as-is
• 📋 Spec-driven — every component has a SPEC.md; AI agents develop against specs, not assumptions

Quickstart

pnpm install
bash scripts/setup.sh
pnpm dev

Rebranding

Edit site.config.ts at the repo root. One file controls everything:

• Site name, description, GitHub repo link
• Accent color → every themed element derived automatically
• Logos, favicon, OG brand text

See TEMPLATE_SETUP.md for the full guide. For writing entries, see CONTRIBUTING.md.

Specs

Root: SPEC.md — master spec (stack, layout, scripts, frontmatter, constraints).

Per-component specs in specs/:

• CONTENT — Obsidian vault, source configuration, math rendering
• STYLING — Terminal/TUI theme
• GRAPH — Interactive wikilink graph + minimap
• DEPLOYMENT — Vercel, dependencies, LLM endpoints
• SEARCH — ZBSearch full-text search (no env vars required)
• OG — OG image generation (next/og, dark TUI style)
• SKILLS — Agent skills registry

---