Add docs, blog, community pages and polish landing page layout
- Add docs pages (getting-started, changelog, keyboard-shortcuts) - Add blog, community, and legal pages (privacy, terms, EULA) - Add site header, footer, download button, and nav components - Add sitemap and robots.txt generation - Narrow main page container (max-w-2xl), fix footer positioning - Switch README feature list to colon style
This commit is contained in:
parent
5febb66873
commit
f970cdcf33
37 changed files with 3304 additions and 296 deletions
77
web/app/docs/getting-started/page.tsx
Normal file
77
web/app/docs/getting-started/page.tsx
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
import type { Metadata } from "next";
|
||||
import { CodeBlock } from "../../components/code-block";
|
||||
import { Callout } from "../../components/callout";
|
||||
import { DownloadButton } from "../../components/download-button";
|
||||
|
||||
export const metadata: Metadata = {
|
||||
title: "Getting Started",
|
||||
description: "Install and set up cmux on macOS",
|
||||
};
|
||||
|
||||
export default function GettingStartedPage() {
|
||||
return (
|
||||
<>
|
||||
<h1>Getting Started</h1>
|
||||
<p>
|
||||
cmux is a lightweight, native macOS terminal built on Ghostty for
|
||||
managing multiple AI coding agents. It features vertical tabs, a
|
||||
notification panel, and a socket-based control API.
|
||||
</p>
|
||||
|
||||
<h2>Install</h2>
|
||||
|
||||
<h3>DMG (recommended)</h3>
|
||||
<div className="my-4">
|
||||
<DownloadButton />
|
||||
</div>
|
||||
<p>
|
||||
Open the <code>.dmg</code> and drag cmux to your Applications folder.
|
||||
cmux auto-updates via Sparkle, so you only need to download once.
|
||||
</p>
|
||||
|
||||
<h3>Homebrew</h3>
|
||||
<CodeBlock lang="bash">{`brew tap manaflow-ai/cmux
|
||||
brew install --cask cmux`}</CodeBlock>
|
||||
<p>To update later:</p>
|
||||
<CodeBlock lang="bash">{`brew upgrade --cask cmux`}</CodeBlock>
|
||||
|
||||
<Callout>
|
||||
On first launch, macOS may ask you to confirm opening an app from an
|
||||
identified developer. Click <strong>Open</strong> to proceed.
|
||||
</Callout>
|
||||
|
||||
<h2>Verify installation</h2>
|
||||
<p>Open cmux and you should see:</p>
|
||||
<ul>
|
||||
<li>A terminal window with a vertical tab sidebar on the left</li>
|
||||
<li>One initial workspace already open</li>
|
||||
<li>The Ghostty-powered terminal ready for input</li>
|
||||
</ul>
|
||||
|
||||
<h2>CLI setup</h2>
|
||||
<p>
|
||||
cmux includes a command-line tool for automation. Inside cmux terminals
|
||||
it works automatically. To use the CLI from outside cmux, create a
|
||||
symlink:
|
||||
</p>
|
||||
<CodeBlock lang="bash">{`sudo ln -sf "/Applications/cmux.app/Contents/MacOS/cmux" /usr/local/bin/cmux`}</CodeBlock>
|
||||
<p>Then you can run commands like:</p>
|
||||
<CodeBlock lang="bash">{`cmux list-workspaces
|
||||
cmux notify --title "Build Complete" --body "Your build finished"`}</CodeBlock>
|
||||
|
||||
<h2>Auto-updates</h2>
|
||||
<p>
|
||||
cmux checks for updates automatically via Sparkle. When an update is
|
||||
available you'll see an update pill in the titlebar. You can also
|
||||
check manually via <strong>cmux → Check for Updates</strong> in the menu
|
||||
bar.
|
||||
</p>
|
||||
|
||||
<h2>Requirements</h2>
|
||||
<ul>
|
||||
<li>macOS 14.0 or later</li>
|
||||
<li>Apple Silicon or Intel Mac</li>
|
||||
</ul>
|
||||
</>
|
||||
);
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue