2020-01-12 14:33:02 +00:00
---
2021-05-18 22:00:57 +00:00
title: Welcome to the documentation
2021-05-18 21:10:42 +00:00
geekdocNav: false
2021-05-18 22:00:57 +00:00
geekdocAlign: center
2021-05-21 13:51:19 +00:00
geekdocAnchor: false
2020-01-12 14:33:02 +00:00
---
2020-09-19 10:23:14 +00:00
<!-- markdownlint - capture -->
<!-- markdownlint - disable MD033 -->
2023-08-25 10:37:28 +00:00
< span class = "badge-placeholder" > [](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)< / span >
2024-08-27 07:56:12 +00:00
< span class = "badge-placeholder" > [](https://gohugo.io)< / span >
2020-09-27 20:21:29 +00:00
< span class = "badge-placeholder" > [](https://github.com/thegeeklab/hugo-geekdoc/releases/latest)< / span >
< span class = "badge-placeholder" > [](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)< / span >
2021-04-11 13:11:59 +00:00
< span class = "badge-placeholder" > [](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)< / span >
2020-09-19 10:23:14 +00:00
<!-- markdownlint - restore -->
2020-01-14 23:46:40 +00:00
2021-04-22 20:07:09 +00:00
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.
2020-01-14 23:46:40 +00:00
2021-05-21 13:51:19 +00:00
{{< button size = "large" relref = "usage/getting-started/" > }}Getting Started{{< / button > }}
2021-05-18 21:10:42 +00:00
2021-05-21 13:51:19 +00:00
## Feature overview
2020-01-12 14:33:02 +00:00
2021-05-18 21:10:42 +00:00
{{< 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 > }}
