3.4 KiB

Raw Permalink Blame History

+++ title = "zola-folio" description = "A fork of the Jekyll *folio theme to zola" template = "theme.html" date = 2024-12-31T14:02:39-06:00

[taxonomies] theme-tags = []

[extra] created = 2024-12-31T14:02:39-06:00 updated = 2024-12-31T14:02:39-06:00 repository = "https://github.com/evjrob/zola-folio" homepage = "https://github.com/evjrob/zola-folio" minimum_version = "0.19.2" license = "MIT" demo = "https://zola-folio.pages.dev/"

[extra.author] name = "Everett Robinson" homepage = "http://everettsprojects.com" +++

*folio

*folio is a Zola theme forked from the original Jekyll theme by Lia Boegev.

Live Demo

Features

Menu bar
Social links
Tags
MathJax
Search
Customizable color
SEO tags
Multi-language support

Installation

In the git repo of your zola site:

Add the theme as a git submodule:

git submodule add https://github.com/evjrob/zola-folio themes/zola-folio
git submodule update --init --recursive
git submodule update --remote --merge

Or clone the theme directly into your themes directory:

git clone https://github.com/evjrob/zola-folio themes/zola-folio

Then set theme = "zola-folio" in your config.toml file. You can now test the theme locally by running zola serve in the terminal and navigating to the localhost URL displayed by the command.

Configuration

Items in the top menu bar can be controlled with the extra.menu_items setting in config.toml:

menu_items = [
    {name = "about", url = "/pages/about"},
    {name = "projects", url = "/pages/projects"},
    {name = "photography", url = "/pages/photography"},
]

If you have an about page, you can add social contact links using the extra.socials setting in the frontmatter of the page:

+++
title = "about"
template = "about.html"
[extra]
socials = [
	{name = "email", uri = "mailto:you@example.com"},
	{name = "github", uri = "https://github.com"},
	{name = "instagram", uri = "https://www.instagram.com/"},
	{name = "bluesky", uri = "https://bsky.app/"}
]
+++

MathJax

MathJax can be enabled by setting extra.math in config.toml:

[extra]
math = true

Example.

Search

Search using elasticlunr.js:

default_language = "en"
build_search_index = true

[search]
include_title = true
include_description = true
include_path = true
include_content = true
index_format = "elasticlunr_json"

Customizable Colors

Simply set the extra.theme_color in the config.toml:

[extra]
theme_color = "red"|"blue"|"green"|"purple"

If the existing colors are not to your liking, then you can create your own by adding a sass/color/custom.scss file with the following:

:root {
    --theme-color: #ffffff;
    --theme-color-light: #ffffff;
}

Then set theme_color = "custom".

SEO Tags

The typical <meta> tags including Open Graph and Twitter are automatically set for posts using the information in the frontmatter of each post. To ensure an image is set for Open Graph and Twitter cards, please ensure the frontmatter contains the extra.feature_image value:

[extra]
feature_image = "my_image.ext"

3.4 KiB Raw Permalink Blame History