Commit graph

150 commits

Author SHA1 Message Date
Sören Weber
c8e7609be8
docs: add migration instructions #42 2021-08-28 12:05:53 +02:00
Sören Weber
3931faa1d5
include: add paramter to hide first heading #43 2021-08-28 10:08:10 +02:00
Helder Pereira
6efb50a010 Add menu-pre and menu-post templates 2021-08-25 13:54:52 +01:00
Sören Weber
15cfc82ddb
theme: convert front matter to TOML #52
remove date field
2021-08-25 13:33:29 +02:00
Helder Pereira
37d314b676 Fix typos in exampleSite 2021-08-24 00:47:18 +01:00
Helder Pereira
c52ef52f2b Fix custom theme's variable typo in --MENU-HOME-LINK-HOVERED-color 2021-08-23 23:51:54 +01:00
Sören Weber
b29f1ce055
theme: adjust leading whitespace and superflous lines 2021-08-24 00:23:52 +02:00
Sören Weber
de7b3d8056
theme: remove typos and superflous whitespace 2021-08-23 23:51:52 +02:00
Sören Weber
42c8ec549b
code highlighter: avoid unstyled blocks in docs #32
The new highlighter does not work to well if no syntax is specified
for the code block / code fence / indention.
See https://github.com/gohugoio/hugo/pull/8917
2021-08-23 23:32:34 +02:00
Sören Weber
32d3d80b80
docs: show CHANGELOG in exampleSite #33 2021-08-23 22:20:29 +02:00
Sören Weber
2a5deb0534
docs: move CHANGELOG into exampleSite #33
that makes it possible to include it into the official documentation
2021-08-23 22:13:16 +02:00
Sören Weber
c31371b871
theme: migration page #42 2021-08-23 21:20:24 +02:00
Sören Weber
e2ae88d0cf
show some mermaid default values in docs #5 2021-07-02 23:18:54 +02:00
Sören Weber
88611e0bf0
document mermaid options #4 2021-07-02 18:15:26 +02:00
Sören Weber
146965c497
Reworking screenshots after rebranding 2021-07-01 16:25:08 +02:00
Sören Weber
9cc3f7103c
Compliance: Rename branch master to main 2021-07-01 11:01:51 +02:00
Sören Weber
494a3c8b7c Repair links after making content single language 2021-06-30 21:30:03 +02:00
Sören Weber
c108d677b4 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 14:56:06 +02:00
Sören Weber
a938c24a63 Removed all but english documentation
to make it maintainable
2021-06-30 14:55:13 +02:00
mirisbowring
6cfd61e0f6
Navigation home option (#381)
* 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>
2020-10-21 17:53:27 +01:00
mirisbowring
023fe7ef2b
Customize mermaid module (#362)
* 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

* 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>
2020-09-11 14:57:25 +01:00
Razon Yang
00f1ca6856
Add the titleSeparator parameter. (#448)
* Add the titleSeparator parameter

* Add a description for the titleSeparator parameter
2020-09-11 09:31:22 +01:00
Matthew Taylor
d4abb3c9a1 Allow custom css files to be loaded by configuration
Previously adding custom css files would require the end user to copy
the header or footer partial into their overrides. They would then
need to maintain that partial into the future.

This config allows a user to provide a list of custom css files to load
into the theme, meaning they do not need to clone the partial.

```
[params]
  custom_css = ["css/foo.css", "css/bar.css"]
```

Inspiration taken from https://discourse.gohugo.io/t/how-to-override-css-classes-with-hugo/3033/4
2020-04-14 11:12:06 +01:00
Roger Lehmann
eb0f29ee44 Updated Installation documentation link.
Since the old link redirects to "Hugo Modules" documentation, which isn't fitting for this kind of theme, I changed it to the short tutorial in the getting started guide. Not perfect but better than having a mismatching guide, confusing users (such as myself).
2020-04-14 11:10:33 +01:00
Mathieu Cornic
349b324d4e
Merge pull request #342 from hucste/patch-1
Fix: typo
2019-12-22 21:36:21 +01:00
Zhao Xiaojie
f616491457 Add Chinese language for this theme 2019-12-04 11:17:39 +08:00
HUC
aa15edd289
Fix: typo
Correction du terme "améliorations"
2019-11-06 13:52:55 +00:00
Boris Bera
24da9d9e1d Fix all images to use the /en/ path 2019-05-06 13:44:27 -04:00
ImgBotApp
26748c29e9 [ImgBot] Optimize images
*Total -- 2,545.56kb -> 1,758.74kb (30.91%)

/static/images/favicon.png -- 1.22kb -> 0.59kb (51.48%)
/exampleSite/content/basics/installation/images/chapter.png -- 85.71kb -> 46.66kb (45.56%)
/exampleSite/content/cont/pages/images/pages-chapter.png -- 243.33kb -> 152.42kb (37.36%)
/exampleSite/content/basics/style-customization/images/red-variant.png -- 380.82kb -> 239.39kb (37.14%)
/exampleSite/content/basics/style-customization/images/blue-variant.png -- 380.01kb -> 238.93kb (37.13%)
/exampleSite/content/basics/style-customization/images/green-variant.png -- 381.74kb -> 240.20kb (37.08%)
/exampleSite/content/cont/pages/images/pages-default.png -- 310.79kb -> 196.47kb (36.78%)
/exampleSite/static/images/showcase/tat.png -- 405.21kb -> 302.69kb (25.3%)
/static/images/gopher-404.jpg -- 215.36kb -> 201.42kb (6.47%)
/images/tn.png -- 141.37kb -> 139.98kb (0.99%)
2019-03-15 16:47:53 +00:00
Matthew Taylor
64fc30ecde Add disableBreadcrumbs and disableNextPrev to English documentation 2018-10-22 22:57:19 -04:00
Mathieu Cornic
7208a5bb13
Merge pull request #158 from wikijm/patch-2
Typing mistake correction
2018-09-10 23:40:14 +02:00
PGP 2F93D5AF
681de6f1fa
Typing mistake correction 2018-09-10 23:20:37 +02:00
PGP 2F93D5AF
df3683e902
Typing mistake correction 2018-09-10 18:46:09 +02:00
Mathieu Cornic
ceed155ab0
Merge pull request #146 from tedyoung/patch-1
Clean up the English language phrasing
2018-08-10 10:41:01 +02:00
Andrew Selzer
3b13e3bbec
Updated _index.en.md for typo "names"
Sentence currently says "just drop off your image in your local `static/images/` folder and names it". This is to change it to "just drop off your image in your local `static/images/` folder and name it"
2018-07-18 14:23:16 -04:00
Ted M. Young
d091a48328
Clean up the English language phrasing
Fixed spelling and awkward phrasing to make it read better.
2018-05-27 15:40:01 -07:00
Mathieu Cornic
735d0f0264
Update _index.en.md 2018-01-28 10:54:02 +01:00
Mathieu Cornic
5dbc270f9b
Merge pull request #117 from mdavids/patch-6
Issue #111 for _index.fr.md
2018-01-23 18:07:54 +01:00
Marco Davids
820eab4111
Issue #111 for _index.fr.md 2018-01-22 22:40:35 +01:00
Marco Davids
0627b9d098
Issue #111 for _index.en.md 2018-01-22 22:39:54 +01:00
Jean-Christophe
209497b45e Added info about 'draft:true' (#74)
Not sure it's the best place to go in the documentation, but I thought this might prevent new Hugo user to wonder why no content was listed.
2017-09-27 16:39:42 +02:00
matcornic
9071837183 fix #61 2017-09-04 21:20:59 +02:00
matcornic
a4f2e0f640 chore: fix image path in doc 2017-09-04 19:18:48 +02:00
matcornic
f2c44bc93e chore: fix spelling mistake 2017-09-04 19:14:13 +02:00
matcornic
5123fb57a2 fix #62: replaced width in % with 'pc' 2017-09-04 19:07:03 +02:00
matcornic
5608a87d71 Translate in french 2017-08-20 23:44:34 +02:00
matcornic
aff3307ff5 add english documentation content 2017-08-20 23:43:50 +02:00
matcornic
6b265c5181 add first content for new documentation 2017-08-20 23:43:49 +02:00
matcornic
157e3ac512 feat: add full i18n. Select desired language in the site automatically 2017-08-20 23:43:46 +02:00
matcornic
1227b1d3ed feat: renamed docs example to exampleSite 2017-08-20 23:43:45 +02:00