Getting Started

Quickstart

Install the toolchain, create the six-layout example deck, preview it, and export an editable PPTX.

Requirements

SlideForge runs locally. Prepare the following before you start:

Node.js 24 or newer and npm
Playwright Chromium and its system libraries
Fonts with the glyphs your deck needs, such as Microsoft JhengHei or Noto Sans CJK for Chinese

Install and build

Clone the repository and build it. Skipping the Puppeteer download avoids a second browser; SlideForge launches Playwright's Chromium.

git clone https://github.com/gordonkit/slideforge.git
cd slideforge
PUPPETEER_SKIP_DOWNLOAD=true npm ci
npx playwright install --with-deps chromium
npm run build

Create and preview a deck

init copies the complete example and its image into presentation-assets/ next to the JSON. Preview serves the JSON directory on 127.0.0.1; reload the browser after editing.

node dist/cli/index.js init presentation.json
node dist/cli/index.js build presentation.json --output presentation.html
node dist/cli/index.js preview presentation.json --port 5173

Export and validate

Export fails on layout errors and prints warnings. validate prints a JSON report with the slide count and editable text count.

node dist/cli/index.js export presentation.json --output presentation.pptx
node dist/cli/index.js validate presentation.pptx