mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 07:47:54 +00:00
Rebranding to new theme name
- Rename theme from "Learn" to "Relearn" - also change URLs - remove old references - more removal of french and chinese
This commit is contained in:
Sören Weber
parent
a938c24a63
commit
c108d677b4
29 changed files with 96 additions and 418 deletions
225
CHANGELOG.md
225
CHANGELOG.md
|
|
@ -1,226 +1 @@
|
|||
# Changelog
|
||||
|
||||
## v2.5.0 (01/06/2020)
|
||||
|
||||
#### New features
|
||||
|
||||
- [**feature**] Allow custom css files to be loaded by configuration [#376](https://github.com/matcornic/hugo-theme-learn/pull/376)
|
||||
- [**feature**] Added flag to turn off image featherlight [#333](https://github.com/matcornic/hugo-theme-learn/pull/333)
|
||||
|
||||
#### Bug Fixes
|
||||
|
||||
- [**bug**] fix null pointer when no params on image url [#383](https://github.com/matcornic/hugo-theme-learn/pull/383)
|
||||
- [**bug**] can't give argument to non-function not .Params.hidden [#403](https://github.com/matcornic/hugo-theme-learn/pull/403)
|
||||
- [**bug**] Fix .File.UniqueID on zero object warning [#372](https://github.com/matcornic/hugo-theme-learn/pull/372)
|
||||
- [**bug**] fix select option color in Chrome [#345](https://github.com/matcornic/hugo-theme-learn/pull/345)
|
||||
- [**bug**] remove unneeded spaces from HTML [#320](https://github.com/matcornic/hugo-theme-learn/pull/320)
|
||||
- [**bug**] Avoid displaying hidden sections in menu [#354](https://github.com/matcornic/hugo-theme-learn/pull/354)
|
||||
|
||||
#### Enhancements
|
||||
|
||||
- [**enhancement**] Updated theme installation documentation link. [#390](https://github.com/matcornic/hugo-theme-learn/pull/390)
|
||||
- [**enhancement**] [ImgBot] Optimize images [#366](https://github.com/matcornic/hugo-theme-learn/pull/366)
|
||||
- [**enhancement**] fix extra spaces in the description [#339](https://github.com/matcornic/hugo-theme-learn/pull/339)
|
||||
- [**enhancement**] change to minified 'autocomplete.js' for improved performance [#321](https://github.com/matcornic/hugo-theme-learn/pull/321)
|
||||
|
||||
#### Internationalisation
|
||||
|
||||
- [**i18n**] Fix: typos [#343](https://github.com/matcornic/hugo-theme-learn/pull/343)
|
||||
- [**i18n**] Fix: typo [#342](https://github.com/matcornic/hugo-theme-learn/pull/342)
|
||||
- [**i18n**] Incorrect english in notice documentation [#336](https://github.com/matcornic/hugo-theme-learn/pull/336)
|
||||
- [**i18n**] Add Chinese language for this theme [#349](https://github.com/matcornic/hugo-theme-learn/pull/349)
|
||||
- [**i18n**] Add jp and zh cn [#335](https://github.com/matcornic/hugo-theme-learn/pull/335)
|
||||
- [**i18n**] Added Russian translation [#332](https://github.com/matcornic/hugo-theme-learn/pull/332)
|
||||
|
||||
#### Theme Meta
|
||||
|
||||
- [**meta**] Fix various linting warnings [#405](https://github.com/matcornic/hugo-theme-learn/pull/405)
|
||||
- [**meta**] Netlify build on 0.66.0 [#377](https://github.com/matcornic/hugo-theme-learn/pull/377)
|
||||
- [**meta**] add inteliver documentation showcase [#331](https://github.com/matcornic/hugo-theme-learn/pull/331)
|
||||
|
||||
---
|
||||
|
||||
## v2.4.0 (04/09/2019)
|
||||
|
||||
#### Bug Fixes
|
||||
|
||||
- [**bug**] correct GitHub capitalization [#293](https://github.com/matcornic/hugo-theme-learn/pull/293)
|
||||
- [**bug**] fix 'locate' typo [#285](https://github.com/matcornic/hugo-theme-learn/pull/285)
|
||||
- [**bug**] Remove reference to the unused horsey CSS [#284](https://github.com/matcornic/hugo-theme-learn/pull/284)
|
||||
- [**bug**] Fix invalid HTML in 404 template. [#271](https://github.com/matcornic/hugo-theme-learn/pull/271)
|
||||
|
||||
#### Enhancements
|
||||
|
||||
- [**enhancement**] Delete html5shiv-printshiv.min.js [#319](https://github.com/matcornic/hugo-theme-learn/pull/319)
|
||||
- [**enhancement**] remove html5shiv [#315](https://github.com/matcornic/hugo-theme-learn/pull/315)
|
||||
- [**enhancement**] Fix deprecated .Hugo, .UniqueID and .URL references [#303](https://github.com/matcornic/hugo-theme-learn/pull/303)
|
||||
- [**enhancement**] Fix type lines 364 and 369 [#304](https://github.com/matcornic/hugo-theme-learn/pull/304)
|
||||
- [**enhancement**] remove unneeded type="text/css" [#298](https://github.com/matcornic/hugo-theme-learn/pull/298)
|
||||
- [**enhancement**] remove unneeded type="text/css" [#297](https://github.com/matcornic/hugo-theme-learn/pull/297)
|
||||
- [**enhancement**] HTTPS links in footer [#295](https://github.com/matcornic/hugo-theme-learn/pull/295)
|
||||
- [**enhancement**] remove unneeded type="text/css" [#292](https://github.com/matcornic/hugo-theme-learn/pull/292)
|
||||
- [**enhancement**] Make shortcodes & example site compatible with Hugo v0.55 [#281](https://github.com/matcornic/hugo-theme-learn/pull/281)
|
||||
|
||||
#### Internationalisation
|
||||
|
||||
- [**i18n**] Added German and Arabic translation [#312](https://github.com/matcornic/hugo-theme-learn/pull/312)
|
||||
|
||||
#### Theme Meta
|
||||
|
||||
- [**meta**] Added Tshark.dev as example site [#318](https://github.com/matcornic/hugo-theme-learn/pull/318)
|
||||
|
||||
---
|
||||
|
||||
## v2.3.0 (16/04/2019)
|
||||
|
||||
#### New features
|
||||
|
||||
- [**feature**] Added support for tags [#196](https://github.com/matcornic/hugo-theme-learn/pull/196)
|
||||
|
||||
#### Bug Fixes
|
||||
|
||||
- [**bug**] Fix issue where "children" shortcode only shows top level. [#252](https://github.com/matcornic/hugo-theme-learn/pull/252)
|
||||
- [**bug**] Fix translation when using a custom baseURL [#234](https://github.com/matcornic/hugo-theme-learn/pull/234)
|
||||
- [**bug**] Preventing left/right arrow key navigation in textareas [#241](https://github.com/matcornic/hugo-theme-learn/pull/241)
|
||||
- [**bug**] Update menu.html to include the check icon [#229](https://github.com/matcornic/hugo-theme-learn/pull/229)
|
||||
|
||||
#### Enhancements
|
||||
|
||||
- [**enhancement**] Render the ```mermaid blocks into graphs [#226](https://github.com/matcornic/hugo-theme-learn/pull/226)
|
||||
- [**enhancement**] Remove oudated versions of jquery & modernizr libraries [#259](https://github.com/matcornic/hugo-theme-learn/pull/259)
|
||||
- [**enhancement**] Various Updates [#237](https://github.com/matcornic/hugo-theme-learn/pull/237)
|
||||
- [**enhancement**] Use style instead of width and height in logo [#250](https://github.com/matcornic/hugo-theme-learn/pull/250)
|
||||
- [**enhancement**] [ImgBot] Optimize images [#222](https://github.com/matcornic/hugo-theme-learn/pull/222)
|
||||
- [**enhancement**] remove duplicate icon and fix incorrect favicon type [#227](https://github.com/matcornic/hugo-theme-learn/pull/227)
|
||||
- [**enhancement**] HTTPS links in exampleSite menu-footer [#223](https://github.com/matcornic/hugo-theme-learn/pull/223)
|
||||
|
||||
#### Internationalisation
|
||||
|
||||
- [**i18n**] Dutch i18n [#239](https://github.com/matcornic/hugo-theme-learn/pull/239)
|
||||
|
||||
#### Theme Meta
|
||||
|
||||
- [**meta**] Add .editorconfig [#224](https://github.com/matcornic/hugo-theme-learn/pull/224)
|
||||
|
||||
---
|
||||
|
||||
## v2.2.0 (28/01/2019)
|
||||
|
||||
#### New features
|
||||
|
||||
- [**feature**] Sitewide param to enable or disable next/previous page buttons and breadcrumbs [#184](https://github.com/matcornic/hugo-theme-learn/pull/184)
|
||||
|
||||
#### Bug Fixes
|
||||
|
||||
- [**bug**] Fix baseurl used by search to load json data [#177](https://github.com/matcornic/hugo-theme-learn/pull/177)
|
||||
- [**bug**] Updated CSS link to fontawesome library [#186](https://github.com/matcornic/hugo-theme-learn/pull/186)
|
||||
- [**bug**] Close / Cancel search icon not showing in input box [#215](https://github.com/matcornic/hugo-theme-learn/pull/215)
|
||||
- [**bug**] Prevent left and right keydown events while in input fields [#219](https://github.com/matcornic/hugo-theme-learn/pull/219)
|
||||
- [**bug**] xss fix [#182](https://github.com/matcornic/hugo-theme-learn/pull/182)
|
||||
- [**bug**] Fix error in blockquote documentation fixes #165 [#190](https://github.com/matcornic/hugo-theme-learn/pull/190)
|
||||
|
||||
#### Enhancements
|
||||
|
||||
- [**enhancement**] Update mermaid.js to a499296 [#199](https://github.com/matcornic/hugo-theme-learn/pull/199)
|
||||
- [**enhancement**] Update Font Awesome to 5.0.6 [#129](https://github.com/matcornic/hugo-theme-learn/pull/129)
|
||||
- [**enhancement**] Update 404.html alttext [#161](https://github.com/matcornic/hugo-theme-learn/pull/161)
|
||||
- [**enhancement**] Remove CSS source map metadata [#167](https://github.com/matcornic/hugo-theme-learn/pull/167)
|
||||
- [**enhancement**] Load github images in examplesite via https instead of http [#180](https://github.com/matcornic/hugo-theme-learn/pull/180)
|
||||
- [**enhancement**] Load main site logo via BaseUrl [#185](https://github.com/matcornic/hugo-theme-learn/pull/185)
|
||||
- [**enhancement**] HTTPS links in examplesite sidebar [#200](https://github.com/matcornic/hugo-theme-learn/pull/200)
|
||||
- [**enhancement**] Use correct input type for search [#205](https://github.com/matcornic/hugo-theme-learn/pull/205)
|
||||
- [**enhancement**] HTTPS link to learn.getgrav.org [#207](https://github.com/matcornic/hugo-theme-learn/pull/207)
|
||||
- [**enhancement**] Update html5shiv-printshiv.min.js [#208](https://github.com/matcornic/hugo-theme-learn/pull/208)
|
||||
- [**enhancement**] Remove whitespace from clippy.svg [#211](https://github.com/matcornic/hugo-theme-learn/pull/211)
|
||||
- [**enhancement**] Upgrade fontawesome to 5.6.3 [#218](https://github.com/matcornic/hugo-theme-learn/pull/218)
|
||||
- [**enhancement**] fix clickable nodes style in mermaid [#169](https://github.com/matcornic/hugo-theme-learn/pull/169)
|
||||
|
||||
#### Internationalisation
|
||||
|
||||
- [**i18n**] French language correction [#157](https://github.com/matcornic/hugo-theme-learn/pull/157)
|
||||
- [**i18n**] French language correction [#158](https://github.com/matcornic/hugo-theme-learn/pull/158)
|
||||
- [**i18n**] Add indonesian translation [#159](https://github.com/matcornic/hugo-theme-learn/pull/159)
|
||||
- [**i18n**] Add Turkish i18n config file [#175](https://github.com/matcornic/hugo-theme-learn/pull/175)
|
||||
|
||||
#### Theme Meta
|
||||
|
||||
- [**meta**] Fix wercker builds [#178](https://github.com/matcornic/hugo-theme-learn/pull/178)
|
||||
- [**meta**] Declare netlify buildsteps in repo file rather than in webui [#217](https://github.com/matcornic/hugo-theme-learn/pull/217)
|
||||
|
||||
---
|
||||
|
||||
## v2.1.0 (10/08/2018)
|
||||
|
||||
#### Internationalisation
|
||||
|
||||
- [**i18n**] Clean up the English language phrasing [#146](https://github.com/matcornic/hugo-theme-learn/pull/146)
|
||||
- [**i18n**] Updated _index.en.md for typo "names" [#150](https://github.com/matcornic/hugo-theme-learn/pull/150)
|
||||
|
||||
#### Theme Meta
|
||||
|
||||
- [**meta**] Add license scan report and status [#151](https://github.com/matcornic/hugo-theme-learn/pull/151)
|
||||
|
||||
#### Uncategorised
|
||||
|
||||
- [**closed**] Different viewport [#122](https://github.com/matcornic/hugo-theme-learn/pull/122)
|
||||
- [**closed**] TranslationBaseName replaced for Name on archetypes template [#145](https://github.com/matcornic/hugo-theme-learn/pull/145)
|
||||
- [**closed**] Improved variant of #119, as per request [#124](https://github.com/matcornic/hugo-theme-learn/pull/124)
|
||||
- [**closed**] role="" is invalid [#121](https://github.com/matcornic/hugo-theme-learn/pull/121)
|
||||
- [**closed**] Related to previous PR [#120](https://github.com/matcornic/hugo-theme-learn/pull/120)
|
||||
- [**closed**] Issue #111 for _index.fr.md [#117](https://github.com/matcornic/hugo-theme-learn/pull/117)
|
||||
- [**closed**] Issue #111 for _index.en.md [#116](https://github.com/matcornic/hugo-theme-learn/pull/116)
|
||||
- [**closed**] Issue #111 for theme-green.css [#114](https://github.com/matcornic/hugo-theme-learn/pull/114)
|
||||
- [**closed**] Issue #111 for theme-red.css [#113](https://github.com/matcornic/hugo-theme-learn/pull/113)
|
||||
- [**closed**] Issue #111 for theme-blue.css [#112](https://github.com/matcornic/hugo-theme-learn/pull/112)
|
||||
- [**closed**] Issue #111 for theme-mine.css [#115](https://github.com/matcornic/hugo-theme-learn/pull/115)
|
||||
- [**closed**] fix #77 : no wrap images that already wrapped [#118](https://github.com/matcornic/hugo-theme-learn/pull/118)
|
||||
- [**closed**] doc: Keep icons aligned [#110](https://github.com/matcornic/hugo-theme-learn/pull/110)
|
||||
- [**closed**] Add Portuguese translation [#109](https://github.com/matcornic/hugo-theme-learn/pull/109)
|
||||
- [**closed**] Use `relURL` where possible [#102](https://github.com/matcornic/hugo-theme-learn/pull/102)
|
||||
- [**closed**] Bug fix in sidebar menu and children description generation [#105](https://github.com/matcornic/hugo-theme-learn/pull/105)
|
||||
- [**closed**] fix some typo [#104](https://github.com/matcornic/hugo-theme-learn/pull/104)
|
||||
- [**closed**] Added a `menuTitle` attribute to partials/menu.html [#90](https://github.com/matcornic/hugo-theme-learn/pull/90)
|
||||
- [**closed**] allowing comments system [#86](https://github.com/matcornic/hugo-theme-learn/pull/86)
|
||||
- [**closed**] Add spanish translation [#85](https://github.com/matcornic/hugo-theme-learn/pull/85)
|
||||
- [**closed**] Replace horsey with Pixabay's autocomplete [#75](https://github.com/matcornic/hugo-theme-learn/pull/75)
|
||||
- [**closed**] Added info about 'draft:true' [#74](https://github.com/matcornic/hugo-theme-learn/pull/74)
|
||||
- [**closed**] Remove white space from `align` parameter [#63](https://github.com/matcornic/hugo-theme-learn/pull/63)
|
||||
|
||||
---
|
||||
|
||||
## v2.0.0 (20/08/2017)
|
||||
|
||||
#### Uncategorised
|
||||
|
||||
- [**closed**] V2 [#56](https://github.com/matcornic/hugo-theme-learn/pull/56)
|
||||
|
||||
---
|
||||
|
||||
## v1.1.0 (22/07/2017)
|
||||
|
||||
#### Bug Fixes
|
||||
|
||||
- [**bug**] Fix sticky header jumpiness [#45](https://github.com/matcornic/hugo-theme-learn/pull/45)
|
||||
|
||||
#### Uncategorised
|
||||
|
||||
- [**closed**] Fix anchor scrolling that hides behind top nav bar [#46](https://github.com/matcornic/hugo-theme-learn/pull/46)
|
||||
- [**closed**] feat: Change the default code color [#43](https://github.com/matcornic/hugo-theme-learn/pull/43)
|
||||
- [**closed**] Use index pages + automatic navigation arrows [#36](https://github.com/matcornic/hugo-theme-learn/pull/36)
|
||||
|
||||
---
|
||||
|
||||
## v1.0.0 (25/03/2017)
|
||||
|
||||
#### Uncategorised
|
||||
|
||||
- [**closed**] Search [#18](https://github.com/matcornic/hugo-theme-learn/pull/18)
|
||||
- [**closed**] Extracted menu footer content to separate partial file [#35](https://github.com/matcornic/hugo-theme-learn/pull/35)
|
||||
- [**closed**] feat: style Hugo figure shortcode [#33](https://github.com/matcornic/hugo-theme-learn/pull/33)
|
||||
- [**closed**] Fix URL for 'Edit this page' on Windows [#27](https://github.com/matcornic/hugo-theme-learn/pull/27)
|
||||
- [**closed**] Revert "Menu generation using Content file instead directories" [#10](https://github.com/matcornic/hugo-theme-learn/pull/10)
|
||||
- [**closed**] (#25) use .Site.BaseURL to lcoate static assets [#26](https://github.com/matcornic/hugo-theme-learn/pull/26)
|
||||
- [**closed**] Menu ordering and definition in config.toml [#8](https://github.com/matcornic/hugo-theme-learn/pull/8)
|
||||
- [**closed**] Menu generation using Content file instead directories [#5](https://github.com/matcornic/hugo-theme-learn/pull/5)
|
||||
- [**closed**] Add Checkmark On visited Links [#4](https://github.com/matcornic/hugo-theme-learn/pull/4)
|
||||
- [**closed**] doc: Add theme installation instructions [#1](https://github.com/matcornic/hugo-theme-learn/pull/1)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ The MIT License (MIT)
|
|||
Copyright (c) 2014 Grav
|
||||
Copyright (c) 2016 MATHIEU CORNIC
|
||||
Copyright (c) 2017 Valere JEANTET
|
||||
Copyright (c) 2021 Sören Weber
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
|
|
|
|||
30
README.md
30
README.md
|
|
@ -1,11 +1,11 @@
|
|||
# Hugo Learn Theme
|
||||
# Hugo Relearn Theme
|
||||
|
||||
This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](https://learn.getgrav.org/).
|
||||
This repository contains a theme for [Hugo](https://gohugo.io/).
|
||||
|
||||
Visit the [theme documentation](https://learn.netlify.com/en/) to see what is going on. It is actually built with this theme.
|
||||
Visit the [theme documentation](https://relearn.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)
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2FMcShelby%2Fhugo-theme-relearn?ref=badge_shield)
|
||||
|
||||
## Main features
|
||||
|
||||
|
|
@ -26,30 +26,16 @@ 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
|
||||
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://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
|
||||
- [Visit the documentation](https://relearn.netlify.com/en/)
|
||||
|
||||
## Credits
|
||||
|
||||
|
|
@ -57,7 +43,7 @@ Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](
|
|||
|
||||
## License
|
||||
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large)
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2FMcShelby%2Fhugo-theme-relearn?ref=badge_large)
|
||||
|
||||
## Releasing
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 MATHIEU CORNIC
|
||||
Copyright (c) 2021 Sören Weber
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
|
|
|
|||
|
|
@ -2,15 +2,15 @@ baseURL = "/"
|
|||
languageCode = "en-US"
|
||||
defaultContentLanguage = "en"
|
||||
|
||||
title = "Hugo Learn Documentation"
|
||||
theme = "hugo-theme-learn"
|
||||
title = "Hugo Relearn Documentation"
|
||||
theme = "hugo-theme-relearn"
|
||||
themesdir = "../.."
|
||||
metaDataFormat = "yaml"
|
||||
defaultContentLanguageInSubdir= true
|
||||
|
||||
[params]
|
||||
editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/"
|
||||
description = "Documentation for Hugo Learn Theme"
|
||||
editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/master/exampleSite/content/"
|
||||
description = "Documentation for Hugo Relearn Theme"
|
||||
author = "Mathieu Cornic"
|
||||
showVisitedLinks = true
|
||||
disableBreadcrumb = false
|
||||
|
|
@ -25,7 +25,7 @@ home = [ "HTML", "RSS", "JSON"]
|
|||
|
||||
[Languages]
|
||||
[Languages.en]
|
||||
title = "Documentation for Hugo Learn Theme"
|
||||
title = "Documentation for Hugo Relearn Theme"
|
||||
weight = 1
|
||||
languageName = "English"
|
||||
landingPageURL = "/en"
|
||||
|
|
@ -34,7 +34,7 @@ landingPageName = "<i class='fas fa-home'></i> Home"
|
|||
[[Languages.en.menu.shortcuts]]
|
||||
name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
weight = 10
|
||||
|
||||
[[Languages.en.menu.shortcuts]]
|
||||
|
|
@ -52,61 +52,3 @@ weight = 20
|
|||
name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
|
||||
url = "/credits"
|
||||
weight = 30
|
||||
|
||||
[Languages.fr]
|
||||
title = "Documentation du thème Hugo Learn"
|
||||
weight = 2
|
||||
languageName = "Français"
|
||||
landingPageURL = "/fr"
|
||||
landingPageName = "<i class='fas fa-home'></i> Accueil"
|
||||
|
||||
[[Languages.fr.menu.shortcuts]]
|
||||
name = "<i class='fab fa-fw fa-github'></i> Repo GitHub"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
||||
weight = 10
|
||||
|
||||
[[Languages.fr.menu.shortcuts]]
|
||||
name = "<i class='fas fa-fw fa-camera'></i> Vitrine"
|
||||
url = "/showcase"
|
||||
weight = 11
|
||||
|
||||
[[Languages.fr.menu.shortcuts]]
|
||||
name = "<i class='fas fa-fw fa-bookmark'></i> Documentation Hugo"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 20
|
||||
|
||||
[[Languages.fr.menu.shortcuts]]
|
||||
name = "<i class='fas fa-fw fa-bullhorn'></i> Crédits"
|
||||
url = "/credits"
|
||||
weight = 30
|
||||
|
||||
[Languages.zh]
|
||||
title = "Hugo 主题的 Learn 文档"
|
||||
weight = 3
|
||||
languageName = "简体中文"
|
||||
landingPageURL = "/zh"
|
||||
landingPageName = "<i class='fas fa-home'></i> 家"
|
||||
|
||||
[[Languages.zh.menu.shortcuts]]
|
||||
name = "<i class='fab fa-fw fa-github'></i> GitHub 仓库"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
||||
weight = 10
|
||||
|
||||
[[Languages.zh.menu.shortcuts]]
|
||||
name = "<i class='fas fa-fw fa-camera'></i> 展示区"
|
||||
url = "/showcase"
|
||||
weight = 11
|
||||
|
||||
[[Languages.zh.menu.shortcuts]]
|
||||
name = "<i class='fas fa-fw fa-bookmark'></i> Hugo 文档"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 20
|
||||
|
||||
[[Languages.zh.menu.shortcuts]]
|
||||
name = "<i class='fas fa-fw fa-bullhorn'></i> 鸣谢"
|
||||
url = "/credits"
|
||||
weight = 30
|
||||
|
|
|
|||
|
|
@ -1,14 +1,12 @@
|
|||
---
|
||||
title: "Learn Theme for Hugo"
|
||||
title: "Relearn Theme for Hugo"
|
||||
---
|
||||
|
||||
# Hugo learn theme
|
||||
# Hugo Relearn Theme
|
||||
|
||||
[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) is a theme for [Hugo](https://gohugo.io/), a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is **fully designed for documentation**.
|
||||
[Hugo-theme-relearn](http://github.com/McShelby/hugo-theme-relearn) is a theme for [Hugo](https://gohugo.io/), a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is **fully designed for documentation**.
|
||||
|
||||
This theme is a partial porting of the [Learn theme](http://learn.getgrav.org/) of [Grav](https://getgrav.org/), a modern flat-file CMS written in PHP.
|
||||
|
||||
{{% notice tip %}}Learn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "cont/pages/_index.md"%}})
|
||||
{{% notice tip %}}Relearn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "cont/pages/_index.md"%}})
|
||||
{{% /notice %}}
|
||||
|
||||
## Main features
|
||||
|
|
@ -24,7 +22,7 @@ This theme is a partial porting of the [Learn theme](http://learn.getgrav.org/)
|
|||
* [Customizable look and feel and themes variants]({{%relref "basics/style-customization/_index.md"%}})
|
||||
* [Buttons]({{%relref "shortcodes/button.en.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.en.md" %}}), [Expand]({{%relref "shortcodes/expand.en.md" %}})
|
||||
|
||||
|
||||
|
||||
|
||||
## Contribute to this documentation
|
||||
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
|
||||
|
|
@ -34,7 +32,7 @@ Your modification will be deployed automatically when merged.
|
|||
{{% /notice %}}
|
||||
|
||||
## Documentation website
|
||||
This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-learn` -- source code is [available here at GitHub](https://github.com/matcornic/hugo-theme-learn)
|
||||
This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-relearn` -- source code is [available here at GitHub](https://github.com/McShelby/hugo-theme-relearn)
|
||||
|
||||
{{% notice note %}}
|
||||
Automatically published and hosted thanks to [Netlify](https://www.netlify.com/). Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ weight: 20
|
|||
|
||||
## Global site parameters
|
||||
|
||||
On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** lets you define the following parameters in your `config.toml` (here, values are default).
|
||||
On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **Hugo-theme-relearn** lets you define the following parameters in your `config.toml` (here, values are default).
|
||||
|
||||
Note that some of these parameters are explained in details in other sections of this documentation.
|
||||
|
||||
|
|
@ -63,7 +63,7 @@ If not already present, add the follow lines in the same `config.toml` file.
|
|||
home = [ "HTML", "RSS", "JSON"]
|
||||
```
|
||||
|
||||
Learn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
|
||||
Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
|
||||
|
||||
> Hugo generate lunrjs index.json at the root of public folder.
|
||||
> When you build the site with `hugo server`, hugo generates it internally and of course it doesn’t show up in the filesystem
|
||||
|
|
|
|||
|
|
@ -15,11 +15,11 @@ hugo new site <new_project>
|
|||
|
||||
## Install the theme
|
||||
|
||||
Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme)
|
||||
Install the **Hugo-theme-relearn** theme by following [this documentation](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme)
|
||||
|
||||
This theme's repository is: https://github.com/matcornic/hugo-theme-learn.git
|
||||
This theme's repository is: https://github.com/McShelby/hugo-theme-relearn.git
|
||||
|
||||
Alternatively, you can [download the theme as .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) file and extract it in the `themes` directory
|
||||
Alternatively, you can [download the theme as .zip](https://github.com/McShelby/hugo-theme-relearn/archive/master.zip) file and extract it in the `themes` directory
|
||||
|
||||
## Basic configuration
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ When building the website, you can set a theme by using `--theme` option. Howeve
|
|||
|
||||
```toml
|
||||
# Change the default theme to be use when building the site with Hugo
|
||||
theme = "hugo-theme-learn"
|
||||
theme = "hugo-theme-relearn"
|
||||
|
||||
# For search functionality
|
||||
[outputs]
|
||||
|
|
@ -50,7 +50,7 @@ renders as
|
|||
|
||||
|
||||
|
||||
**Hugo-theme-learn** provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command
|
||||
**Hugo-theme-relearn** provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command
|
||||
|
||||
```
|
||||
hugo new --kind chapter basics/_index.md
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@ title: Style customization
|
|||
weight: 25
|
||||
---
|
||||
|
||||
**Hugo-theme-learn** has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/)
|
||||
**Hugo-theme-relearn** has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/)
|
||||
|
||||
In `themes/hugo-theme-learn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.
|
||||
In `themes/hugo-theme-relearn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.
|
||||
|
||||
This theme defines the following partials :
|
||||
|
||||
|
|
@ -43,7 +43,7 @@ If you need to change this default behavior, create a new file in `layouts/parti
|
|||
|
||||
## Change default colors {#theme-variant}
|
||||
|
||||
**Hugo Learn theme** let you choose between 3 native color scheme variants, but feel free to add one yourself ! Default color scheme is based on [Grav Learn Theme](https://learn.getgrav.org/).
|
||||
**Hugo Relearn theme** let you choose between 3 native color scheme variants, but feel free to add one yourself!
|
||||
|
||||
### Red variant
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Multilingual and i18n
|
|||
weight: 30
|
||||
---
|
||||
|
||||
**Learn theme** is fully compatible with Hugo multilingual mode.
|
||||
**Relearn theme** is fully compatible with Hugo multilingual mode.
|
||||
|
||||
It provides:
|
||||
|
||||
|
|
@ -28,12 +28,12 @@ defaultContentLanguageInSubdir= true
|
|||
|
||||
[Languages]
|
||||
[Languages.en]
|
||||
title = "Documentation for Hugo Learn Theme"
|
||||
title = "Documentation for Hugo Relearn Theme"
|
||||
weight = 1
|
||||
languageName = "English"
|
||||
|
||||
[Languages.fr]
|
||||
title = "Documentation du thème Hugo Learn"
|
||||
title = "Documentation du thème Hugo Relearn"
|
||||
weight = 2
|
||||
languageName = "Français"
|
||||
```
|
||||
|
|
@ -59,9 +59,9 @@ Use [slug](https://gohugo.io/content-management/multilingual/#translate-your-con
|
|||
|
||||
Translations strings are used for common default values used in the theme (*Edit this page* button, *Search placeholder* and so on). Translations are available in french and english but you may use another language or want to override default values.
|
||||
|
||||
To override these values, create a new file in your local i18n folder `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-learn/i18n/en.toml`
|
||||
To override these values, create a new file in your local i18n folder `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-relearn/i18n/en.toml`
|
||||
|
||||
By the way, as these translations could be used by other people, please take the time to propose a translation by [making a PR](https://github.com/matcornic/hugo-theme-learn/pulls) to the theme !
|
||||
By the way, as these translations could be used by other people, please take the time to propose a translation by [making a PR](https://github.com/McShelby/hugo-theme-relearn/pulls) to the theme !
|
||||
|
||||
## Disable language switching
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Icons and logos
|
|||
weight: 27
|
||||
---
|
||||
|
||||
The Learn theme for Hugo loads the [**Font Awesome**](https://fontawesome.com) library, allowing you to easily display any icon or logo available in the Font Awesome free collection.
|
||||
The Relearn theme for Hugo loads the [**Font Awesome**](https://fontawesome.com) library, allowing you to easily display any icon or logo available in the Font Awesome free collection.
|
||||
|
||||
## Finding an icon
|
||||
|
||||
|
|
@ -22,12 +22,12 @@ The HTML to include the heart icon is:
|
|||
Paste the `<i>` HTML into markup and Font Awesome will load the relevant icon.
|
||||
|
||||
```
|
||||
Built with <i class="fas fa-heart"></i> from Grav and Hugo
|
||||
Built with <i class="fas fa-heart"></i> from Relearn and Hugo
|
||||
```
|
||||
|
||||
Which appears as
|
||||
|
||||
Built with <i class="fas fa-heart"></i> from Grav and Hugo
|
||||
Built with <i class="fas fa-heart"></i> from Relearn and Hugo
|
||||
|
||||
## Customising icons
|
||||
|
||||
|
|
|
|||
|
|
@ -4,11 +4,6 @@ title: Markdown syntax
|
|||
weight: 15
|
||||
---
|
||||
|
||||
{{% notice note %}}
|
||||
This page is a shameful copy of the great [Grav original page](http://learn.getgrav.org/content/markdown).
|
||||
Only difference is information about image customization ([resizing]({{< relref "#resizing-image" >}}), [add CSS classes]({{< relref "#add-css-classes" >}})...)
|
||||
{{% /notice%}}
|
||||
|
||||
Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
||||
|
||||
**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
|
||||
|
|
@ -27,8 +22,6 @@ John Gruber, the author of Markdown, puts it like this:
|
|||
> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
|
||||
> -- John Gruber
|
||||
|
||||
Grav ships with built-in support for [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](https://michelf.ca/projects/php-markdown/extra/). You must enable **Markdown Extra** in your `system.yaml` configuration file
|
||||
|
||||
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
|
||||
|
||||
{{% notice info %}}
|
||||
|
|
@ -225,7 +218,7 @@ Renders to:
|
|||
## Notices
|
||||
|
||||
{{% notice note %}}
|
||||
The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices)
|
||||
Here is some important information: Stay hydrated!
|
||||
{{% /notice %}}
|
||||
|
||||
## Lists
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Example from the current website:
|
|||
[[menu.shortcuts]]
|
||||
name = "<i class='fab fa-github'></i> Github repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
weight = 10
|
||||
|
||||
[[menu.shortcuts]]
|
||||
|
|
@ -53,14 +53,14 @@ Example from the current website:
|
|||
|
||||
[Languages]
|
||||
[Languages.en]
|
||||
title = "Documentation for Hugo Learn Theme"
|
||||
title = "Documentation for Hugo Relearn Theme"
|
||||
weight = 1
|
||||
languageName = "English"
|
||||
|
||||
[[Languages.en.menu.shortcuts]]
|
||||
name = "<i class='fab fa-github'></i> Github repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
weight = 10
|
||||
|
||||
[[Languages.en.menu.shortcuts]]
|
||||
|
|
@ -80,14 +80,14 @@ Example from the current website:
|
|||
weight = 30
|
||||
|
||||
[Languages.fr]
|
||||
title = "Documentation du thème Hugo Learn"
|
||||
title = "Documentation du thème Hugo Relearn"
|
||||
weight = 2
|
||||
languageName = "Français"
|
||||
|
||||
[[Languages.fr.menu.shortcuts]]
|
||||
name = "<i class='fab fa-github'></i> Repo Github"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/matcornic/hugo-theme-learn"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
weight = 10
|
||||
|
||||
[[Languages.fr.menu.shortcuts]]
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ Organize your site like [any other Hugo project](https://gohugo.io/content/organ
|
|||
|
||||
## Types
|
||||
|
||||
**Hugo-theme-learn** defines two types of pages. *Default* and *Chapter*. Both can be used at any level of the documentation, the only difference being layout display.
|
||||
**Hugo-theme-relearn** defines two types of pages. *Default* and *Chapter*. Both can be used at any level of the documentation, the only difference being layout display.
|
||||
|
||||
A **Chapter** displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it.
|
||||
You can define any HTML as prefix for the menu. In the example below, it's just a number but that could be an [icon](https://fortawesome.github.io/Font-Awesome/).
|
||||
|
|
@ -62,7 +62,7 @@ pre = "<b>1. </b>"
|
|||
Discover what this Hugo theme is all about and the core-concepts behind it.
|
||||
```
|
||||
|
||||
To tell **Hugo-theme-learn** to consider a page as a chapter, set `chapter=true` in the Front Matter of the page.
|
||||
To tell **Hugo-theme-relearn** to consider a page as a chapter, set `chapter=true` in the Front Matter of the page.
|
||||
|
||||
A **Default** page is any other content page.
|
||||
|
||||
|
|
@ -85,13 +85,13 @@ Hugo provides a `new` command to create a new website.
|
|||
hugo new site <new_project>
|
||||
```
|
||||
|
||||
**Hugo-theme-learn** provides [archetypes]({{< relref "cont/archetypes.en.md" >}}) to help you create this kind of pages.
|
||||
**Hugo-theme-relearn** provides [archetypes]({{< relref "cont/archetypes.en.md" >}}) to help you create this kind of pages.
|
||||
|
||||
## Front Matter configuration
|
||||
|
||||
Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-matter/) in *yaml*, *toml* or *json*.
|
||||
|
||||
**Hugo-theme-learn** uses the following parameters on top of Hugo ones :
|
||||
**Hugo-theme-relearn** uses the following parameters on top of Hugo ones :
|
||||
|
||||
```toml
|
||||
+++
|
||||
|
|
@ -143,7 +143,7 @@ weight = 5
|
|||
|
||||
### Using a custom title for menu entries
|
||||
|
||||
By default, **Hugo-theme-learn** will use a page's `title` attribute for the menu item (or `linkTitle` if defined).
|
||||
By default, **Hugo-theme-relearn** will use a page's `title` attribute for the menu item (or `linkTitle` if defined).
|
||||
|
||||
But a page's title has to be descriptive on its own while the menu is a hierarchy.
|
||||
We've added the `menuTitle` parameter for that purpose:
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Code highlighting
|
|||
weight: 16
|
||||
---
|
||||
|
||||
Learn theme uses [highlight.js](https://highlightjs.org/) to provide code syntax highlighting.
|
||||
Relearn theme uses [highlight.js](https://highlightjs.org/) to provide code syntax highlighting.
|
||||
|
||||
## Markdown syntax
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ Renders to:
|
|||
|
||||
## Supported languages
|
||||
|
||||
Learn theme ships with its own version of highlight.js to support offline browsing. The included package supports 38 common languages, as described on the [highlight.js download page](https://highlightjs.org/download/).
|
||||
Relearn theme ships with its own version of highlight.js to support offline browsing. The included package supports 38 common languages, as described on the [highlight.js download page](https://highlightjs.org/download/).
|
||||
|
||||
## Identifying failed language detection
|
||||
|
||||
|
|
@ -80,7 +80,7 @@ Inside the zip archive downloaded from highlight.js extract the file named `high
|
|||
static/js/highlight.pack.js
|
||||
```
|
||||
|
||||
**Do not** replace the existing file at `themes/hugo-theme-learn/static/js/highlight.pack.js`.
|
||||
**Do not** replace the existing file at `themes/hugo-theme-relearn/static/js/highlight.pack.js`.
|
||||
|
||||
Including the file in the correct path will override the theme default highlight.pack.js and prevent issues caused in the future if the theme default file is updated.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ weight: 40
|
|||
tags: ["documentation", "tutorial"]
|
||||
---
|
||||
|
||||
*Learn theme* support one default taxonomy of gohugo: the *tag* feature.
|
||||
*Relearn theme* support one default taxonomy of gohugo: the *tag* feature.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@ disableToc: true
|
|||
|
||||
Thanks to them <i class="fas fa-heart"></i> for making Open Source Software a better place !
|
||||
|
||||
{{% ghcontributors "https://api.github.com/repos/matcornic/hugo-theme-learn/contributors?per_page=100" %}}
|
||||
{{% ghcontributors "https://api.github.com/repos/McShelby/hugo-theme-relearn/contributors?per_page=100" %}}
|
||||
|
||||
And a special thanks to [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), a fork of hugo-theme-learn. v2.0.0 of this theme is inspired by his work.
|
||||
And a special thanks to [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), a fork of hugo-theme-relearn. v2.0.0 of this theme is inspired by his work.
|
||||
|
||||
## Packages and libraries
|
||||
* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
|
||||
|
|
|
|||
|
|
@ -11,6 +11,6 @@ But this happens to be a bad idea. Everyone uses Markdown because it's pure and
|
|||
|
||||
To avoid this limitations, Hugo created [shortcodes](https://gohugo.io/extras/shortcodes/). A shortcode is a simple snippet inside a page.
|
||||
|
||||
**Hugo-theme-learn** provides multiple shortcodes on top of existing ones.
|
||||
**Hugo-theme-relearn** provides multiple shortcodes on top of existing ones.
|
||||
|
||||
{{%children style="h2" description="true" %}}
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ description : "Nice buttons on your page."
|
|||
A button is a just a clickable button with optional icon.
|
||||
|
||||
```
|
||||
{{%/* button href="https://getgrav.org/" */%}}Get Grav{{%/* /button */%}}
|
||||
{{%/* button href="https://getgrav.org/" icon="fas fa-download" */%}}Get Grav with icon{{%/* /button */%}}
|
||||
{{%/* button href="https://getgrav.org/" icon="fas fa-download" icon-position="right" */%}}Get Grav with icon right{{%/* /button */%}}
|
||||
{{%/* button href="https://gohugo.io/" */%}}Get Hugo{{%/* /button */%}}
|
||||
{{%/* button href="https://gohugo.io/" icon="fas fa-download" */%}}Get Hugo with icon{{%/* /button */%}}
|
||||
{{%/* button href="https://gohugo.io/" icon="fas fa-download" icon-position="right" */%}}Get Hugo with icon right{{%/* /button */%}}
|
||||
```
|
||||
|
||||
{{% button href="https://getgrav.org/" %}}Get Grav{{% /button %}}
|
||||
{{% button href="https://getgrav.org/" icon="fas fa-download" %}}Get Grav with icon{{% /button %}}
|
||||
{{% button href="https://getgrav.org/" icon="fas fa-download" icon-position="right" %}}Get Grav with icon right{{% /button %}}
|
||||
{{% button href="https://gohugo.io/" %}}Get Hugo{{% /button %}}
|
||||
{{% button href="https://gohugo.io/" icon="fas fa-download" %}}Get Hugo with icon{{% /button %}}
|
||||
{{% button href="https://gohugo.io/" icon="fas fa-download" icon-position="right" %}}Get Hugo with icon right{{% /button %}}
|
||||
|
|
|
|||
|
|
@ -21,9 +21,9 @@ proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|||
|
||||
this shortcode takes exactly one optional parameter to define the text that appears next to the expand/collapse icon. (default is "Expand me...")
|
||||
|
||||
{{%/*expand "Is this learn theme rocks ?" */%}}Yes !.{{%/* /expand*/%}}
|
||||
{{%/*expand "Does this relearn theme rock?" */%}}Yes !.{{%/* /expand*/%}}
|
||||
|
||||
{{%expand "Is this learn theme rocks ?" %}}Yes !{{% /expand%}}
|
||||
{{%expand "Does this relearn theme rock?" %}}Yes !{{% /expand%}}
|
||||
|
||||
# Demo
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ For instance, in this current site, the `editURL` variable is used in `config.to
|
|||
|
||||
```toml
|
||||
[params]
|
||||
editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/"
|
||||
editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/master/exampleSite/content/"
|
||||
```
|
||||
|
||||
Use the `siteparam` shortcode to display its value.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
<center>
|
||||
<!-- Place this tag where you want the button to render. -->
|
||||
<a class="github-button" href="https://github.com/matcornic/hugo-theme-learn/archive/master.zip" data-icon="octicon-cloud-download" aria-label="Download matcornic/hugo-theme-learn on GitHub">Download</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/archive/master.zip" data-icon="octicon-cloud-download" aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
|
||||
|
||||
<!-- Place this tag where you want the button to render. -->
|
||||
<a class="github-button" href="https://github.com/matcornic/hugo-theme-learn" data-icon="octicon-star" data-show-count="true" aria-label="Star matcornic/hugo-theme-learn on GitHub">Star</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn" data-icon="octicon-star" data-show-count="true" aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
|
||||
|
||||
<!-- Place this tag where you want the button to render. -->
|
||||
<a class="github-button" href="https://github.com/matcornic/hugo-theme-learn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork matcornic/hugo-theme-learn on GitHub">Fork</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
|
||||
|
||||
<p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fas fa-heart"></i></a> from <a href="https://getgrav.org">Grav</a> and <a href="https://gohugo.io/">Hugo</a></p>
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn"><i class="fas fa-heart"></i></a> from <a href="https://gohugo.io/">Hugo</a></p>
|
||||
</center>
|
||||
<!-- Place this tag in your head or just before your close body tag. -->
|
||||
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
||||
|
|
|
|||
|
|
@ -3,29 +3,17 @@
|
|||
<a href="#" id="sidebar-toggle" data-sidebar-toggle=""><i class="fas fa-bars"></i> navigation</a>
|
||||
</span>
|
||||
|
||||
{{if .Site.Home.Content }}
|
||||
{{.Site.Home.Content}}
|
||||
{{else}}
|
||||
{{if eq .Site.Language.Lang "fr"}}
|
||||
<h1>Personaliser la page d'accueil</h1>
|
||||
<p>
|
||||
Le site fonctionne. Ne pas oublier de personaliser cette page avec votre propre contenu. 3 manières de faire :
|
||||
</p>
|
||||
<ul>
|
||||
<li><b>1. </b> Créer un fichier _index.md dans le dossier <b>content</b> et le remplir de Markdown</li>
|
||||
<li><b>2. </b> Créer un fichier index.html dans le dossier <b>static</b> et le remplir de code HTML</li>
|
||||
<li><b>3. </b> Configurer le serveur http pour rediriger automatiquement la homepage vers la page de votre choix dans le site</li>
|
||||
</ul>
|
||||
{{else}}
|
||||
<h1>Customize your own home page</h1>
|
||||
<p>
|
||||
The site is working. Don't forget to customize this homepage with your own. You typically have 3 choices :
|
||||
</p>
|
||||
<ul>
|
||||
<li><b>1. </b> Create an _index.md document in <b>content</b> folder and fill it with Markdown content</li>
|
||||
<li><b>2. </b> Create an <b>index.html</b> file in the <b>static</b> folder and fill the file with HTML content</li>
|
||||
<li><b>3. </b> Configure your server to automatically redirect home page to one your documentation page</li>
|
||||
</ul>
|
||||
{{end}}
|
||||
{{ end }}
|
||||
{{if .Site.Home.Content }}
|
||||
{{.Site.Home.Content}}
|
||||
{{else}}
|
||||
<h1>Customize your own home page</h1>
|
||||
<p>
|
||||
The site is working. Don't forget to customize this homepage with your own. You typically have 3 choices :
|
||||
</p>
|
||||
<ul>
|
||||
<li><b>1. </b> Create an _index.md document in <b>content</b> folder and fill it with Markdown content</li>
|
||||
<li><b>2. </b> Create an <b>index.html</b> file in the <b>static</b> folder and fill the file with HTML content</li>
|
||||
<li><b>3. </b> Configure your server to automatically redirect home page to one your documentation page</li>
|
||||
</ul>
|
||||
{{ end }}
|
||||
{{ partial "footer.html" . }}
|
||||
|
|
|
|||
|
|
@ -64,8 +64,8 @@
|
|||
<script src="{{"js/highlight.pack.js" | relURL}}{{ if not .Site.Params.disableAssetsBusting }}?{{ now.Unix }}{{ end }}"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
<script src="{{"js/modernizr.custom-3.6.0.js" | relURL}}{{ if not .Site.Params.disableAssetsBusting }}?{{ now.Unix }}{{ end }}"></script>
|
||||
<script src="{{"js/learn.js" | relURL}}{{ if not .Site.Params.disableAssetsBusting }}?{{ now.Unix }}{{ end }}"></script>
|
||||
<script src="{{"js/hugo-learn.js" | relURL}}{{ if not .Site.Params.disableAssetsBusting }}?{{ now.Unix }}{{ end }}"></script>
|
||||
<script src="{{"js/relearn.js" | relURL}}{{ if not .Site.Params.disableAssetsBusting }}?{{ now.Unix }}{{ end }}"></script>
|
||||
<script src="{{"js/hugo-relearn.js" | relURL}}{{ if not .Site.Params.disableAssetsBusting }}?{{ now.Unix }}{{ end }}"></script>
|
||||
{{ if (or (and (ne .Params.disableMermaid nil) (not .Params.disableMermaid)) (not .Site.Params.disableMermaid)) }}
|
||||
{{ if isset .Params "customMermaidURL" }}
|
||||
<script src="{{ .Params.customMermaidURL }}"></script>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
<p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fas fa-heart"></i></a> from <a href="https://getgrav.org">Grav</a> and <a href="https://gohugo.io/">Hugo</a></p>
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn"><i class="fas fa-heart"></i></a> from <a href="https://gohugo.io/">Hugo</a></p>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
HUGO_VERSION = "0.72.0"
|
||||
|
||||
[context.production.environment]
|
||||
HUGO_BASEURL = "https://learn.netlify.app/"
|
||||
HUGO_BASEURL = "https://relearn.netlify.app/"
|
||||
|
||||
[context.deploy-preview]
|
||||
command = "hugo -s exampleSite -b $DEPLOY_PRIME_URL"
|
||||
|
|
|
|||
21
theme.toml
21
theme.toml
|
|
@ -1,21 +1,16 @@
|
|||
# theme.toml template for a Hugo theme
|
||||
# See https://github.com/spf13/hugoThemes#themetoml for an example
|
||||
|
||||
name = "Learn"
|
||||
name = "Relearn"
|
||||
license = "MIT"
|
||||
licenselink = "https://github.com/matcornic/hugo-theme-learn/blob/master/LICENSE.md"
|
||||
description = "Documentation theme for Hugo, based on Grav Learn theme"
|
||||
homepage = "https://github.com/matcornic/hugo-theme-learn/"
|
||||
repo = "https://github.com/matcornic/hugo-theme-learn"
|
||||
tags = ["documentation", "grav", "learn", "doc", "search"]
|
||||
licenselink = "https://github.com/McShelby/hugo-theme-relearn/blob/master/LICENSE.md"
|
||||
description = "Documentation theme for Hugo"
|
||||
homepage = "https://github.com/McShelby/hugo-theme-relearn/"
|
||||
repo = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
tags = ["documentation", "grav", "learn", "relearn", "doc", "search"]
|
||||
features = ["documentation", "menu", "nested sections", "search", "mermaid"]
|
||||
min_version = 0.25
|
||||
|
||||
[author]
|
||||
name = "Mathieu Cornic"
|
||||
homepage = "https://matcornic.github.io/"
|
||||
|
||||
[original]
|
||||
name = "Grav Learn"
|
||||
homepage = "https://learn.getgrav.org/"
|
||||
repo = "https://github.com/getgrav/grav-learn"
|
||||
name = "Sören Weber & others"
|
||||
homepage = "https://github.com/McShelby"
|
||||
|
|
|
|||
Loading…
Reference in a new issue