Getting Started

Get up and running with StarryKit in minutes.

Getting Started with StarryKit

Welcome to StarryKit! This guide will help you get set up quickly.

Prerequisites

  • Node.js 18 or later
  • npm or pnpm

Installation

Starry Slides

npm install -g @starrykit/slides

Create Your First Project

starry-slides create my-presentation
cd my-presentation
starry-slides serve

This will start a local dev server at http://localhost:3000.

Project Structure

my-presentation/
├── slides/
│   ├── 01-intro.html
│   ├── 02-content.html
│   └── 03-conclusion.html
├── assets/
│   └── images/
├── starry.config.js
└── package.json

Next Steps