hugo-book
Code Issues

Big documentation rewrite, move docs to example site

Browse Source
This commit is contained in:
Alex Shpak
2026-05-16 23:04:27 +02:00
parent bcce6e25c3
commit c59c9192a8
54 changed files with 1219 additions and 3162 deletions
Download Patch File Download Diff File Expand all files Collapse all files
exampleSite/content.en/_index.md
+26 -26
View File
@@ -1,50 +1,50 @@
---
title: ""
layout: landing
---
<div class="book-hero">
# HUGO BOOK {anchor=false}
[Hugo](https://gohugo.io) documentation theme as simple as plain book
[{{< badge style="info" title="Hugo" value="0.158" >}}](https://github.com/gohugoio/hugo/releases/tag/v0.158.0)
[{{< badge style="default" title="License" value="MIT" >}}](https://github.com/alex-shpak/hugo-book/blob/main/LICENSE)
{{<button href="/docs/example">}}Explore{{</button>}}
</div>
<br />
# Hugo Book {anchor=false}
{{% columns %}}
- ## What Hugo-Book Theme Is
Hugo book theme is primarily designed to create technical documentation sites that are easy to read, write, navigate and maintain. It is an attempt to create a sustainable web project.
- Documentation theme for [Hugo](https://gohugo.io) as simple as plain book.
- ## What Hugo-Book Theme Is Not
Book theme is not trying to implement all features but to create a starting point. It is mostly feature complete and gets updated and improved to stay relevant with Hugo and modern web.
Hugo-Book theme is designed to be easy to read, write, navigate and maintain.
It is an attempt to create a sustainable web project.
{{<button href="/docs/introduction">}}Explore{{</button>}}
- ```shell
# TL;DR
git clone https://github.com/alex-shpak/hugo-book-starter documentation
cd documentation
git submodule update --init --remote
hugo server --minify
```
{{% /columns %}}
<br />
{{% columns %}}
- {{< card >}}
## Probably fast
Build on Hugo static site generator. "The world’s fastest framework for building websites".
### Probably fast {anchor=false}
Built on Hugo static site generator. "The world’s fastest framework for building websites".
{{< /card >}}
- {{< card >}}
## 50% JS free
All important features are working even with JavaScript disabled in browser, including interactive shortcodes.
### 50% JS free {anchor=false}
All important features are working even with JavaScript disabled in the browser, including interactive shortcodes.
{{< /card >}}
- {{< card >}}
## Minimalistic
### Minimalistic {anchor=false}
For real, it is very minimalistic, black on white. No extra tools are needed to build the site, only Hugo. No heavy JS or CSS frameworks included.
{{< /card >}}
{{% /columns %}}
{{% columns %}}
- {{< card >}}
### Shortcodes
Pretty good shortcodes are included to enhance markup files:
### Shortcodes {anchor=false}
Pretty good shortcodes are included to enhance content:
[Columns](/docs/shortcodes/columns/),
[Cards](/docs/shortcodes/experimental/cards/),
[Tabs](/docs/shortcodes/tabs/),
@@ -55,12 +55,12 @@ layout: landing
{{< /card >}}
- {{< card >}}
### Even more
### Even more {anchor=false}
Do people actually read these? I thought it was just a visual filler. But there is full-text search and multi-language support.
{{< /card >}}
- {{< card >}}
### Made to be extendable
There are multiple points to inject own styles and templates to make your documentation your own.
### Made to be extendable {anchor=false}
There are multiple points to inject own styles and templates to make it your own.
{{< /card >}}
{{% /columns %}}