67 lines
2.2 KiB
Markdown
67 lines
2.2 KiB
Markdown
|
---
|
|||
|
|
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.146" >}}](https://github.com/gohugoio/hugo/releases/tag/v0.146.7)
|
|||
|
|
[{{< badge style="default" title="License" value="MIT" >}}](https://github.com/alex-shpak/hugo-book/blob/main/LICENSE)
|
|||
|
|
|
|||
|
|
{{<button href="/docs/example">}}Explore{{</button>}}
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
{{% 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.
|
|||
|
|
|
|||
|
|
- ## 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.
|
|||
|
|
{{% /columns %}}
|
|||
|
|
|
|||
|
|
|
|||
|
|
{{% columns %}}
|
|||
|
|
- {{< card >}}
|
|||
|
|
## Probably fast
|
|||
|
|
Build 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.
|
|||
|
|
{{< /card >}}
|
|||
|
|
|
|||
|
|
- {{< card >}}
|
|||
|
|
## Minimalistic
|
|||
|
|
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:
|
|||
|
|
[Columns](/docs/shortcodes/columns/),
|
|||
|
|
[Cards](/docs/shortcodes/experimental/cards/),
|
|||
|
|
[Tabs](/docs/shortcodes/tabs/),
|
|||
|
|
[Images](/docs/shortcodes/experimental/images/),
|
|||
|
|
[Asciinema](/docs/shortcodes/experimental/asciinema/),
|
|||
|
|
[KaTex](/docs/shortcodes/katex/),
|
|||
|
|
[Mermaid](/docs/shortcodes/mermaid/) and others.
|
|||
|
|
{{< /card >}}
|
|||
|
|
|
|||
|
|
- {{< card >}}
|
|||
|
|
### Even more
|
|||
|
|
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.
|
|||
|
|
{{< /card >}}
|
|||
|
|
{{% /columns %}}
|