hugo-theme-relearn/README.md
Sören Weber c108d677b4 Rebranding to new theme name
- Rename theme from "Learn" to "Relearn"
- also change URLs
- remove old references
- more removal of french and chinese
2021-06-30 14:56:06 +02:00

2.6 KiB

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 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/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>