Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

bunmaska-site

The landing page and docs for Bunmaska — one app, statically rendered. Apple-clean, warm "Maska Gold" accent, hairline borders, zero drop shadows. Tone: funny, dry, allergic to lying (matches the Bunmaska README).

Stack

  • Astro 6 (output: 'static' — every page is server-rendered to HTML at build time)
  • React 19 islands (theme toggle, install tabs — surgical, near-zero JS)
  • Tailwind v4 (@tailwindcss/vite, CSS-first @theme tokens — no tailwind.config.js)
  • MDX content collection for docs
  • Self-hosted fonts: Inter Variable (UI), Instrument Serif (display), Geist Mono (code)
  • Runs on Bun.

Develop

bun install
bun run dev       # http://localhost:4321
bun run build     # static render → ./dist
bun run preview   # serve ./dist

Where things live

  • src/styles/global.css — the entire design system (tokens, light/dark, no-shadow rules).
  • src/pages/index.astro — the landing page (all sections + copy).
  • src/content/docs/** — the docs corpus (markdown). Add a file, add it to src/nav.ts.
  • src/nav.ts — single source of truth for the docs sidebar order + prev/next.
  • src/layouts/Base.astro (shell + theme) and Doc.astro (3-column docs).
  • src/components/ — Nav, Footer, Sidebar, Toc, PrevNext, CodeBlock, Callout, and the two React islands (ThemeToggle.tsx, InstallTabs.tsx).

Adding a docs page

  1. Drop a .md/.mdx file in src/content/docs/ (frontmatter: title, description). Don't write an # H1 — the title comes from frontmatter.
  2. Add its slug + label to the right group in src/nav.ts.

Not yet wired (v1)

Pagefind ⌘K search, an OG image, the real logo, and the deeper API-reference pages.