mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 01:33:04 +00:00
A theme for Hugo designed for documentation
781d1e9457
This is useful because using "alt" attribute is generally a good idea. But I had to change this in my project because I am running automated tests and this was causing an error from my over-zealous error-checker robot. Fair enough. |
||
---|---|---|
archetypes | ||
exampleSite | ||
i18n | ||
images | ||
layouts | ||
static | ||
.gitignore | ||
LICENSE.md | ||
README.md | ||
theme.toml | ||
wercker.yml |
Hugo Learn Theme
This repository contains a theme for Hugo, based on great Grav Learn Theme.
Visit the theme documentation to see what is going on. It is actually built with this theme.
Main features
- Automatic Search
- Multilingual mode
- Unlimited menu levels
- Automatic next/prev buttons to navigate through menu entries
- Image resizing, shadow…
- Attachments files
- List child pages
- Mermaid diagram (flowchart, sequence, gantt)
- Customizable look and feel and themes variants
- Buttons, Tip/Note/Info/Warning boxes, Expand
Installation
Navigate to your themes folder in your Hugo site and use the following commands:
$ cd themes
$ git clone https://github.com/matcornic/hugo-theme-learn.git
Check that your Hugo version is minimum 0.25
with hugo version
.
Usage
Download old versions (prior to 2.0.0)
If you need old version for compatibility purpose, either download theme source code from releases or use the right git tag. For example, with 1.1.0
- Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
- Git way:
cd themes/hugo-theme-learn
git checkout tags/1.1.0
For both solutions, the documentation is available at https://github.com/matcornic/hugo-theme-learn/releases/download/1.1.0/hugo-learn-doc-1.1.0.zip
Credits
Many thanks to @vjeantet for the fork docdock. The v2 of this theme is mainly based on his work !