Commit graph

107 commits

Author SHA1 Message Date
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