---
title: Welcome to the documentation
geekdocNav: false
geekdocAlign: center
geekdocAnchor: false
---

<!-- markdownlint-capture -->
<!-- markdownlint-disable MD033 -->

<span class="badge-placeholder">[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)</span>
<span class="badge-placeholder">[![Hugo Version](https://img.shields.io/badge/hugo-0.112-blue.svg)](https://gohugo.io)</span>
<span class="badge-placeholder">[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/releases/latest)</span>
<span class="badge-placeholder">[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)</span>
<span class="badge-placeholder">[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)</span>

<!-- markdownlint-restore -->

Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of got alternatives out there.

{{< button size="large" relref="usage/getting-started/" >}}Getting Started{{< /button >}}

## Feature overview

{{< columns >}}

### Clean and simple design

Stay focused on exploring the content and don't get overwhelmed by a complex design.

<--->

### Light and mobile-friendly

The theme is powered by less than 1 MB and looks impressive on mobile devices as well as on a regular Desktop.

<--->

### Easy customization

The look and feel can be easily customized by CSS custom properties (variables), features can be adjusted by Hugo parameters.

{{< /columns >}}

{{< columns >}}

### Zero initial configuration

Getting started in minutes. The theme is shipped with a default configuration and works out of the box.

<--->

### Handy shortcodes

We included some (hopefully) useful custom shortcodes so you don't have to and can focus on writing amazing docs.

<--->

### Dark mode

Powerful dark mode that detects your system preferences or can be controlled by a toggle switch.

{{< /columns >}}
