Commit graph

468 commits

Author SHA1 Message Date
Sören Weber
da9be46f31
docs: improve hidden page examples 2021-08-26 20:54:31 +02:00
Helder Pereira
6efb50a010 Add menu-pre and menu-post templates 2021-08-25 13:54:52 +01:00
Sören Weber
2e445d2584
docs: make shortcodes main page a chapter #54
to adjust with the rest of the page structure
2021-08-25 14:49:46 +02:00
Sören Weber
1fda1d8692
children: add parameter for container style #53 2021-08-25 14:45:01 +02:00
Sören Weber
15cfc82ddb
theme: convert front matter to TOML #52
remove date field
2021-08-25 13:33:29 +02:00
Sören Weber
a69236d160
menu: control sub-menu expansion #49 2021-08-25 00:10:09 +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
0d66a97284
code highlighter: avoid unstyled blocks for indention in docs #32 2021-08-24 00:25:15 +02: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
c4215dd154
include: new shortcode #43
necessary for inclusion of CHANGELOG.md
2021-08-23 22:16:08 +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
5c667b3d07
code highligher: switch to standard hugo highlighter #32
Since a while, Hugo has its own mechanism for code highlightning.

We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files.

This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results.

This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information.

Another advantage is the huge list of supported languages which by far exceeds our current list.

