Skip to content

Getting Started

Prerequisites

  • Node.js 20+
  • pnpm 10+
  • Git with submodule support

Install and run locally

bash
git clone --depth 1 --recurse-submodules --shallow-submodules https://github.com/prezly/techdocs.git
cd techdocs
pnpm install
pnpm docs:dev

If you already cloned without submodules:

bash
pnpm submodules:init

To pull latest docs from submodules and regenerate aggregated docs:

bash
pnpm docs:pull

Build for production

bash
pnpm docs:build
pnpm docs:preview