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
129 commits 3 branches 214 tags 490 MiB
JavaScript 97.7%
CSS 1.4%
HTML 0.9%
Find a file
matcornic cd75621517 chore: delete useless folders
2017-08-20 23:43:50 +02:00
archetypes Removed draft from archetype 2017-08-20 23:43:49 +02:00
exampleSite chore: delete useless folders 2017-08-20 23:43:50 +02:00
i18n changed defaults + scroll with offset 2017-08-20 23:43:49 +02:00
images feat: add screenshot and thumbnail images 2016-04-12 02:46:40 +02:00
layouts document HTML way of creting homepage 2017-08-20 23:43:50 +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 feat: add screenshot and thumbnail images 2016-04-12 02:46:40 +02:00
README.md Add warning: the theme is not working with Hugo version 0.22+ 2017-07-22 15:42:28 +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.

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 between 0.19 and 0.21 with hugo version.

From 0.22, Hugo team introduced a long awaited feature: nested sections. As Hugo team deleted some functions on which this theme was based on, this theme fails with current Hugo version. A complete rewrite is needed and is currently under construction. Be aware that this new version will possibly make breaking changes.

Until the v2 is not out yet, feel free to check Docdock, a great fork of hugo-learn-theme by @vjeantet that works and embraces latest features of Hugo!

Overview

Usage

Main functionalities

  • Handle two levels of documentation
  • Tip/Note/Info and Warning boxes
  • Resize images
  • Preview of original image size
  • Add shadow or border on images
  • Automatic table of contents
  • Create buttons (typically used to provide a link to a demo)
  • Search using lunr index
  • Automatic next/prev buttons to navigate through pages

TODO

Troubleshooting

Changes have been made for automatically creating previous and next arrows. These changes restructured the theme and you might have compatibility problems when updating to the latest version of the theme. Please read PR#36 to update your documentation with latest guidelines.

If you don't want to update your documentation, use the git tag 1.0.0

cd themes/hugo-theme-learn
git checkout tags/1.0.0