Telar: Docs Telar: Documentación

Getting Started

Welcome to Telar! This guide will help you create your first visual narrative exhibition.

Before You Begin: Plan Your Narrative

Telar narratives are built around a layered storytelling structure. Understanding this model will help you plan your content effectively.

Each page in your Telar site contains one or more stories, which can be independent or related narratives. Stories unfold through successive steps that show an image (or a detail of an image) alongside a brief text.

The Question/Answer/Invitation Pattern

Each step follows this pattern:

You can provide up to two layer panels in each step to give viewers further information.

Layered Panels

Layer panels are where you can expand on your narrative. They are written in markdown format, allowing you to include:

Planning Your Story

Before you start gathering materials or building your site, take time to sketch out your story’s structure:

  1. What stories do you want to tell?
  2. What are the key moments in each story?
  3. What images or details will anchor each step in the story?
  4. What information belongs in the brief answer and what in the panel layers?

Drafting these answers and panels will make the implementation much easier.

Tip: Get Inspired Browse the example site to see this structure in action.

Choose Your Workflow

Once you’re ready, choose one of the workflows based on your needs:

No installation required. Manage your content entirely through GitHub’s web interface and Google Sheets. Perfect for storytellers and teams.

GitHub Web Interface Guide

Local Development

Best for developers who want to preview changes locally before publishing. Requires Ruby and Python installation.

Local Development Guide