A theme for Hugo designed for documentation
Find a file
Mathieu Cornic d646239c37
Merge pull request #180 from matcornic/feat/fix179
fix #179: replace github images ressource by https instead of http
2018-10-10 19:30:37 +02:00
archetypes TranslationBaseName replaced for Name on archetypes template 2018-05-27 13:29:39 -04:00
exampleSite fix #179: replace github images ressource by https instead of http 2018-10-10 19:29:55 +02:00
i18n Add indonesian translation 2018-09-12 19:20:34 +07:00
images new thumbnail for theme 2017-08-20 23:55:18 +02:00
layouts Update 404.html 2018-09-20 17:04:16 +01:00
static feat: update font-awesome to 5.2.0 2018-08-10 11:17:47 +02:00
.gitignore remove link in docs because of error 2017-08-20 23:43:45 +02:00
LICENSE.md add @vjeantet to copyright 2017-08-21 01:25:26 +02:00
README.md Use status badge from Wercker 2018-08-10 11:29:11 +02:00
theme.toml feat: mermaid #53 + archetypes + move doc + expand 2017-08-20 23:43:45 +02:00
wercker.yml Fix/wercker (#178) 2018-10-10 19:14:04 +02:00

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.

wercker status FOSSA Status

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.

Overview

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

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 !

License

FOSSA Status