On the downside, this is a breaking change because our current color theme isn't supported by Hugo.
2021-07-26 11:50:34 +02:00
Sören Weber
bb5541f791
attachments: sort output #23 2021-07-26 11:14:27 +02:00
Sören Weber
c62a9d1958
docs: unifiy mermaid, expand and notice docs #31 2021-07-26 10:10:10 +02:00
Sören Weber
4b4a6bc5e2
docs: Cleanup markdown reference page #31 2021-07-26 01:47:25 +02:00
Sören Weber
c161a2c03d
docs: add missing lightbox showcase #31 2021-07-25 22:41:53 +02:00
Sören Weber
4d5d7f6815
attachments: support i18n for attachment size #21 2021-07-17 12:37:24 +02:00
Sören Weber
050837bc3f
expand: add option to open on page load #25 2021-07-16 23:51:11 +02:00
Sören Weber
5f7cba3d97
rework expand documentation 2021-07-16 22:35:20 +02:00
Sören Weber
86317356d6
notice: rework documentation 2021-07-16 22:04:22 +02:00
Sören Weber
a0084ecf96
notice: support multiple blocks in one box #15 2021-07-16 19:48:48 +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
99d107181c
remove google analytics & others from docs #1 2021-07-02 23:15:42 +02:00
Sören Weber
1b06d27608
pan and zoom for mermaid graphs #9 2021-07-02 23:01:38 +02:00
Sören Weber
2219b54ebe
update mermaid docs #5 2021-07-02 22:05:35 +02:00
Sören Weber
120fd7929e
mermaid git graph causes severe loading issues #5
this is a mermaid bug, we just remove the graph to don't
receive bug reports that should be filed in the mermaid repo
2021-07-02 21:56:00 +02:00
Sören Weber
88611e0bf0
document mermaid options #4 2021-07-02 18:15:26 +02:00
Sören Weber
2ab6982425
Bring back mermaid code fences in docs #6 2021-07-02 17:40:05 +02:00
Sören Weber
c18a14facf
mermaid: fix official url in docs #11 2021-07-02 16:41:20 +02:00
Sören Weber
bd9983978b
Hardening examplesite against misconfiguration 2021-07-01 21:47:17 +02:00
Sören Weber
146965c497
Reworking screenshots after rebranding 2021-07-01 16:25:08 +02:00
Sören Weber
022ad07ec1
Contributers cleanup #1 2021-07-01 14:57:26 +02:00
Sören Weber
e8340249df
Docs adjustments #1 2021-07-01 14:35:27 +02:00
Sören Weber
9cc3f7103c
Compliance: Rename branch master to main 2021-07-01 11:01:51 +02:00
Sören Weber
500c3e5120 Credits added 2021-06-30 21:57:53 +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
Swen Wenzel
0b5bb6e7b3
Implement tab views (#386)
Tab views from @swenzel
2021-03-16 17:21:57 +00: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
Susan Potter
699c9fdf9f
Upgrade mermaid-js/mermaid @ 0918b97 (v8.8.0) (#443)
* Upgrade mermaid-js/mermaid @ 0918b97

* Update exampleSite with new mermaid graph (stateDiagram-v2) example

* Update content of mermaid.js with officially distributed v8.8.0 minified version
2020-09-10 17:12:32 +01:00
Alan Cha
66feffbd41 Fix typo 2020-09-10 15:14:51 +01:00
Alan Cha
41a3f928f0 Fix children shortcode table
HTML does not seem to display properly in the table
2020-09-10 15:09:35 +01:00
Alan Cha
863876230c Remove extra space 2020-09-10 15:03:43 +01:00
Alan Cha
37399cf84e Remove extra space 2020-09-10 15:03:04 +01:00
Matthew Taylor
6dea56b871 Add additional documentation for code highlighting 2020-06-01 15:08:15 +01:00
Matthew Taylor
9c080a39d8 Fix various markdown warnings 2020-06-01 14:59:19 +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
Jian
3ea5bca755 Added flag to turn off image featherlight 2020-02-01 22:58:17 +00:00
Amir
f629d2fadc add inteliver documentation showcase 2020-02-01 22:44:56 +00:00
Mathieu Cornic
f206f1fc87
Merge pull request #336 from geoffreybauduin/patch-1
Incorrect english in notice documentation
2019-12-22 21:37:56 +01:00
Mathieu Cornic
9898e35f84
Merge pull request #339 from owulveryck/patch-1
fix extra spaces in the description
2019-12-22 21:37:19 +01:00
Mathieu Cornic
073658ca3c
Merge pull request #343 from hucste/patch-2
Fix: typos
2019-12-22 21:36:49 +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
1bc1eef887
Fix: typos
Corrections de plusieurs erreurs typo ! :p
2019-11-06 14:17:39 +00:00
HUC
aa15edd289
Fix: typo
Correction du terme "améliorations"
2019-11-06 13:52:55 +00:00
Olivier Wulveryck
cce05a0d42
fix extra spaces in the description 2019-11-02 08:20:59 +01:00
Geoffrey Bauduin
85e0b14c4e
Fixing incorrect english in notice documentation 2019-10-18 12:47:11 +02:00
Ross Jacobs
ce74bb8f9a Added Tshark.dev as example site 2019-08-27 23:59:48 +01:00
Sam Crauwels
95c78a8e12
Fix type lines 364 and 369
with code > as code
2019-06-17 01:43:58 +02:00
Boris Bera
24da9d9e1d Fix all images to use the /en/ path 2019-05-06 13:44:27 -04:00
Matthew Taylor
e7a190392a Merge branch 'master' of https://github.com/pdelaby/hugo-theme-learn into pdelaby-master 2019-03-25 21:01:40 +00:00
Delaby Pierre
6207c44b5c PR#196 : Fix english typos and hide the 'tags' div when not needed 2019-03-16 10:55:18 +01: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
Massimeddu Cireddu
84931c1312 Update documentation 2019-03-15 16:03:59 +00:00
Delaby Pierre
5f53dfaa15 Add documentation an theme variants 2018-11-29 09:34:55 +01:00
Matthew Taylor
fd4651dee1 Fix error in blockquote documentation 2018-11-01 20:15:46 -04:00
Matthew Taylor
64fc30ecde Add disableBreadcrumbs and disableNextPrev to English documentation 2018-10-22 22:57:19 -04:00
Mathieu Cornic
17bdacdd9f fix #179: replace github images ressource by https instead of http 2018-10-10 19:29:55 +02: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
300c1614ec Merge branch 'master' of https://github.com/matcornic/hugo-theme-learn 2018-08-10 11:19:30 +02:00
Mathieu Cornic
a690228179 fix conflict 2018-08-10 11:03:31 +02:00
Mathieu Cornic
d34944e827
Merge pull request #145 from nonumeros/master
TranslationBaseName replaced for Name on archetypes template
2018-08-10 10:41:45 +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
Mathieu Cornic
d7100a0c54
Merge pull request #150 from afs2015/patch-1
Updated _index.en.md for typo "names"
2018-08-10 10:20:47 +02:00
Mathieu Cornic
65d597d697 fix #153 : page not found on ex site 2018-08-10 10:18:13 +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
nonumeros
60dd68fc94 TranslationBaseName replaced for Name on archetypes template 2018-05-27 13:29:39 -04:00
Matthew Taylor
efbd24b9be Basic usage instructions for Font Awesome library 2018-02-19 16:33:30 +00:00
Matthew Taylor
cca7fdeeb0 Modify fontawesome selectors for v5.x 2018-02-19 16:33:30 +00: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
Mathieu Cornic
72a2c46788
fix typo 2018-01-17 22:54:01 +01:00
Manuel Reithuber
4a8d501baf added documentation for the menuTitle attribute 2017-11-19 14:48:37 +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
f2260fdace feat: fix #58 - add site param shortcode 2017-09-04 22:24:36 +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
05a71f5874 fix little mistake in french translation 2017-08-21 00:26:40 +02:00
matcornic
375e7c0005 feat: fix doc mistake 2017-08-20 23:58:41 +02:00
matcornic
b3d783e946 translation of children shortcode 2017-08-20 23:44:34 +02:00
matcornic
8e15e782f7 doc translation 2017-08-20 23:44:34 +02:00
matcornic
761af8653d doc translation 2017-08-20 23:44:34 +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
389b9858a4 feat(attachments): rename styles with colors + delete red style + add grey style 2017-08-20 23:43:47 +02:00
matcornic
3e61961bfa feat: add children shortcode 2017-08-20 23:43:47 +02:00
matcornic
951e8fb40e feat: add shortcode for attachments 2017-08-20 23:43:47 +02:00
matcornic
157e3ac512 feat: add full i18n. Select desired language in the site automatically 2017-08-20 23:43:46 +02:00
matcornic
85c046f527 remove link in docs because of error 2017-08-20 23:43:45 +02:00
matcornic
1227b1d3ed feat: renamed docs example to exampleSite 2017-08-20 23:43:45 +02:00