A theme for Hugo designed for documentation
Find a file
Sören Weber 862f981f0c
Docs
2021-07-01 10:22:39 +02:00
archetypes TranslationBaseName replaced for Name on archetypes template 2018-05-27 13:29:39 -04:00
exampleSite Iconic relearn color theme 2021-06-30 23:15:51 +02:00
i18n Added binary prefix for kilobyte using i18n (#461) 2020-11-12 09:48:55 +00:00
images [ImgBot] Optimize images 2019-03-15 16:47:53 +00:00
layouts Rebranding to new theme name 2021-06-30 14:56:06 +02:00
static Iconic relearn color theme 2021-06-30 23:15:51 +02:00
.editorconfig Add .editorconfig 2019-03-15 16:10:45 +00:00
.gitignore Ignore hugo executable for improved test workflow 2021-06-30 14:56:28 +02:00
.grenrc.yml Ship tag 2.2.0 2019-01-28 01:08:48 +00:00
CHANGELOG.md Docs 2021-07-01 10:22:39 +02:00
LICENSE.md Rebranding to new theme name 2021-06-30 14:56:06 +02:00
netlify.toml Rebranding to new theme name 2021-06-30 14:56:06 +02:00
README.md Netlify moved content 2021-07-01 08:17:24 +02:00
theme.toml Rebranding to new theme name 2021-06-30 14:56:06 +02:00
wercker.yml Fix/wercker (#178) 2018-10-10 19:14:04 +02:00

Hugo Relearn Theme

This repository contains a theme for Hugo.

Visit the theme documentation to see what is going on. It is actually built with this theme.

wercker 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/McShelby/hugo-theme-relearn.git

Check that your Hugo version is minimum 0.25 with hugo version.

Overview

Usage

Credits

Many thanks to @vjeantet for the fork docdock. The v2 of this theme is mainly based on his work !

License

FOSSA Status

Releasing

Somewhat work-in-progress steps to release with gren

  • Check all MRs assigned to the milestone are closed or pushed back to another release

  • Close the milestone

  • Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.)

  • Tag and push the repo

    git tag <tag>
    git push origin <tag>
    
  • Generate CHANGELOG.md with gren

    gren changelog  --override --generate --tags=all
    
  • Fix the date for the current release in CHANGELOG.md

  • Add the changelog to git and update the tag

    git add CHANGELOG.md
    git commit -m "Ship tag <tag>"
    git push origin master
    git tag -f <tag>
    git push --force origin <tag>
    
  • Generate release with gren

    gren release -t <tag>