zola Documentation

File: README.md Copy Chapter

zola (né Gutenberg)

A fast static site generator in a single binary with everything built-in.

To find out more see the Zola Documentation, look
in the docs/content folder of this repository or visit the Zola community forum.

This tool and its template engine tera were born from an intense dislike of the (insane) Golang template engine and therefore of
Hugo that I was using before for 6+ sites.

List of features Copy Chapter

• Single binary
• Syntax highlighting
• Sass compilation
• Assets co-location
• Multilingual site support (Basic currently)
• Image processing
• Themes
• Internal links
• External link checker
• Table of contents automatic generation
• Automatic header anchors
• Aliases
• Pagination
• Custom taxonomies
• Search with no servers or any third parties involved
• Live reload
• Deploy on many platforms easily: Netlify, Vercel, Cloudflare Pages, etc

License Copy Chapter

This project contains code under multiple licenses.

Code introduced after version 0.22 is licensed under the EUPL-1.2.
Code that existed prior to commit 3c9131db0d203640b6d5619ca1f75ce1e0d49d8f remains licensed under the MIT License, including in later versions of the project.

See LICENSE and LICENSE-MIT for details.

File: docs/content/themes/abridge/index.md Copy Chapter

+++
title = "abridge"
description = "A fast and lightweight Zola theme using semantic html, a class-light abridge.css, and No mandatory JS."
template = "theme.html"
date = 2026-08-15T11:29:36-07:00

[taxonomies]
theme-tags = []

[extra]
created = 2026-08-15T11:29:36-07:00
updated = 2026-08-15T11:29:36-07:00
repository = "https://github.com/Jieiku/abridge.git"
homepage = "https://github.com/jieiku/abridge"
minimum_version = "0.23.3"
license = "MIT"
demo = "https://abridge.pages.dev/"

[extra.author]
name = "Jake G (jieiku)"
homepage = "https://github.com/jieiku/"
+++

Features Copy Chapter

• Perfect Lighthouse, YellowLabTools, and Observatory scores.
• PWA support (Progressive Web Application).
• All JavaScript can be fully disabled.
• Dark, Light, Auto, and Switcher themes. (colors can be customized, css variables)
• Code syntax highlighting. (colors can be customized, css variables)
• Numbered code blocks with line highlighting.
• Entirely Offline Site by using the PWA or by setting search_library = "offline" in config.toml.
• Multi-language support.
• Search support. (elasticlunr, pagefind, tinysearch)
• Search Suggestions navigation keys, / focus, arrow move, enter select, escape close.
• Search Results Page, type search query then hit Enter Key or click the search button icon.
• SEO support. (Search Engine Optimization)
• Pagination with numbered paginator on index.
• Title Based Previous and Next Article links at bottom of Article.
• Table of Contents in page Index (Optional, clickable links)
• Recent Posts Block. (Optional)
• Back to Top button. (uses css only)
• Code Blocks copy button.
• Email link in footer obfuscation. (anti-spam)
• KaTeX support.
• Archive page.
• Tags.
• Categories. (similar to Tags, disabled/commented out by default)
• Social icon links in footer.
• Responsive design. (mobile first)
• Video Components: Youtube, Vimeo, Streamable.
• Media Components: video, img, imgswap, image, gif, audio.
• Other Components: showdata, katex.

Complete Documentation is available here

Quick Start Copy Chapter

This theme requires version 0.19.1 or later of Zola

git clone https://github.com/jieiku/abridge.git
cd abridge
zola serve
# open http://127.0.0.1:1111/ in the browser

Installation Copy Chapter

The Quick Start shows how to run the theme directly. Next we will use abridge as a theme to a NEW site.

1: Create a new zola site Copy Section

yes "" | zola init mysite
cd mysite

2: Install Abridge Copy Section

Add the theme as a git submodule:

git init  # if your project is a git repository already, ignore this command
git submodule add https://github.com/jieiku/abridge.git themes/abridge
git submodule update --init --recursive
git submodule update --remote --merge

Or clone the theme into your themes directory:

git clone https://github.com/jieiku/abridge.git themes/abridge

3: Configuration Copy Section

Copy some files from the theme directory to your project's root directory:

rsync themes/abridge/.gitignore .gitignore
rsync themes/abridge/config.toml config.toml
rsync themes/abridge/content/_index.md content/
rsync -r themes/abridge/COPY-TO-ROOT-SASS/* sass/
rsync themes/abridge/netlify.toml netlify.toml
rsync themes/abridge/package_abridge.js package_abridge.js
rsync themes/abridge/package.json package.json

• config.toml base configuration with all config values.
• content/_index.md required to set pagination.
• COPY-TO-ROOT-SASS/abridge.scss overrides to customize Abridge variables.
• netlify.toml settings to deploy your repo with netlfiy.
• package_abridge.js node script to: update cache files list in PWA, minify js, bundle js
• package.json to facilitate use of package_abridge.js

Uncomment the theme line in your project's root config.toml:

sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml

4: Add new content Copy Section

Copy the content from the theme directory to your project or make a new post:

rsync -r themes/abridge/content .

5: Run the project Copy Section

Just run zola serve in the root path of the project:

zola serve

Zola will start the dev web server, accessible by default at http://127.0.0.1:1111.

Saved changes will live reload in the browser. (press ctrl+f5, or while developing set pwa=false in config.toml)

Customization Copy Chapter

For further customization be sure to check the docs.

Sponsor Copy Chapter

Do you love this theme? Was it useful to you? Please leave a github star, and if you feel inclined to donate you can make a donation to me through github sponsors.

Contributing and Philosophy Copy Chapter

We'd love your help! Especially with fixes to issues, or improvements to existing features.

The goal is for Abridge to be lightweight, fast, and to work properly even if javascript is disabled or blocked.

The only feature that may be considered a necessity that relies on javascript is the Search.

License Copy Chapter

Abridge is distributed under the terms of the MIT license.