https://github.com/hahwul/goyo
A simplicity and clean documentation theme
https://github.com/hahwul/goyo
documentation ssg-theme zola zola-theme
Last synced: 11 months ago
JSON representation
A simplicity and clean documentation theme
- Host: GitHub
- URL: https://github.com/hahwul/goyo
- Owner: hahwul
- License: mit
- Created: 2025-07-06T04:49:01.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-25T01:53:31.000Z (11 months ago)
- Last Synced: 2025-07-30T02:23:32.481Z (11 months ago)
- Topics: documentation, ssg-theme, zola, zola-theme
- Language: JavaScript
- Homepage: https://goyo.hahwul.com
- Size: 30 MB
- Stars: 3
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Features
- Dark & Light Themes
- 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, etc.)
- Customization
## Installation
Make your zola app
```bash
zola init yoursite
cd yoursite
```
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/hahwul/goyo themes/goyo
```
Or clone the theme into your themes directory:
```bash
git clone https://github.com/hahwul/goyo themes/goyo
```
Then set `goyo` as your theme in `config.toml`.
```toml
title = "Your Docs"
theme = "goyo"
```
## Configuration
Add extra field in config.toml
```toml
[extra]
logo_text = "Goyo"
logo_image_path = "images/goyo.png"
footer_html = "Powered by Zola and Goyo"
default_thumbnail = "images/default_thumbnail.jpg"
twitter_site = "@hahwul"
twitter_creator = "@hahwul"
default_colorset = "dark"
gtag = ""
sidebar_expand_depth = 1
disable_root_sidebar_hide = false
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" },
] },
]
```
More information? [https://goyo.hahwul.com/get_started/configuration/](https://goyo.hahwul.com/get_started/configuration/)
## Run
```bash
zola serve
# and open http://localhost:1111 in your browser.
```
