6cfd61e0f6
* enabled mermaid by default * implemented logic to use internal oder cdn mermaid * added english documentation * added french translation for the mermaid options * Removed useless test print * Hugo does not use upper case letters in params * fixed false sample link * improved mermaid pages * fixed always load mermaid if no frontmatter specified * applied 3 new params to default config * Implemented Home Button logic * Applied default style * applied same landingpage ref to logo partials * added sample image, how the button will looks like * added en documentation on how to configure the button * translated home button configuration to french via deepl * applied home button style to theme variants * set button disabled by default * fixed mermaid samples * removed obsolete css files * changed default version of mermaid cdn * renamed mermaidURL to customMermaidURL and removed css link * improved mermaid configuration description Co-authored-by: Arthur Ferdinand Lindner <Arthur-Ferdinand.Lindner@Telekom.de> Co-authored-by: Arthur Ferdinand Lindner <arthur.lindner@outlook.de> |
||
|---|---|---|
| archetypes | ||
| exampleSite | ||
| i18n | ||
| images | ||
| layouts | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| .grenrc.yml | ||
| CHANGELOG.md | ||
| LICENSE.md | ||
| netlify.toml | ||
| README.md | ||
| theme.toml | ||
| wercker.yml | ||
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
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>