Telar

Versión en español abajo | English version

A minimal-computing framework for creating layered IIIF visual narratives for digital scholarship, public exhibitions, community storytelling, and classroom projects.

---

Full Documentation | Example Site | Report Issues

---

⚠️ Beta Release - v0.6.2-beta This is a beta release for testing and feedback. For detailed documentation, visit telar.org/docs.

Warning: If upgrading from v0.3.4 or earlier, see the Upgrading Telar Guide for instructions.

Overview

Telar (Spanish for "loom") is a static site generator built on Jekyll that weaves together IIIF images, narrative text, and layered contextual information into interactive visual narrative exhibitions. It follows minimal computing principles: plain text authoring, static generation, and sustainable hosting.

Telar is developed by Adelaida Ávila, Juan Cobo Betancourt, Santiago Muñoz, and students and scholars at the UCSB Archives, Memory, and Preservation Lab, the UT Archives, Mapping, and Preservation Lab, and Neogranadina.

We gratefully acknowledge the support of the Caribbean Digital Scholarship Collective, the Center for Innovative Teaching, Research, and Learning (CITRAL) at the University of California, Santa Barbara, the UCSB Library, the Routes of Enslavement in the Americas University of California MRPI, and the Department of History of The University of Texas at Austin.

Key Features

• IIIF integration: Support for both local images (auto-generated tiles) and external IIIF resources with automatic metadata extraction
• Scrollytelling: Discrete step-based scrolling with support for multiple IIIF objects in a single story - each object preloaded in its own viewer card
• Interactive widgets: Carousel, tabs, and accordion components for rich content presentation
• Layered panels: Progressive disclosure with three content layers plus glossary auto-linking
• Multilingual UI: Complete interface support for English and Spanish
• Objects gallery: Browsable object grid with detail pages
• Minimal computing: Plain text, static generation, GitHub Pages hosting

---

Quick Start

For comprehensive step-by-step guides, see the full documentation site. This Quick Start provides the essential steps to get your site running—detailed workflows and advanced topics are covered in the docs.

Before You Begin

Plan your narrative structure before building. Sketch out your stories, identify key moments, choose anchor images, and decide what information belongs in brief answers versus deeper layers. Browse the example site for inspiration.

Setup Steps

1. Create your repository

   • Click the green "Use this template" button above
   • Name your repository and create it

2. Choose your content management approach

   • Google Sheets (recommended): Use our template to manage content via spreadsheet
   • CSV files: Edit CSV files directly in your repository

3. Add your content

   • Upload images to components/images/ or use IIIF manifests from institutions
   • Create markdown files in components/texts/stories/ for your narrative text
   • Configure your objects and stories in Google Sheets or CSV files

4. Enable GitHub Pages

   • Go to repository Settings → Pages
   • Set source to GitHub Actions
   • Save and wait 2-5 minutes for deployment

5. Configure and customize

   • Edit _config.yml to set your site title and theme
   • For Google Sheets: Add your sheet URLs to the google_sheets section
   • View your site at https://[username].github.io/[repository]/

---

Documentation

For comprehensive guides and references, visit telar.org/docs:

• Workflows: GitHub Web Interface, Local Development, Upgrading
• Content Structure: Organizing your content
• IIIF Integration: Working with images
• Configuration: Site settings and themes
• Customization: Themes and styling
• Reference: GitHub Actions, CSV Schemas

---

License

MIT License - see LICENSE file for details.

Note: This license covers the Telar framework code and documentation. It does NOT cover user-created content (stories, images, object metadata, narrative text) which remains the property of content creators and may have separate licenses.

Credits

Telar is developed by Adelaida Ávila, Juan Cobo Betancourt, Santiago Muñoz, and students and scholars at the UCSB Archives, Memory, and Preservation Lab, the UT Archives, Mapping, and Preservation Lab, and Neogranadina.

Telar is built with:

• Jekyll - Static site generator
• UniversalViewer - IIIF viewer
• Bootstrap 5 - CSS framework
• iiif-static - IIIF tile generator

It is based on Paisajes Coloniales, and inspired by:

• Wax - Minimal computing for digital exhibitions
• CollectionBuilder - Static digital collections

Support

• Documentation: telar.org/docs
• Report Issues: GitHub Issues
• Example Site: ampl.clair.ucsb.edu/telar

---

---

Español

Versión en español | English version above

Un marco de computación mínima para crear narrativas visuales con capas de texto e imágenes IIIF para humanidades digitales, exposiciones públicas y contextos educativos y comunitarios.

---

Documentación completa | Sitio de ejemplo | Reportar problemas

---

⚠️ Versión Beta - v0.6.2-beta Esta es una versión beta para pruebas y retroalimentación. Para documentación detallada, visita telar.org/guia.

Advertencia: Si estás actualizando desde v0.3.4 o anterior, consulta la Guía de Actualización de Telar para obtener instrucciones.

