mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-01-18 10:50:24 +00:00

A theme for Hugo designed for documentation

Find a file

Sören Weber 5c667b3d07 code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo.		2021-07-26 11:50:34 +02:00
archetypes	TranslationBaseName replaced for Name on archetypes template	2018-05-27 13:29:39 -04:00
exampleSite	code highligher: switch to standard hugo highlighter #32	2021-07-26 11:50:34 +02:00
i18n	attachments: support i18n for attachment size #21	2021-07-17 12:37:24 +02:00
images	Prepare for hugo showcase #3	2021-07-01 21:02:54 +02:00
layouts	code highligher: switch to standard hugo highlighter #32	2021-07-26 11:50:34 +02:00
static	code highligher: switch to standard hugo highlighter #32	2021-07-26 11:50:34 +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	fix changelog headers	2021-07-02 23:27:57 +02:00
CHANGELOG.md	Ship tag 1.2.0	2021-07-26 11:25:49 +02:00
LICENSE	theme: prepare for new hugo theme registration #13	2021-07-04 20:59:17 +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	theme: prepare for new hugo theme registration #13	2021-07-04 20:59:17 +02:00
wercker.yml	Fix/wercker (#178 )	2018-10-10 19:14:04 +02:00

README.md

Hugo Relearn Theme

A theme for Hugo.

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

Visit the documentation

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>