f36525f5f1
- Add Fumadocs-based docs site (docs-site/) - Document all features: tabs, notifications, splits, socket API, CLI - Add Claude Code hooks guide with cmuxterm detection - Update README with native macOS emphasis and brew install - Add homebrew-cmuxterm to .gitignore (has its own repo)
1.1 KiB
1.1 KiB
cmuxterm Documentation
Documentation website for cmuxterm, 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
- Create a new
.mdxfile incontent/docs/ - Add frontmatter with title and description
- Add the page to
content/docs/meta.json
Example:
---
title: My Page
description: Description of my page
---
# My Page
Content here...