Commit graph

601 commits

Author SHA1 Message Date
Sören Weber
f910477160
swagger: add support for oas/swagger documentation #226
basic swagger integration
2022-03-27 18:42:11 +02:00
GitHub Actions Bot
b427b9a383 Ship tag 3.2.1 2022-03-25 15:46:46 +00:00
GitHub Actions Bot
d5ae0ccd68 Ship tag 3.2.0 2022-03-19 19:23:28 +00:00
Sören Weber
938debb1d9
mermaid: support differing themes for color variant switch #219 2022-03-19 20:18:21 +01:00
Sören Weber
e92bf08ebf
Merge remote-tracking branch 'origin/main' 2022-03-16 22:44:45 +01:00
Sören Weber
dde1fe5241
mermaid: load javascript on demand #218 2022-03-16 22:40:38 +01:00
GitHub Actions Bot
bd18cb5c3b Ship tag 3.1.1 2022-03-16 07:02:37 +00:00
Sören Weber
a33dd25245
docs: add missing separator 2022-03-15 21:53:11 +01:00
GitHub Actions Bot
90a8f8878d Ship tag 3.1.0 2022-03-15 20:01:29 +00:00
Sören Weber
666bf335d0
docs: finalizing README for next release 2022-03-15 20:59:24 +01:00
Sören Weber
ea8b527f25
mobile: fix navigation UX #209 #210 2022-02-28 01:19:32 +01:00
GitHub Actions Bot
5571cdd0c5 Ship tag 3.0.4 2022-02-24 23:20:57 +00:00
GitHub Actions Bot
d2418199d7 Ship tag 3.0.3 2022-02-23 22:34:35 +00:00
GitHub Actions Bot
50ff97985c Ship tag 3.0.2 2022-02-23 14:07:11 +00:00
GitHub Actions Bot
fc11cd37be Ship tag 3.0.1 2022-02-23 12:07:51 +00:00
GitHub Actions Bot
5058d5160c Ship tag 3.0.0 2022-02-22 23:23:23 +00:00
Sören Weber
bad3af5889
docs: full sized images 2022-02-22 18:33:51 +01:00
Sören Weber
f646a885cf
docs: high-res screenshots 2022-02-22 18:21:20 +01:00
Sören Weber
b2481dc4b1
docs: announce dark mode #188 2022-02-22 00:18:56 +01:00
Sören Weber
5fc705d430
docs: clarification #177 2022-02-22 00:07:21 +01:00
Sören Weber
0b01fc7eb5
docs: cleanup #188 2022-02-22 00:04:16 +01:00
Sören Weber
78abe914e0
variant: allow page browsing with custom theme #188 2022-02-21 23:11:04 +01:00
Sören Weber
f2b09e0980
variant: add reset functionality #188 2022-02-21 01:00:23 +01:00
Sören Weber
3b0e21949a
variant: show generator even if no themeVariant is configured #188 2022-02-21 00:35:50 +01:00
Sören Weber
0e61737c53
variants: release generator to public #188 2022-02-21 00:24:22 +01:00
Sören Weber
442a4f4832
variant: move scripts to own file #188 2022-02-20 23:58:16 +01:00
Sören Weber
c31edb7f1f
variant: only export generated colors if changed from parent #188 2022-02-20 17:33:16 +01:00
Sören Weber
3beb0bb18c
variant: fix arrow directions in generator #188 2022-02-20 00:10:08 +01:00
Sören Weber
83393ef5b8
variant: add download for generator #188 2022-02-19 14:21:16 +01:00
Sören Weber
864d1d83ab
variant: fix standalone colors in generator #188 2022-02-19 01:24:35 +01:00
Sören Weber
88a7b03b4f
variant: fix mapping #188 2022-02-19 00:53:12 +01:00
Sören Weber
e9fa08dcf7
variant: build a color variant generator #188 2022-02-19 00:46:34 +01:00
Sören Weber
ff06a8ad41
docs: clarify releasenotes 2022-02-17 20:38:47 +01:00
Sören Weber
269fd5ed95
theme: rework color boxes for dark mode #175 2022-02-16 01:38:44 +01:00
Sören Weber
691f9a9334
docs: clarification 2022-02-15 09:01:35 +01:00
Sören Weber
949429faab
nav: rework edit button #151 2022-02-15 00:22:34 +01:00
Sören Weber
08ef8b70c7
docs: clarification for syntax highlightning theme switch 2022-02-14 22:32:53 +01:00
Sören Weber
9eb44953d9
theme: change default colors to Relearn defaults #181 2022-02-14 22:19:38 +01:00
Sören Weber
8ddeec4b7a
docs: add latest features 2022-02-14 21:44:01 +01:00
Sören Weber
9fa21358d5
docs: reword #178 2022-02-13 02:03:53 +01:00
Sören Weber
8c1a7304f9
theme: add a theme selector #178 2022-02-13 01:53:23 +01:00
Sören Weber
4fda7916ff
menu: set footer position at bottom of screen #177 2022-02-12 23:14:33 +01:00
Sören Weber
9ea06563be
theme: support for dark mode #175 2022-02-11 00:59:40 +01:00
Sören Weber
f32eb1af93
docs: mention chroma themes CSS --MAIN-CODE colors #174 2022-02-08 21:34:35 +01:00
Sören Weber
f16fcdd7fd
syntax highlight: fix comments for CSS colors 2022-02-08 08:38:09 +01:00
GitHub Actions Bot
29c2b29f6c Ship tag 2.9.6 2022-02-07 21:59:09 +00:00
GitHub Actions Bot
0cfab810f1 Ship tag 2.9.5 2022-02-07 21:54:05 +00:00
GitHub Actions Bot
f246e3e0bd Ship tag 2.9.4 2022-02-06 01:17:02 +00:00
GitHub Actions Bot
fe2504636e Ship tag 2.9.3 2022-02-06 01:10:57 +00:00
Sören Weber
676ba8a7bb
exampleSite: arrr, let pirrrates rrread sites from subfolder with canonifyURLs=false #163 2022-02-06 01:59:26 +01:00
GitHub Actions Bot
3fbf06aabd Ship tag 2.9.2 2021-11-26 09:57:28 +00:00
Sören Weber
7a5ef80c09
docs: fix typo 2021-11-24 12:01:36 +01:00
GitHub Actions Bot
b6f9f5703e Ship tag 2.9.1 2021-11-22 11:11:46 +00:00
Sören Weber
d4362ba997
docs: fix in migration regex #156 2021-11-20 11:26:04 +01:00
Sören Weber
f91b102e03
docs: manual changelog addition #156 2021-11-19 23:47:09 +01:00
GitHub Actions Bot
743fa5bd8f Ship tag 2.9.0 2021-11-19 22:43:06 +00:00
Sören Weber
b91b555aa0
relref: fix inconsistent behaviour #156
by removing our own implementation fo ref/relref
2021-11-19 23:37:19 +01:00
GitHub Actions Bot
a3c8eec28c Ship tag 2.8.3 2021-11-09 20:38:58 +00:00
GitHub Actions Bot
2bfbd0c38c Ship tag 2.8.2 2021-11-08 15:55:08 +00:00
GitHub Actions Bot
da99510f6e Ship tag 2.8.1 2021-11-04 18:28:07 +00:00
GitHub Actions Bot
8a90e237f3 Ship tag 2.8.0 2021-11-03 21:03:39 +00:00
Sören Weber
147b97fac0
docs: update notice for removed font #83 2021-11-03 21:51:25 +01:00
Sören Weber
63dccef035
toc: make omitting disableToc behave as the former default #133 2021-11-03 20:44:23 +01:00
Andreas H
beb80e48fc added Documentation for disableToc in config.toml 2021-11-03 11:10:35 +01:00
Sören Weber
70e7e603f8
theme: make favicon configurable #2 2021-10-30 22:00:46 +02:00
GitHub Actions Bot
22180dcf07 Ship tag 2.7.0 2021-10-24 11:08:14 +00:00
Sören Weber
85f55aaceb
docs: updated screenshots
because of earlier changes to color
2021-10-24 13:01:01 +02:00
Sören Weber
96d284eb8b
docs: unmention min Hugo version
as this is not verfied anymore and most likely outdated
2021-10-24 11:44:07 +02:00
Sören Weber
3fe72e76e1
docs: announce new notice parameter #124 2021-10-24 11:41:12 +02:00
GitHub Actions Bot
d1a935c299 Ship tag 2.6.0 2021-10-21 23:18:13 +00:00
Sören Weber
69497ee14e
docs: migration hint for serving from subdirectory #120 2021-10-17 23:17:13 +02:00
Sören Weber
d673b2c240
theme: generate correct links if theme served from subdirectory #120 2021-10-17 23:03:41 +02:00
Sören Weber
227e9ccbf2
wildspace 2021-10-12 17:20:45 +02:00
Sören Weber
aa5875d5ca
Ship tag 2.5.1 2021-10-12 16:48:09 +02:00
Sören Weber
7c1dd4c32c
docs: add missing code colors to documentation #113 2021-10-10 17:28:13 +02:00
Sören Weber
5bbeb9445c
Ship tag 2.5.0 2021-10-08 19:33:45 +02:00
Sören Weber
788823920c
syntax highlight: provide default colors for unknown languages #113 2021-10-08 19:18:05 +02:00
Sören Weber
992cfb0b8b
Ship tag 2.4.1 2021-10-07 21:30:10 +02:00
Sören Weber
0ca4005cfb
Ship tag 2.4.0 2021-10-07 21:24:12 +02:00
Sören Weber
5d515e9d17
docs: what's new page #103 2021-10-07 21:19:55 +02:00
Sören Weber
dffc0cb230
theme: simplify stylesheet for color variants #107 2021-09-30 00:17:16 +02:00
Sören Weber
80a3cb9756
theme: equal rights for h6 #92 2021-09-29 00:24:54 +02:00
Sören Weber
16b346c646
menu: frontmatter option to change sort predicate #98 2021-09-27 22:03:10 +02:00
Sören Weber
5d98f7d31f
hidden pages: remove from taxonomy #102 2021-09-24 06:59:28 +02:00
Sören Weber
3d0554124a
menu: add default setting for menu expansion #97 2021-09-23 22:27:58 +02:00
Sören Weber
891ecac371
Ship tag 2.3.2 2021-09-20 22:25:47 +02:00
Sören Weber
57fad461eb
Ship tag 2.3.2 2021-09-20 22:23:05 +02:00
Sören Weber
a020acab09
docs: rename history pirate translation #91 2021-09-20 22:21:33 +02:00
Sören Weber
354bb1cdf1
Ship tag 2.3.1 2021-09-20 22:09:34 +02:00
Sören Weber
02c72c9f31
docs: rename english pirate translation to avoid crash on rendering #90 2021-09-20 22:04:35 +02:00
Sören Weber
6e61a7e1e4
docs: edit changelog after release 2021-09-13 21:20:06 +02:00
Sören Weber
c4e5ed068a
Ship tag 2.3.0 2021-09-13 21:15:23 +02:00
Sören Weber
5574ec073e
docs: showcase multilang feature #87
Arrr, Pirrrate trrranslat'n
2021-09-11 15:46:14 +02:00
Sören Weber
5818228df3
Ship tag 2.2.0 2021-09-10 01:15:46 +02:00
Sören Weber
fed2e0392c
sitemap: hide hidden pages from sitemap and SEO indexing #85 2021-09-09 22:26:24 +02:00
Sören Weber
d2051088d5
Ship tag 2.1.0 2021-09-07 21:46:42 +02:00
Sören Weber
234412e2d2
docs: add new templates #78 2021-09-07 21:32:21 +02:00
Sören Weber
97336b2339
search: disable search in hidden pages #76
- invert config flag to streamline with other flags
- invert default value to emulate pre-patch behaviour
2021-09-03 20:01:46 +02:00
Helder Pereira
c75e5532f9 Fix index.json encoding 2021-08-31 10:45:33 +01:00
Sören Weber
9bc3f4e416
docs: remove internal issue from changelog 2021-08-28 12:32:29 +02:00
Sören Weber
7315c6036c
Ship tag 2.0.0 2021-08-28 12:22:53 +02:00
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