module

Sunstone::Docs::A_GETTING_STARTED::Quickstart

Quickstart Guide

Executive Summary & Key Topics

Topic Method / Anchor Description
Installation & Setup .topic_01_installation How to install Sunstone or compile it from source.
Creating Your First Presentation .topic_02_creating_deck Scaffolding a new presentation project with sunstone new.
Previewing and Building Slides .topic_03_preview_and_build Live local preview and static production compilation.

Class methods

topic_01_installation

Installation & Setup: How to install Sunstone or compile it from source.

Clone the Sunstone repository or install via shards:

git clone https://github.com/sol-vin/sunstone.git
cd sunstone
shards install
crystal build src/sunstone.cr -o bin/sunstone
Source
topic_02_creating_deck

Creating Your First Presentation: Scaffolding a new presentation project with sunstone new.

To scaffold a new presentation deck:

sunstone new my-talk --title "High-Performance Systems" --author "Jane Doe"
cd my-talk

This creates:

  • deck.yml: Deck configuration and slide order.
  • slides/: Starter slides showcasing intro, two-column code, and closing layouts.
  • custom.css: Optional custom styling overrides.
  • .github/workflows/deploy.yml: Ready-to-go GitHub Pages automated deployment.
Source
topic_03_preview_and_build

Previewing and Building Slides: Live local preview and static production compilation.

To launch a live local preview server with automatic browser launch:

sunstone serve

To compile static production HTML and Markdown files:

sunstone build --out dist
Source