Documentation

Current Version: v0.6.1-beta (November 2025) This documentation covers Telar v0.6.1-beta. See the Telar CHANGELOG for release notes.

Welcome to the Telar documentation. This guide will help you create visual narrative exhibitions using IIIF images and scrollytelling.

Getting Started

New to Telar? Start here:

• Quick Start Guide - Choose your workflow and build your first exhibition

Workflows

Telar offers two workflows depending on your needs:

• GitHub Web Interface - No installation required (recommended for storytellers)
• Local Development - For developers who want local preview

Core Concepts

• Content Structure - How Telar organizes your content
• IIIF Integration - Working with images
• Configuration - Site settings and options

Customization

• Themes - Choose or create visual themes
• Advanced Styling - Custom CSS and layouts

Reference

• GitHub Actions - Automated build workflow
• Development - Local development workflow