cmux/docs-site
Lawrence Chen 2db074b03b
Bump version to 1.25.0 (#33)
Fix blank terminal on macOS 26 and macOS 15:
- Add macOS 26 guard to two additional code paths that set window non-opaque
- Fix NSVisualEffectView z-order: add to themeFrame instead of contentView
- Align sidebarBlendMode defaults between @AppStorage and UserDefaults
- Add read_screen socket command and blank screen regression test
- Add reloads.sh staging script
2026-02-11 16:24:31 -08:00
..
app Release v1.23.0 (#31) 2026-02-09 15:30:43 -08:00
content/docs Bump version to 1.25.0 (#33) 2026-02-11 16:24:31 -08:00
lib Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
public Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
.gitignore Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
next.config.mjs Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
package-lock.json Release v1.23.0 (#31) 2026-02-09 15:30:43 -08:00
package.json Release v1.23.0 (#31) 2026-02-09 15:30:43 -08:00
postcss.config.mjs Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
README.md Release v1.23.0 (#31) 2026-02-09 15:30:43 -08:00
source.config.ts Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
tailwind.config.ts Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
tsconfig.json Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00
vercel.json Add documentation site and Homebrew installation 2026-01-29 04:41:39 -08:00

cmux Documentation

Documentation website for cmux, built with Fumadocs and Next.js.

Development

# Install dependencies
npm install

# Start dev server
npm run dev

Open http://localhost:3000 to view the docs.

Deployment

This site is deployed to Vercel. Push to main to trigger a deployment.

Manual Deploy

npm run build
npx vercel --prod

Structure

docs-site/
├── app/                  # Next.js app router
│   ├── docs/            # Documentation pages
│   └── page.tsx         # Landing page
├── content/
│   └── docs/            # MDX documentation files
└── lib/
    └── source.ts        # Fumadocs source configuration

Adding Documentation

  1. Create a new .mdx file in content/docs/
  2. Add frontmatter with title and description
  3. Add the page to content/docs/meta.json

Example:

---
title: My Page
description: Description of my page
---

# My Page

Content here...