Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matcornic/hugo-theme-learn
Porting Grav Learn theme to Hugo
https://github.com/matcornic/hugo-theme-learn
gh-pages golang hugo hugo-documentation hugo-learn-theme hugo-site hugo-theme
Last synced: 28 days ago
JSON representation
Porting Grav Learn theme to Hugo
- Host: GitHub
- URL: https://github.com/matcornic/hugo-theme-learn
- Owner: matcornic
- License: mit
- Created: 2016-03-17T10:58:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-15T23:50:47.000Z (5 months ago)
- Last Synced: 2024-09-29T05:23:38.972Z (about 1 month ago)
- Topics: gh-pages, golang, hugo, hugo-documentation, hugo-learn-theme, hugo-site, hugo-theme
- Language: HTML
- Homepage: https://learn.netlify.com/en/
- Size: 13.7 MB
- Stars: 1,602
- Watchers: 37
- Forks: 1,280
- Open Issues: 166
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - matcornic/hugo-theme-learn - Porting Grav Learn theme to Hugo (golang)
README
THIS PROJECT IS DEPRECATED
The project is not maintained anymore. Thanks everyone for helping me on building this theme at the time where there were no good Hugo theme for documentation.
[Consider migrating to another theme](https://github.com/matcornic/hugo-theme-learn/issues/557) such as [Relearn](https://github.com/McShelby/hugo-theme-relearn) which seems to be a good maintained alternative.
----
# Hugo Learn Theme
This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](https://learn.getgrav.org/).
Visit the [theme documentation](https://learn.netlify.com/en/) to see what is going on. It is actually built with this theme.
[](https://app.wercker.com/project/byKey/233466a2be73fcea400e7dc02ef6adf9)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_shield)
## 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:
```shell
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](https://learn.netlify.com/en/)
## Download old versions (prior to 2.0.0)
If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/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:
```shell
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](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large)
## 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
git push origin
```
- 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 "
git push origin master
git tag -f
git push --force origin
```
- Generate release with _gren_
```shell
gren release -t
```