↑ ↓ to navigate
    ↵ to select
    esc to close
    Goyo

    Configuration

    Learn how to configure Goyo.

    Now let's look at the settings for the Goyo theme. It provides various settings to customize the theme. You can use them in config.toml.

    Design & Branding

    logo_text / logo_image_path / logo_image_padding

    • logo_text: Text displayed when no logo image is present.
    • logo_image_path: Path to the logo image.
    • logo_image_padding: Padding applied to the logo image (optional, e.g. "5px").
    [extra]
logo_text = "Goyo"
logo_image_path = "images/goyo.png"
logo_image_padding = "5px"

    footer_html

    • footer_html: HTML code displayed in the footer.
    [extra]
footer_html = "Powered by <a href='https://www.getzola.org'>Zola</a> and <a href='https://github.com/hahwul/goyo'>Goyo</a>"

    The footer displays:

    1. Logo and site name
    2. Powered by text (customizable via footer_html)

    SEO & Social

    Thumbnail

    default_thumbnail

    • default_thumbnail: Path to the default thumbnail image.
    [extra]
default_thumbnail = "images/default_thumbnail.jpg"

    Twitter

    twitter_site / twitter_creator

    • twitter_site: Twitter site handle.
    • twitter_creator: Twitter creator handle.
    [extra]
twitter_site = "@hahwul"
twitter_creator = "@hahwul"

    Google Tag

    gtag

    • gtag: Google Tag ID.
    [extra]
gtag = "G-XXXXXXXXXX"

    Color

    default_colorset

    • default_colorset: Default theme (dark/light).
    [extra]
default_colorset = "dark"

    Font

    custom_font_enabled / custom_font_name / custom_font_path

    • custom_font_enabled: Enable custom font. Set to true to use a custom font instead of the default.
    • custom_font_name: Name of the custom font family (e.g., "Roboto", "Noto Sans KR").
    • custom_font_path: Path to the font file. Can be either:
      • Local path: Relative path to a local font file in the static directory (e.g., "fonts/custom.woff")
      • Remote URL: Full URL to a web font (e.g., "https://fonts.googleapis.com/css2?family=Roboto")

    Default: By default, Goyo uses the Pretendard font, which provides excellent readability for Korean and English text.

    Example - Local Font:

    [extra]
custom_font_enabled = true
custom_font_name = "MyCustomFont"
custom_font_path = "fonts/mycustomfont.woff"

    Example - Google Fonts:

    [extra]
custom_font_enabled = true
custom_font_name = "Roboto"
custom_font_path = "https://fonts.googleapis.com/css2?family=Roboto&display=swap"

    Example - Default (Pretendard):

    [extra]
custom_font_enabled = false  # Uses Pretendard font by default

    Brightness

    brightness

    • brightness: Controls the overall brightness of the theme colors. Options are:
      • "darker": Makes colors darker - dark theme becomes completely black, light theme becomes darker
      • "normal": Default brightness (default value)
      • "lighter": Makes colors lighter - both themes become lighter
    [extra]
brightness = "normal"  # Options: "darker", "normal", "lighter"

    sidebar_expand_depth

    • sidebar_expand_depth: Specifies the depth (up to 5) to which sidebar sections should be expanded by default. For example, a value of 1 will only show top-level sections, while 2 will expand the first level of subsections.
    [extra]
sidebar_expand_depth = 2

    nav / nav_{lang}

    • nav: Top navigation menu. name and icon fields is 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.
    [extra]
# Default navigation (used for English and as fallback)
nav = [
    { name = "Documents", url = "/introduction", type = "url", icon = "fa-solid fa-book" },
    { name = "GitHub", url = "https://github.com/hahwul/goyo", type = "url", icon = "fa-brands fa-github" },
    { 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" },
    ] },
]

# Korean navigation (optional)
nav_ko = [
    { name = "문서", url = "/ko/introduction", type = "url", icon = "fa-solid fa-book" },
    { name = "GitHub", url = "https://github.com/hahwul/goyo", type = "url", icon = "fa-brands fa-github" },
    { name = "링크", type = "dropdown", icon = "fa-solid fa-link", members = [
        { name = "제작자 블로그", url = "https://www.hahwul.com", type = "url", icon = "fa-solid fa-fire-flame-curved" },
    ] },
]

    Language Aliases

    lang_aliases

    • lang_aliases: Custom display names for languages in the language selector dropdown. If not defined, the language code will be displayed. This allows you to show user-friendly names like "English" or "한국어" instead of just "en" or "ko".
    [extra]
# Language display names for the language selector
lang_aliases = { en = "English", ko = "한국어" }

    You can add as many languages as you need:

    [extra]
lang_aliases = {
    en = "English",
    ko = "한국어",
    ja = "日本語",
    id = "Bahasa Indonesia"
}

    Disable Theme Toggle

    disable_theme_toggle

    • disable_theme_toggle: If set to true, the theme toggle button (for switching between dark and light mode) will be hidden from the header.
    [extra]
disable_theme_toggle = true

    Disable Root Sidebar Hide

    disable_root_sidebar_hide

    • disable_root_sidebar_hide: If set to true, the sidebar will not be hidden on the root page (/ or /{lang}/). This allows the sidebar to always be visible, even on the main landing page.
    [extra]
disable_root_sidebar_hide = false

    Content & Sharing

    Edit URL

    edit_url

    • edit_url: Base URL for editing pages. When set, an "Edit this page" link will appear at the bottom of each page/section, linking to the source file in your repository.
    [extra]
edit_url = "https://github.com/hahwul/goyo/edit/main"

    The link will automatically append the relative path of the content file (e.g., content/introduction/_index.md).

    Share Buttons

    enable_copy_url / enable_share_x

    • enable_copy_url: Enable "Copy URL" button at the bottom of each page/section. When clicked, it copies the current page URL to the clipboard and shows a "Copied!" confirmation for 2 seconds.
    • enable_share_x: Enable "Share on X" button at the bottom of each page/section. When clicked, it opens Twitter's sharing dialog with the page URL and title pre-filled.
    [extra]
enable_copy_url = false  # Default is false
enable_share_x = false   # Default is false

    You can enable them individually or both:

    [extra]
enable_copy_url = true   # Enable only Copy URL button
enable_share_x = false   # Keep Share on X disabled

    [extra]
enable_copy_url = true   # Enable both buttons
enable_share_x = true

    Comments

    comments

    • comments: Comment feature settings (giscus/utterances).
    [extra.comments]
enabled = true
system = "giscus"
repo = "hahwul/goyo"
repo_id = "R_kgDOPHnqwg"
category = "General"
category_id = "DIC_kwDOPHnqws4CspmC"
mapping = "pathname"
strict = "0"
reactions_enabled = "1"
emit_metadata = "0"
input_position = "bottom"
theme = "catppuccin_mocha"
lang = "en"
    Edit this page