Features

• Dark & Light Themes with Brightness Settings
• Beautiful Landing Page
• Responsive Design
• SEO-Friendly
• Multi-Language Support
• Auto-Generated Sidebar & Custom Nav
• Built-in resources (FontAwesome, Mermaid.js)
• Comments (Giscus, Utterances)
• Various shortcodes (Mermaid, Asciinema, Katex, Alert, Badge, etc.)
• Customization

Installation

Make your zola app

zola init yoursite
cd yoursite

Add the theme as a git submodule:

git init # if your project is a git repository already, ignore this command
git submodule add -b trankwilo https://codeberg.org/salif/trankwilo themes/trankwilo

Or clone the theme into your themes directory:

git clone https://codeberg.org/salif/trankwilo themes/trankwilo

Then set trankwilo as your theme in config.toml.

title = "Your Docs"
theme = "trankwilo"

Configuration

Add extra field in config.toml

[extra]
# Logo Configuration
logo_text = "Trankwilo" # Text to display if no logo image
logo_image_path = "images/trankwilo.webp" # Path to logo image
logo_image_padding = "5px" # Padding for logo image (optional)
# Footer Configuration
footer_html = """
Powered by <a href="https://www.getzola.org">Zola</a> and <a href="https://codeberg.org/salif/trankwilo">Trankwilo</a>
"""
# Thumbnail Configuration
default_thumbnail = "images/default_thumbnail.webp" # Default thumbnail image path
# Twitter Configuration
twitter_site = "@username" # Site Twitter handle
twitter_creator = "@username" # Creator Twitter handle
# Color Configuration
brightness = "normal" # Options: "darker", "normal", "lighter"
# Google Tag Configuration
gtag = "" # Google Analytics tracking ID
# Sidebar Configuration
sidebar_expand_depth = 1 # Sidebar expansion depth (max 5)
# Language Aliases Configuration
# Custom display names for languages in the language selector
# If not defined, language codes will be displayed
lang_aliases = { en = "English", ko = "한국어" }
# Navigation Configuration
nav = [
 { name = "Documents", url = "/introduction", type = "url", icon = "fa-solid fa-book" },
 { name = "Source", url = "https://codeberg.org/salif/trankwilo", type = "url", icon = "fa-brands fa-git-alt" },
 { name = "Links", type = "dropdown", icon = "fa-solid fa-link", members = [
 { name = "Creator Blog", url = "https://www.hahwul.com", type = "url", icon = "fa-solid fa-fire-flame-curved" }
 ] }
]
# Navigation Configuration (i18n / optional)
# `nav_{lang}`: Language-specific navigation menu (e.g., `nav_ko` for Korean).
# If defined, it will be used instead of the default `nav` for that language.
nav_ko = [
 { name = "문서", url = "/ko/introduction", type = "url", icon = "fa-solid fa-book" },
 { name = "소스", url = "https://codeberg.org/salif/trankwilo", type = "url", icon = "fa-brands fa-git-alt" },
 { name = "링크", type = "dropdown", icon = "fa-solid fa-link", members = [
 { name = "제작자 블로그", url = "https://www.hahwul.com", type = "url", icon = "fa-solid fa-fire-flame-curved" },
 ] },
]
# Theme Toggle Configuration
disable_theme_toggle = false # Hide theme toggle button (true to disable)
# Sidebar Visibility Configuration
disable_root_sidebar_hide = false # Prevent hiding sidebar on root page
# Edit URL Configuration
edit_url = "" # Base URL for editing pages (e.g., "https://github.com/user/repo/edit/main")
# Comments Configuration
[extra.comments]
enabled = false # Enable comments
system = "" # Comment system (e.g., "giscus")
repo = "" # Repository for comments (e.g., "salif/trankwilo")
repo_id = "" # Repository ID (e.g., "R_kgDOXXXXXXX")
category = "" # Comment category (e.g., "General")
category_id = "" # Category ID (e.g., "DIC_kwDOXXXXXXXXXX")

More information? Configuration - Trankwilo Documents and Creating Landing - Trankwilo Documents

Run

zola serve
# and open http://127.0.0.1:1111 in your browser.

Other Zola themes

Trankwilo is based on Goyo and is one of several Zola themes I maintain. Other themes include:

• Linkita – Multilingual and SEO friendly blog theme.
• Tukan – Inspired from Toucan theme.