Chirpy: Getting Started
Get started with Chirpy basics in this comprehensive overview. You will learn how to install, configure, and use your first Chirpy-based website, as well as deploy it to a web server.
This area brings together two things:
If you are creating or editing content for this site, this is where you should start.
If you’re a content author and want to just dive in, refer to the Authors Guide
Chirpy provides the foundation: how to create posts, manage front matter, insert images, embed media, configure previews, and control layout. If you are new to the theme, begin with:
These documents explain the core conventions that everything else builds on.
The StoryKit documentation then shows you how to go beyond standard posts — adding interactive image viewers, maps, comparisons, and other embedded components using simple Markdown and Liquid include tags.
A complete list of documents is found in the Guides section below.
Most content authors do not need to understand HTML, CSS, or JavaScript.
If you are comfortable writing basic Markdown and copying small snippets of example code, you have all the technical background required.
The goal of these extensions is to let you create rich, visual essays without needing to think about implementation details.
If something doesn’t work, it is usually one of three issues:
The examples in these docs are meant to be directly reusable.
Think of Chirpy as the publishing engine. Think of StoryKit as a set of specialized tools you can plug into that engine.
You don’t need to understand how those tools are built — only how to use them correctly.
This section exists to make that straightforward.
Get started with Chirpy basics in this comprehensive overview. You will learn how to install, configure, and use your first Chirpy-based website, as well as deploy it to a web server.
Examples of text, typography, math equations, diagrams, flowcharts, pictures, videos, and more.
This tutorial will guide you how to write a post in the Chirpy template, and it’s worth reading even if you’ve used Jekyll before, as many features require specific variables to be set. Naming and...
The favicons of Chirpy are placed in the directory assets/img/favicons/. You may want to replace them with your own. The following sections will guide you to create and replace the default favicons...
An introduction to StoryKit — a Markdown-first framework for adding interactive viewers and text-driven media interactions to a Jekyll + Chirpy site. This overview explains StoryKit origins, how it fits into the existing architecture, and how it is enabled and configured for individual posts.
A guide for configuring the StoryKit Preview Tool. The tool uses a bookmarklet and GitHub token, enabling one-click live preview of any post directly from GitHub's file browser.
A practical guide for writing, previewing, and publishing StoryKit posts entirely through GitHub’s web interface. It explains how GitHub rebuilds sites after commits, how the live preview tool bypasses that delay for rapid iteration, and how to correctly structure front matter, media folders, and asset references.
Tips for formatting StoryKit posts.
How to create rich information popups using Wikidata entities in StoryKit.
How to use the StoryKit image viewer in your Markdown posts.
How to use the StoryKit Image Compare viewer in your Markdown posts.
How to use the StoryKit map viewer in your Markdown posts.
How to use the StoryKit YouTube viewer in your Markdown posts.