## File: README.md # zola (né Gutenberg) [](https://dev.azure.com/getzola/zola/_build/latest?definitionId=1&branchName=master) A fast static site generator in a single binary with everything built-in. To find out more see the [Zola Documentation](https://www.getzola.org/documentation/getting-started/overview/), look in the [docs/content](docs/content) folder of this repository or visit the [Zola community forum](https://zola.discourse.group). This tool and its template engine [tera](https://keats.github.io/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 - [Single binary](https://www.getzola.org/documentation/getting-started/cli-usage/) - [Syntax highlighting](https://www.getzola.org/documentation/content/syntax-highlighting/) - [Sass compilation](https://www.getzola.org/documentation/content/sass/) - Assets co-location - [Multilingual site support](https://www.getzola.org/documentation/content/multilingual/) (Basic currently) - [Image processing](https://www.getzola.org/documentation/content/image-processing/) - [Themes](https://www.getzola.org/documentation/themes/overview/) - [Internal links](https://www.getzola.org/documentation/content/linking/) - [External link checker](https://www.getzola.org/documentation/getting-started/cli-usage/#check) - [Table of contents automatic generation](https://www.getzola.org/documentation/content/table-of-contents/) - Automatic header anchors - [Aliases](https://www.getzola.org/documentation/content/page/#front-matter) - [Pagination](https://www.getzola.org/documentation/templates/pagination/) - [Custom taxonomies](https://www.getzola.org/documentation/templates/taxonomies/) - [Search with no servers or any third parties involved](https://www.getzola.org/documentation/content/search/) - [Live reload](https://www.getzola.org/documentation/getting-started/cli-usage/#serve) - Deploy on many platforms easily: [Netlify](https://www.getzola.org/documentation/deployment/netlify/), [Vercel](https://www.getzola.org/documentation/deployment/vercel/), [Cloudflare Pages](https://www.getzola.org/documentation/deployment/cloudflare-pages/), etc ## License 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 +++ 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 - Perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.pages.dev), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://developer.mozilla.org/en-US/observatory/analyze?host=abridge.pages.dev) scores. - [PWA support](https://abridge.pages.dev/overview-abridge/#pwa-progressive-web-app) (Progressive Web Application). - All JavaScript can be [fully disabled](https://abridge.pages.dev/overview-abridge/#javascript-files). - Dark, Light, Auto, and Switcher themes. (colors can be customized, css variables) - Code [syntax highlighting](https://abridge.pages.dev/overview-code-blocks/). (colors can be customized, css variables) - Numbered code blocks with [line highlighting](https://abridge.pages.dev/overview-code-blocks/#toml). - Entirely Offline Site by using the PWA **or** by setting `search_library = "offline"` in `config.toml`. - Multi-language support. - Search support. ([elasticlunr](https://abridge.pages.dev/), [pagefind](https://abridge-pagefind.pages.dev/), [tinysearch](https://abridge-tinysearch.pages.dev/)) - 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](https://abridge.pages.dev/overview-abridge/#seo-and-header-tags) support. (Search Engine Optimization) - [Pagination](https://abridge.pages.dev/overview-abridge/#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](https://katex.org/) support. - [Archive page](https://abridge.pages.dev/archive/). - [Tags](https://abridge.pages.dev/tags/). - Categories. (similar to Tags, disabled/commented out by default) - Social icon links in footer. - Responsive design. (mobile first) - Video Components: [Youtube](https://abridge.pages.dev/video-streaming-sites/overview-embed-youtube/), [Vimeo](https://abridge.pages.dev/video-streaming-sites/overview-embed-vimeo/), [Streamable](https://abridge.pages.dev/video-streaming-sites/overview-embed-streamable/). - Media Components: [video](https://abridge.pages.dev/overview-rich-content/#video), [img](https://abridge.pages.dev/overview-images/#img-component), [imgswap](https://abridge.pages.dev/overview-images/#imgswap-component), [image](https://abridge.pages.dev/overview-rich-content/#image), [gif](https://abridge.pages.dev/overview-rich-content/#gif), [audio](https://abridge.pages.dev/overview-rich-content/#audio). - Other Components: [showdata](https://abridge.pages.dev/overview-showdata/), [katex](https://abridge.pages.dev/overview-math/#usage-1). **[Complete Documentation is available here](https://abridge.pages.dev/overview-abridge/)** ## Quick Start This theme requires version 0.19.1 or later of [Zola](https://www.getzola.org/documentation/getting-started/installation/) ```bash git clone https://github.com/jieiku/abridge.git cd abridge zola serve # open http://127.0.0.1:1111/ in the browser ``` ## Installation 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 ```bash yes "" | zola init mysite cd mysite ``` ### 2: Install Abridge Add the theme as a git submodule: ```bash 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: ```bash git clone https://github.com/jieiku/abridge.git themes/abridge ``` ### 3: Configuration Copy some files from the theme directory to your project's root directory: ```bash 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: ```bash sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml ``` ### 4: Add new content Copy the content from the theme directory to your project or make a new post: ```bash rsync -r themes/abridge/content . ``` ### 5: Run the project Just run `zola serve` in the root path of the project: ```bash 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 For further customization be sure to [check the docs](https://abridge.pages.dev/overview-abridge/). ## Sponsor 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](https://github.com/sponsors/Jieiku/). ## Contributing and Philosophy 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 **Abridge** is distributed under the terms of the [MIT license](https://github.com/jieiku/abridge/blob/master/LICENSE).