Configuración

Configura tu sitio de Telar mediante el archivo _config.yml en la raíz de tu repositorio.

Ajustes básicos

title: Título de tu Narrativa
description: Una breve descripción de tu exposición narrativa
baseurl: "/nombre-repositorio"  # Para un subdirectorio en GitHub Pages
url: "https://usuario.github.io"
author: Tu Nombre
email: tu-email@ejemplo.com

baseurl vs. url

  • url: Dominio base de tu sitio
  • baseurl: Ruta después del dominio (usa "" para el dominio raíz, o /nombre-repo para GitHub Pages)

Ejemplos:

# Subdirectorio en GitHub Pages
url: "https://usuario.github.io"
baseurl: "/sitio-telar"
# Resultado: https://usuario.github.io/sitio-telar

# Dominio personalizado en la raíz
url: "https://misitio.org"
baseurl: ""
# Resultado: https://misitio.org

Integración con Google Sheets

Configura Google Sheets para gestionar el contenido:

google_sheets:
  enabled: true
  shared_url: "https://docs.google.com/spreadsheets/d/TU_ID_HOJA_CALCULO/edit?usp=sharing"
  published_url: "https://docs.google.com/spreadsheets/d/e/TU_ID_PUBLICADO/pub?output=csv"

Cómo obtener tus URLs

URL Compartida:

  1. Haz clic en el botón Share en Google Sheets
  2. Establece en “Anyone with the link (Viewer)”
  3. Copia la URL

URL Publicada:

  1. FileSharePublish to web
  2. Haz clic en Publish
  3. Copia la URL

Importante Ambas URLs son necesarias. La URL compartida sirve para visualización; la URL publicada, para la obtención automatizada.

Selección de Tema

Telar incluye 4 temas predefinidos:

telar_theme: "paisajes"  # Opciones: paisajes, neogranadina, santa-barbara, austin

Temas disponibles

  • paisajes (predeterminado): Tonos tierra con terracota y oliva
  • neogranadina: Burdeos colonial y dorado
  • santa-barbara: Turquesa y coral modernos
  • austin: Naranja quemado y azul pizarra

Consulta Personalización: Temas para ver detalles y cómo crear temas personalizados.

Configura la navegación del sitio:

# Mostrar/ocultar secciones
show_objects: true
show_glossary: true
show_about: true

Colecciones

Las colecciones Jekyll están preconfiguradas para historias, objetos y glosario:

collections:
  stories:
    output: true
    permalink: /stories/:name/
  objects:
    output: true
    permalink: /objects/:name/
  glossary:
    output: true
    permalink: /glossary/:name/

Nota Normalmente no necesitas modificar la configuración de colecciones, a menos que estés haciendo una personalización avanzada.

Ajustes de construcción

Configuración estándar de construcción de Jekyll:

markdown: kramdown
permalink: pretty
exclude:
  - Gemfile
  - Gemfile.lock
  - scripts/
  - components/
  - README.md

Plugins

Plugins necesarios:

plugins:
  - jekyll-seo-tag

Se instalan automáticamente cuando ejecutas bundle install.

Ejemplo completo

Aquí hay un ejemplo completo de _config.yml:

title: Textiles Coloniales
description: Una exposición de textiles de la era colonial de las Américas
baseurl: "/textiles-coloniales"
url: "https://usuario.github.io"
author: Jane Smith
email: jane@ejemplo.com

telar_theme: "paisajes"

google_sheets:
  enabled: true
  shared_url: "https://docs.google.com/spreadsheets/d/ABC123/edit?usp=sharing"
  published_url: "https://docs.google.com/spreadsheets/d/e/XYZ789/pub?output=csv"

show_objects: true
show_glossary: true
show_about: true

collections:
  stories:
    output: true
    permalink: /stories/:name/
  objects:
    output: true
    permalink: /objects/:name/
  glossary:
    output: true
    permalink: /glossary/:name/

markdown: kramdown
permalink: pretty

plugins:
  - jekyll-seo-tag

exclude:
  - Gemfile
  - Gemfile.lock
  - scripts/
  - components/
  - README.md

Próximos pasos

Última actualización:

Back to top

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