Docs

Getting started

Create a deck with your package runner

Start an independent presentation project with npx, pnpm, Yarn 2+, or Bun.

Terminal

$ npx open-slidex@latest init my-deck $ cd my-deck $ npm run dev

Start blank or use an official template

The initializer creates a separate project and opens its local Workspace at /workspace. To begin with an official deck, add --template summer-time-report or --template moodboard; add --locale zh-TW for Traditional Chinese content.

Use pnpm dlx, yarn dlx, or bunx in place of npx, then run pnpm dev, yarn dev, or bun run dev inside the generated project. You can also install the CLI globally with npm install --global open-slidex@latest, then run open-slidex init my-deck.

Keep each deck contained

The project's ignored open-slidex-workspace/ directory holds your deck folders. Each deck owns its presentation.tsx source, assets, and exports; generated Workbench source and dependency cache stay in .open-slidex/.