nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
A theme for Hugo designed for documentation
156 commits 3 branches 214 tags 490 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
Jean-Christophe 209497b45e Added info about 'draft:true' (#74) 
Not sure it's the best place to go in the documentation, but I thought this might prevent new Hugo user to wonder why no content was listed.
2017-09-27 16:39:42 +02:00
archetypes fix archetype content 2017-08-20 23:43:50 +02:00
exampleSite Added info about 'draft:true' (#74) 2017-09-27 16:39:42 +02:00
i18n i18n of expand shortcode 2017-08-20 23:44:33 +02:00
images new thumbnail for theme 2017-08-20 23:55:18 +02:00
layouts feat: fix #58 - add site param shortcode 2017-09-04 22:24:36 +02:00
static changed defaults + scroll with offset 2017-08-20 23:43:49 +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 Update README.md 2017-08-21 01:30:22 +02:00
theme.toml feat: mermaid #53 + archetypes + move doc + expand 2017-08-20 23:43:45 +02:00
wercker.yml add wercker to compare with travis 2017-08-20 23:43:48 +02:00

README.md

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.

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 !