Vidkit Docs

Documentation site for Vidkit, built with Nextra Docs Theme.

Prerequisites

• Node.js 18+
• pnpm (or npm / yarn)

Setup

pnpm install

Scripts

Command	Description
pnpm dev	Start dev server (Turbopack)
pnpm build	Build for production
pnpm start	Serve production build

Project structure

• app/ – App Router pages and layout (layout.tsx, page.mdx, get-started/page.mdx)
• components/ – Shared MDX components used in docs
• mdx-components.tsx – MDX component provider (required by Nextra)
• next.config.ts – Next.js + Nextra config

Editing docs

• Add or edit .mdx files under app/ for new pages.
• Use frontmatter for sidebarTitle, icon, and other Nextra metadata.
• Sidebar order is controlled by app/_meta.global.ts.

Deploying to Vercel

This project uses pnpm 10 (see packageManager in package.json). On Vercel, enable Corepack so the correct pnpm version is used:

• Build Command: corepack enable pnpm && pnpm install && pnpm run build

Or in Project Settings → Environment Variables, set ENABLE_EXPERIMENTAL_COREPACK=1 and use the default install/build.

License

MIT