mirror of
https://github.com/thegeeklab/hugo-geekdoc.git
synced 2024-11-24 13:50:40 +00:00
Robert Kaussow
282294d4ab
BREAKING CHANGE: The min required Hugo version was bumped to v0.124 to drop deprecated vars `.Site.IsMultiLingual` and `.Site.Social`. For more details, see [#862](https://github.com/thegeeklab/hugo-geekdoc/pull/862).
64 lines
2.3 KiB
Markdown
64 lines
2.3 KiB
Markdown
---
|
|
title: Welcome to the documentation
|
|
geekdocNav: false
|
|
geekdocAlign: center
|
|
geekdocAnchor: false
|
|
---
|
|
|
|
<!-- markdownlint-capture -->
|
|
<!-- markdownlint-disable MD033 -->
|
|
|
|
<span class="badge-placeholder">[](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)</span>
|
|
<span class="badge-placeholder">[](https://gohugo.io)</span>
|
|
<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>
|
|
<span class="badge-placeholder">[](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 >}}
|