A theme for Hugo designed for documentation
Find a file
Christopher Greaves 3d854fe9d4 Remove indentation in "children" shortcode
- Fixes a bug where the list items appear in a code block instead of as HTML
2019-04-16 18:45:22 +01:00
archetypes TranslationBaseName replaced for Name on archetypes template 2018-05-27 13:29:39 -04:00
exampleSite Merge branch 'master' of https://github.com/pdelaby/hugo-theme-learn into pdelaby-master 2019-03-25 21:01:40 +00:00
i18n Dutch translation 2019-02-14 13:40:43 +01:00
images [ImgBot] Optimize images 2019-03-15 16:47:53 +00:00
layouts Remove indentation in "children" shortcode 2019-04-16 18:45:22 +01:00
static Update search.js 2019-04-01 22:31:07 +01:00
.editorconfig Add .editorconfig 2019-03-15 16:10:45 +00:00
.gitignore remove link in docs because of error 2017-08-20 23:43:45 +02:00
.grenrc.yml Ship tag 2.2.0 2019-01-28 01:08:48 +00:00
CHANGELOG.md Ship tag 2.2.0 2019-01-28 01:08:48 +00:00
LICENSE.md add @vjeantet to copyright 2017-08-21 01:25:26 +02:00
netlify.toml Set build steps in config 2018-12-21 00:31:13 +00:00
README.md HTTPS link to learn.getgrav.org 2018-12-14 00:08:22 +09:00
theme.toml HTTPS links 2018-12-07 16:14:14 +09: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