Alex Shpak
67 lines
1.9 KiB
Markdown
67 lines
1.9 KiB
Markdown
---
|
||
layout: landing
|
||
---
|
||
|
||
<br />
|
||
|
||
# Hugo Book {anchor=false}
|
||
{{% columns %}}
|
||
- Documentation theme for [Hugo](https://gohugo.io) as simple as plain book.
|
||
|
||
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 {anchor=false}
|
||
Built on Hugo static site generator. "The world’s fastest framework for building websites".
|
||
{{< /card >}}
|
||
|
||
- {{< card >}}
|
||
### 50% JS free {anchor=false}
|
||
All important features are working even with JavaScript disabled in the browser, including interactive shortcodes.
|
||
{{< /card >}}
|
||
|
||
- {{< card >}}
|
||
### 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 {anchor=false}
|
||
Pretty good shortcodes are included to enhance content:
|
||
[Columns](/docs/shortcodes/columns/),
|
||
[Cards](/docs/shortcodes/experimental/cards/),
|
||
[Tabs](/docs/shortcodes/tabs/),
|
||
[Images](/docs/shortcodes/experimental/images/),
|
||
[Asciinema](/docs/shortcodes/asciinema/),
|
||
[KaTex](/docs/shortcodes/katex/),
|
||
[Mermaid](/docs/shortcodes/mermaid/) and others.
|
||
{{< /card >}}
|
||
|
||
- {{< card >}}
|
||
### 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 {anchor=false}
|
||
There are multiple points to inject own styles and templates to make it your own.
|
||
{{< /card >}}
|
||
{{% /columns %}}
|