zola/docs/content/themes/lightspeed/index.md

+++ title = "lightspeed" description = "Zola theme with a perfect Lighthouse score" template = "theme.html" date = 2024-09-02T05:58:27Z

[extra] created = 2024-09-02T05:58:27Z updated = 2024-09-02T05:58:27Z repository = "https://github.com/carpetscheme/lightspeed.git" homepage = "https://github.com/carpetscheme/lightspeed" minimum_version = "0.10.0" license = "MIT" demo = "https://quirky-perlman-34d0da.netlify.com/"

[extra.author] name = "El Carpet" homepage = "https://github.com/carpetscheme" +++

Light Speed

An insanely fast and performance-based Zola theme, ported from Light Speed Jekyll.

Some fun facts about the theme:

• Perfect score on Google's Lighthouse audit
• Only ~700 bytes of CSS
• No JavaScript
• Now with SEO!

Demo: quirky-perlman-34d0da.netlify.com

---

Contents

• Installation
• Options
  • Title
  • Footer menu
  • SEO
  • Footer text
  • Sass
• Original
• License

Installation

First download this theme to your themes directory:

$ cd themes
$ git clone https://github.com/carpetscheme/lightspeed.git

and then enable it in your config.toml:

theme = "lightspeed"

Posts should be placed directly in the content folder.

To sort the post index by date, enable sort in your index section content/_index.md:

sort_by = "date"

Options

Title

Set a title and description in the config to appear in the site header:

title = "Different strokes"
description = "for different folks"

Footer-menu

Set a field in extra with a key of footer_links:

[extra]

footer_links = [
    {url = "$BASE_URL/about", name = "About"},
    {url = "$BASE_URL/atom.xml", name = "RSS"},
    {url = "https://google.com", name = "Google"},
]

If you put $BASE_URL in a url, it will automatically be replaced by the actual site URL.

Create pages such as $BASE_URL/about by placing them in a subfolder of the content directory, and specifying the path in the frontmatter:

path = "about"

SEO

Most SEO tags are populated by the page metadata, but you can set the author and for the og:image tag provide the path to an image:

[extra]

author = "Grant Green"
ogimage = "Greenery.png"

Footer-text

By default the footer provides links to Zola and Netlify, and a tagline of "Maintained with ❤️ for the web". To disable any of those parts, and/or add a custom tagline of your own, the following options are available:

[extra]

zola = true
netlify = false
maintained_with_love = false
footer_tagline = "What if everything is an illusion and nothing exists? In that case, I definitely overpaid for my carpet."

Sass

Styles are compiled from sass and imported inline to the header ⚡

You can overide the styles by enabling sass compilation in the config:

compile_sass = true

...and placing a replacement style.scss file in your sass folder.

Original

This template is based on the Jekyll template Light Speed Jekyll by Bradley Taunt.

License

Open sourced under the MIT license.

This project is open source except for example articles found in content.