hugo-theme-relearn/README.md

# Hugo Relearn Theme

A theme for [Hugo](https://gohugo.io/).

[![wercker status](https://app.wercker.com/status/062e9604da64b79944d87434cb63fa53/s/main "wercker status")](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53)

![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/tn.png)

## 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
- and many more...

Visit the [documentation](https://relearn.netlify.app/) for a demo.

## Installation

Navigate to your themes folder in your Hugo site and use the following commands:

```shell
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](https://relearn.netlify.app/)

## License

[MIT licensed.](https://en.wikipedia.org/wiki/MIT_License)

## Credits

Many thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project.

Special thanks to [@matcornic](https://github.com/matcornic) for his work on [learn](https://github.com/matcornic/hugo-theme-learn) and [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), which hugo-theme-relearn is based on.

## Releasing

Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes)

- 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

  ```shell
  git tag <tag>
  git push origin <tag>
  ```

- Generate CHANGELOG.md with _gren_

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

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

  ```shell
  gren release -t <tag>
  ```
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 12:56:06 +00:00			`# Hugo Relearn Theme`
feat: added minimal Readme 2016-03-17 11:05:36 +00:00
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`A theme for [Hugo](https://gohugo.io/).`
Update README for v2 2017-08-20 16:20:13 +00:00
Compliance: Rename branch master to main 2021-07-01 09:01:51 +00:00			`[![wercker status](https://app.wercker.com/status/062e9604da64b79944d87434cb63fa53/s/main "wercker status")](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53)`
Use status badge from Wercker 2018-08-10 09:29:11 +00:00
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/tn.png)`

Update README for v2 2017-08-20 16:20:13 +00:00			`## 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`
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`- Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs`
			`- and many more...`

			`Visit the [documentation](https://relearn.netlify.app/) for a demo.`
feat: partials for style and scripts are now empty 2016-04-10 22:09:03 +00:00
Update README.md 2016-12-30 21:40:05 +00:00			`## Installation`
Update README for v2 2017-08-20 16:20:13 +00:00
doc: Add theme installation instructions 2016-04-12 10:34:40 +00:00			`Navigate to your themes folder in your Hugo site and use the following commands:`
Update README for v2 2017-08-20 16:20:13 +00:00
Initial instructions on releasing with gren 2019-09-04 21:47:55 +00:00			```shell
			`cd themes/`
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 12:56:06 +00:00			`git clone https://github.com/McShelby/hugo-theme-relearn.git`
doc: Add theme installation instructions 2016-04-12 10:34:40 +00:00			```

Update README for v2 2017-08-20 16:20:13 +00:00			Check that your Hugo version is minimum `0.25` with `hugo version`.
add minium version 2017-04-08 08:30:09 +00:00
Update README.md 2016-12-30 21:40:05 +00:00			`## Usage`

Netlify moved content 2021-07-01 06:17:24 +00:00			`- [Visit the documentation](https://relearn.netlify.app/)`
credits to @vjeantet 2017-08-20 23:29:54 +00:00
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`## License`
credits to @vjeantet 2017-08-20 23:29:54 +00:00
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`[MIT licensed.](https://en.wikipedia.org/wiki/MIT_License)`
Add license scan report and status Signed-off-by: fossabot <badges@fossa.io> 2018-07-24 14:45:37 +00:00
Docs adjustments #1 2021-07-01 12:35:27 +00:00			`## Credits`
Initial instructions on releasing with gren 2019-09-04 21:47:55 +00:00
Contributers cleanup #1 2021-07-01 12:57:26 +00:00			`Many thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project.`

			`Special thanks to [@matcornic](https://github.com/matcornic) for his work on [learn](https://github.com/matcornic/hugo-theme-learn) and [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), which hugo-theme-relearn is based on.`
Initial instructions on releasing with gren 2019-09-04 21:47:55 +00:00
			`## Releasing`

			`Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes)`

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

			```shell
			`git tag <tag>`
			`git push origin <tag>`
			```

			`- Generate CHANGELOG.md with _gren_`

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

			```shell
			`git add CHANGELOG.md`
			`git commit -m "Ship tag <tag>"`
Compliance: Rename branch master to main 2021-07-01 09:01:51 +00:00			`git push origin main`
Initial instructions on releasing with gren 2019-09-04 21:47:55 +00:00			`git tag -f <tag>`
			`git push --force origin <tag>`
			```

			`- Generate release with _gren_`

			```shell
			`gren release -t <tag>`
			```