A theme for Hugo designed for documentation
Find a file
2021-07-01 20:28:26 +02:00
archetypes TranslationBaseName replaced for Name on archetypes template 2018-05-27 13:29:39 -04:00
exampleSite Reworking screenshots after rebranding 2021-07-01 16:25:08 +02:00
i18n Added binary prefix for kilobyte using i18n (#461) 2020-11-12 09:48:55 +00:00
images Reworking screenshots after rebranding 2021-07-01 16:25:08 +02:00
layouts Reworking screenshots after rebranding 2021-07-01 16:25:08 +02:00
static Reworking screenshots after rebranding 2021-07-01 16:25:08 +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 Adjust gren configuration 2021-07-01 20:26:24 +02:00
CHANGELOG.md Ship tag 1.0.0 2021-07-01 20:28:26 +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 Adjust gren configuration 2021-07-01 20:26:24 +02:00
theme.toml Compliance: Rename branch master to main 2021-07-01 11:01:51 +02:00
wercker.yml Fix/wercker (#178) 2018-10-10 19:14:04 +02:00

Hugo Relearn Theme

A theme for Hugo.

wercker status

Overview

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, Tabs

Visit the documentation for a demo.

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.

Usage

License

MIT licensed.

Credits

Many thanks to everyone who has contributed to this project.

Special thanks to @matcornic for his work on learn and @vjeantet for his work on docdock, which hugo-theme-relearn is based on.

Releasing

We are using gren to generate the changelog and releasenotes automatically.

In the latest gren release (0.17.3) is a bug in the date generation. Therefore we are using a historical but correct version directly thru npx.

Once:

  • Generate API Token as described in grens README.md
  • On Windows do setx GREN_GITHUB_TOKEN <API TOKEN> and restart your shell

Per release:

  • Close all issues of the milestone or push them back to an open milestone

  • Close the milestone

  • Tag and push the repo

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

    npx github-release-notes@0.17.1 changelog --tags=all --generate --override
    
  • Add the changelog to git and update the tag

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

    npx github-release-notes@0.17.1 release --tags <tag>