Skip to content

brewwery/docs

Repository files navigation

Brewwery Docs

Documentation site for Brewwery — macOS GUI for Homebrew.

Hosted at docs.brewwery.com.

og-image

Stack

Development

npm install
npm run dev

Open http://localhost:3000.

Build

npm run build

Static output is written to the out/ directory, ready for deployment to any static hosting (Vercel, Cloudflare Pages, Netlify, etc.).

Structure

docs/
├── app/                    # Next.js App Router layout
│   ├── layout.tsx          # Root layout (html, head, body)
│   └── [[...mdxPath]]/    # Catch-all route
│       ├── layout.tsx      # Nextra docs layout (navbar, sidebar, footer)
│       └── page.tsx        # MDX page renderer
├── content/                # MDX documentation pages
│   ├── _meta.ts            # Sidebar navigation order
│   ├── index.mdx           # Introduction
│   ├── getting-started.mdx
│   ├── features.mdx
│   ├── architecture.mdx
│   ├── security.mdx
│   ├── development.mdx
│   ├── roadmap.mdx
│   ├── changelog.mdx
│   ├── faq.mdx
│   └── contributing.mdx
├── public/                 # Static assets
│   └── og-image.png        # Open Graph image for social sharing
├── mdx-components.tsx      # MDX component configuration
├── next.config.mjs         # Next.js + Nextra config
├── tsconfig.json
└── package.json

Deployment

The site exports as fully static HTML. Deploy the out/ directory to any static hosting provider with a custom domain pointing to docs.brewwery.com.

Repository

github.com/brewwery/docs

License

MIT