module

Sunstone::Docs

The Sunstone::Docs module is the authoritative technical reference and documentation guide.

Learning Tracks & Topic Index

The documentation is paced into 4 distinct tracks:

1. Getting started (A_GETTING_STARTED)

Submodule Title Description
Introduction Introduction to Sunstone An overview of Sunstone, its architecture, and the philosophy of zero-inline-style presentations.
Quickstart Quickstart Guide Get started building and presenting slides with Sunstone in minutes.

2. Authoring (B_AUTHORING)

Submodule Title Description
DeckManifest Deck Manifest Specification Comprehensive guide to authoring deck.yml and configuring presentation-wide settings.
Layouts Semantic Slide Layouts Catalog of all 15 semantic slide layouts supported by Sunstone.

3. Theming (C_THEMING)

Submodule Title Description
Themes Themes & Theme-Scoped Palettes How Sunstone themes, palettes, and CSS custom properties work.
ZeroInlineStyles Zero Inline Styles Architecture Technical guide to how Sunstone implements zero inline styles using semantic CSS and pseudo-elements.

4. Deployment (D_DEPLOYMENT)

Submodule Title Description
CiCd Continuous Integration & GitHub Pages Automating slide compilation and web publishing via GitHub Actions.

Class methods

topic_01_quick_start

Quick-Start Commands: Essential commands for building, running, and testing.

Sunstone Commands:

shards install
crystal spec
crystal docs
bin/sunstone --help
Source
topic_02_reading_paths

Learning Tracks & Reading Paths: Curated reading order from beginner to advanced.

Structured Learning Tracks

1. Getting started (A_GETTING_STARTED)
  • A_GETTING_STARTED::Introduction: Introduction to Sunstone — An overview of Sunstone, its architecture, and the philosophy of zero-inline-style presentations.
  • A_GETTING_STARTED::Quickstart: Quickstart Guide — Get started building and presenting slides with Sunstone in minutes.
2. Authoring (B_AUTHORING)
  • B_AUTHORING::DeckManifest: Deck Manifest Specification — Comprehensive guide to authoring deck.yml and configuring presentation-wide settings.
  • B_AUTHORING::Layouts: Semantic Slide Layouts — Catalog of all 15 semantic slide layouts supported by Sunstone.
3. Theming (C_THEMING)
  • C_THEMING::Themes: **Themes & Theme-Scoped Palettes** — How Sunstone themes, palettes, and CSS custom properties work.
  • C_THEMING::ZeroInlineStyles: Zero Inline Styles Architecture — Technical guide to how Sunstone implements zero inline styles using semantic CSS and pseudo-elements.
4. Deployment (D_DEPLOYMENT)
  • D_DEPLOYMENT::CiCd: **Continuous Integration & GitHub Pages** — Automating slide compilation and web publishing via GitHub Actions.
Source
topic_03_table_of_contents

Master Table of Contents: Complete hierarchical topic index.

Complete Documentation Index

A_GETTING_STARTED
  • A_GETTING_STARTED::Introduction: Introduction to Sunstone — An overview of Sunstone, its architecture, and the philosophy of zero-inline-style presentations.
  • A_GETTING_STARTED::Quickstart: Quickstart Guide — Get started building and presenting slides with Sunstone in minutes.
B_AUTHORING
  • B_AUTHORING::DeckManifest: Deck Manifest Specification — Comprehensive guide to authoring deck.yml and configuring presentation-wide settings.
  • B_AUTHORING::Layouts: Semantic Slide Layouts — Catalog of all 15 semantic slide layouts supported by Sunstone.
C_THEMING
  • C_THEMING::Themes: **Themes & Theme-Scoped Palettes** — How Sunstone themes, palettes, and CSS custom properties work.
  • C_THEMING::ZeroInlineStyles: Zero Inline Styles Architecture — Technical guide to how Sunstone implements zero inline styles using semantic CSS and pseudo-elements.
D_DEPLOYMENT
  • D_DEPLOYMENT::CiCd: **Continuous Integration & GitHub Pages** — Automating slide compilation and web publishing via GitHub Actions.
Source

Nested types