mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 01:33:04 +00:00

A theme for Hugo designed for documentation

Find a file

Sören Weber b713e50140 Remove margin between content and arrows in print this will add additional ending space and may cause to add unnecessary empty pages at the end it also does not provide real value in screen mode		2020-10-05 12:22:23 +02:00
archetypes	TranslationBaseName replaced for Name on archetypes template	2018-05-27 13:29:39 -04:00
exampleSite	Customize mermaid module (#362 )	2020-09-11 14:57:25 +01:00
i18n	Add Chinese i18n items for this theme	2019-12-04 11:26:16 +08:00
images	[ImgBot] Optimize images	2019-03-15 16:47:53 +00:00
layouts	Customize mermaid module (#362 )	2020-09-11 14:57:25 +01:00
static	Remove margin between content and arrows	2020-10-05 12:22:23 +02:00
.editorconfig	Add .editorconfig	2019-03-15 16:10:45 +00:00
.gitignore	remove link in docs because of error	2017-08-20 23:43:45 +02:00
.grenrc.yml	Ship tag 2.2.0	2019-01-28 01:08:48 +00:00
CHANGELOG.md	Ship tag 2.5.0	2020-06-01 15:43:31 +01:00
LICENSE.md	add @vjeantet to copyright	2017-08-21 01:25:26 +02:00
netlify.toml	Update netlify baseurl fixes #438	2020-09-10 16:02:31 +01:00
README.md	Initial instructions on releasing with gren	2019-09-04 22:47:55 +01:00
theme.toml	HTTPS links	2018-12-07 16:14:14 +09:00
wercker.yml	Fix/wercker (#178 )	2018-10-10 19:14:04 +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.

Usage

Visit the documentation

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

Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
Git way:

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 !

License

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