Docs Documentación

Config Generator and Editor

Fill in your site details to generate a ready-to-use _config.yml file for your Telar site. Your configuration is never sent to any server — everything runs in your browser.

Paste your existing _config.yml below, then click Load to populate the form.

Site Settings

Basic site information and appearance. These are the most important settings for your site.

Your site's display name, shown in the browser tab and navigation header
Used for search engine metadata and social sharing previews
Controls your site's color scheme and visual style
When off, the site title is displayed as text in the navigation header
Place your logo in components/images/. Recommended: max 80px tall, 200–300px wide, PNG/JPG/SVG
Controls all interface elements: navigation, buttons, labels, error messages. Your content stays in whatever language you write it in.

Hosting

Telar is designed to work with GitHub Pages — most users just need their username and repository name.

If you are not using GitHub Pages, turn this off to enter your URL manually.
Do you have a custom domain configured with GitHub Pages? Learn how to set one up
When on, your site serves at the root of your domain. When off, it serves at domain.com/repo-name.
Your site's base domain
Path after domain. Leave empty to serve at the root.

Google Sheets Integration

Manage your content via Google Sheets instead of editing CSV files directly. Telar fetches your data automatically during each build.

When off, Telar uses CSV files from your repository instead — make sure you have them in components/structures/
Share your Google Sheet with "Anyone with the link" (Viewer access)
From File → Share → Publish to web. Both URLs are required.

Story Interface

Control how stories display and behave on your site. These settings affect the story viewer and homepage presentation.

When on, story cards appear on the homepage. Stories are still accessible via navigation when off.
Displays "Step 1", "Step 2", etc. as you scroll through a story. Purely visual.
Displays a dismissable credit badge in the bottom-left corner of story viewers. Credit information still appears in the metadata table either way.
Fetches tutorial stories from the Telar content server. These show a "Demo" badge and help new users explore the interface. Turn off for production sites.

Collection Interface

Control how the objects gallery displays and behaves, including filtering, search, and homepage presentation.

Enables the filter sidebar with facets on the objects page
Displays a "View the objects" link on the homepage
Displays objects marked as featured in your objects.csv on the homepage
Number of objects to show in the homepage sample

Private Stories

Encrypt stories so only viewers with the correct key can access them. Stories with private: yes in your project.csv (or Google Sheets Project tab) will be encrypted during build.

Uses client-side encryption. Prevents casual access but is not suitable for highly sensitive content.
Viewers access protected stories via ?key=your-secret-key
Copied!

Generated _config.yml