Getting Started

Installation

Clone the template, install dependencies, and start the dev server.

Requirements

  • Node.js 20.9 or later
  • pnpm 9 or later

Install

Clone the repository and install dependencies:

bash
git clone https://github.com/acme/docs-template.git my-docs
cd my-docs
pnpm install

Develop

Start the development server. The site runs at http://localhost:3000.

bash
pnpm dev

Scripts

CommandDescription
pnpm devStart the dev server with Turbopack.
pnpm buildCreate a production build.
pnpm lintRun ESLint (max 500 lines/file, complexity ≤ 10).
pnpm typecheckType-check with strict TypeScript.
pnpm preflightTypecheck, lint, and build in one pass.

Search documentation

Search pages and jump to a section