Descripción general

Telar es un generador de sitios estáticos construido sobre Jekyll que entreteje imágenes IIIF, texto narrativo e información contextual en capas en exhibiciones narrativas visuales interactivas. Sigue los principios de computación mínima: autoría en texto plano, generación estática y alojamiento sostenible.

Telar es desarrollado por Adelaida Ávila, Juan Cobo Betancourt, Santiago Muñoz, y estudiantes e investigadores en el UCSB Archives, Memory, and Preservation Lab, el UT Archives, Mapping, and Preservation Lab, y Neogranadina.

Agradecemos el apoyo del Caribbean Digital Scholarship Collective, el Center for Innovative Teaching, Research, and Learning (CITRAL) de la University of California, Santa Barbara, la UCSB Library, el Routes of Enslavement in the Americas University of California MRPI, y el Department of History of The University of Texas at Austin.

Características principales

• Integración IIIF: Soporte para imágenes locales con teselas (tiles) generadas automáticamente y recursos IIIF externos con extracción automática de metadatos
• Scrollytelling: Desplazamiento basado en pasos discretos con soporte para múltiples objetos IIIF en una sola historia - cada objeto precargado en su propia tarjeta de visualización
• Widgets interactivos: Componentes de carrusel, pestañas y acordeón para presentar contenido de forma más rica
• Paneles en capas: Despliegue progresivo con tres capas de contenido más enlace automático del glosario
• Interfaz multilingüe: Soporte completo de interfaz para inglés y español
• Galería de objetos: Cuadrícula navegable de objetos con páginas de detalle
• Computación mínima: Texto plano, generación estática, alojamiento en GitHub Pages

---

Inicio rápido

Para guías paso a paso completas, consulta el sitio de documentación completo. Este inicio rápido proporciona los pasos esenciales para poner en marcha tu sitio—los flujos de trabajo detallados y temas avanzados están cubiertos en la documentación.

Antes de comenzar

Planifica tu estructura narrativa antes de construir. Esboza tus historias, identifica momentos clave, elige imágenes ancla y decide qué información pertenece a respuestas breves versus capas más profundas. Explora el sitio de ejemplo para inspirarte.

Pasos de configuración

1. Crea tu repositorio

   • Haz clic en el botón verde Use this template arriba
   • Nombra tu repositorio y créalo

2. Elige tu enfoque de gestión de contenido

   • Google Sheets (recomendado): Usa nuestra plantilla para gestionar contenido vía hoja de cálculo
   • Archivos CSV: Edita archivos CSV directamente en tu repositorio

3. Añade tu contenido

   • Sube imágenes a components/images/ o usa manifiestos IIIF de instituciones
   • Crea archivos markdown en components/texts/stories/ para tu texto narrativo
   • Configura tus objetos e historias en Google Sheets o archivos CSV

4. Habilita GitHub Pages

   • Ve a Settings → Pages del repositorio
   • Establece la fuente como GitHub Actions
   • Guarda y espera 2-5 minutos para el despliegue

5. Configura y personaliza

   • Edita _config.yml para establecer el título y tema de tu sitio
   • Para Google Sheets: Añade las URLs de tus hojas a la sección google_sheets
   • Visualiza tu sitio en https://[usuario].github.io/[repositorio]/

---

Documentación

Para guías y referencias completas, visita telar.org/guia:

• Flujos de trabajo: Interfaz web de GitHub, Desarrollo local, Actualizar
• Estructura de contenido: Organizar tu contenido
• Integración IIIF: Trabajar con imágenes
• Configuración: Ajustes del sitio y temas
• Personalización: Temas y estilos
• Referencia: GitHub Actions, Esquemas CSV

---

Licencia

Licencia MIT - consulta el archivo LICENSE para más detalles.

Nota: Esta licencia cubre el código del marco Telar y la documentación. NO cubre el contenido creado por usuarios (historias, imágenes, metadatos de objetos, texto narrativo) que permanece como propiedad de los creadores de contenido y puede tener licencias separadas.

Créditos

Telar es desarrollado por Adelaida Ávila, Juan Cobo Betancourt, Santiago Muñoz, y estudiantes e investigadores en el UCSB Archives, Memory, and Preservation Lab, el UT Archives, Mapping, and Preservation Lab, y Neogranadina.

Telar está construido con:

• Jekyll - Generador de sitios estáticos
• UniversalViewer - Visor IIIF
• Bootstrap 5 - Marco CSS
• iiif-static - Generador de teselas IIIF

Está basado en Paisajes Coloniales, e inspirado por:

• Wax - Computación mínima para exhibiciones digitales
• CollectionBuilder - Colecciones digitales estáticas

Soporte

• Documentación: telar.org/guia
• Reportar problemas: GitHub Issues
• Sitio de ejemplo: ampl.clair.ucsb.edu/telar