Commit Graph

109 Commits (413edb47083df3afa26f08588c1636494db6b969)

Author SHA1 Message Date
Robert Kaussow a056805a30
docs: migrate hints to named attributes (#393) 2022-04-30 14:28:48 +02:00
Robert Kaussow f6966b8513
feat: add optional hint/admonition icons (#383)
BREAKING CHANGE: The types of the `hint` short code have been renamed to `[note|tip|important|caution|warning]` the old types `[info|ok|warning|danger]` are still working, but should be considered as deprecated.

BREAKING CHANGE: The `hint` short code is using named arguments now. You have to change, e.g. `{{< hint warning >}}` to `{{< hint type=warning >}}`.
2022-04-23 15:14:42 +02:00
Robert Kaussow a4d1f51b1b
fix template auto-formatting 2022-02-22 21:45:14 +01:00
Robert Kaussow 928906b251
remove unused page resources 2022-02-17 20:45:22 +01:00
Robert Kaussow 7df6057ca0
feat: add new option geekdocContentLicense (#346) 2022-02-16 11:53:13 +01:00
Robert Kaussow c9f809ca19
fix: fix edit page link and auto-detect contentDir (#343)
BREAKING CHANGE: With support of the multilingual mode, we broke the `edit page` links, as the content directory was statically hard-coded into the `GeekdocEditPath` parameter. To get the correct content directory, regardless of the language or a disabled multilingual mode, we now use Hugo's built-in `.Site.Params.contentDir` parameter. Therefor, you have to remove the hard-coded `/content` part from the `geekdocEditPath` parameter in the configuration of your project.
2022-02-15 20:58:35 +01:00
Robert Kaussow d2668b43f6
refactor: unify title and description handling in meta files (#329) 2022-02-07 10:57:43 +01:00
Robert Kaussow 39df04c78f
docs: fix theme build documentation (#318) 2022-02-03 14:41:42 +01:00
Robert Kaussow 4f3d48c1d9
fix: fix formatting on code links (#316) 2022-02-03 11:42:26 +01:00
Robert Kaussow 30d3c64c41
fix: fix post metadata positioning (#315) 2022-02-03 10:58:37 +01:00
Robert Kaussow 5c22ce57dc
feat: add multilingual mode support (#241)
BREAKING CHANGE:  Layout file renamed ´layouts/partials/page-footer.html → layouts/partials/menu-nextprev.html`. If you use overrides, you might need to change the filenames as well.
2022-01-23 13:21:44 +01:00
Avi Mehenwal 09309a2a3c
docs: add missing option to hints shortcode example (#294) 2022-01-22 14:07:32 +01:00
Robert Kaussow 8a741d82d8
cleanup include shortcode docs 2022-01-10 23:39:19 +01:00
Robert Kaussow e9a07f78d2
docs: document how to use different type in include shortcode (#275) 2022-01-10 23:36:20 +01:00
Robert Kaussow bbfc75ecb0
rework search integration (#262) 2022-01-06 22:52:22 +01:00
Robert Kaussow 5c5e2d59cb
refactor: replace gulp by webpack and npm scripts (#258)
BREAKING CHANGE: We have replaced `gulp` with `webpack` and `npm scripts` to build this theme. If you build it on your own or use build commands during the deployment, you may have to adjust your setup.

BREAKING CHANGE: The `GeekblogIcons` font is using the icon name as Unicode now. As a consequence, you have to replace all references to Icons from this font if you have customized the theme.

BREAKING CHANGE: We have refactored the search integration to split Hugo templates from JavaScript code. To get it working again, you need to adjust the `outputFormats` and `outputs` in your Hugo configuration file, as [documented](https://geekdocs.de/usage/configuration/#site-configuration).
2022-01-06 13:58:10 +01:00
Andreas Deininger 2ac2a9faab
docs: fixed typos and minor textual improvements (#259) 2022-01-05 09:44:06 +01:00
Robert Kaussow 6e7c01e04f
cleanup formatting and docs (#247) 2021-11-24 09:10:26 +01:00
Robert Kaussow 761caeee47
feat: add site parameter `geekdocFileTreeSortBy` to controle filetree menu sorting (#237) 2021-11-12 08:57:07 +01:00
Robert Kaussow 75f56d8fad
feat: add button to copy code blocks (#228)
BREAKING CHANGE: The `--code-max-height` formatting is applied only to code blocks that use syntax highlighting, see [documentation](https://geekdocs.de/features/code-blocks/).
2021-11-07 22:12:14 +01:00
Robert Kaussow 5d0a9c8207
docs: add missing demo image to the img shortcode page 2021-09-29 22:06:46 +02:00
Robert Kaussow 1932053d5a
feat: add microformats (#214) 2021-09-28 20:44:59 +02:00
Robert Kaussow 4bfc17ac9d
chore: normalize default favicons and add docs (#213) 2021-09-27 22:47:13 +02:00
Robert Kaussow d8fba29bb5
feat: add robots template (#203) 2021-09-08 21:48:31 +02:00
Robert Kaussow 3f296625fb
feat: add tags to post pages (#193) 2021-09-01 10:18:00 +02:00
Grayson Orr 1e2413d52d
docs: change theme subdirectory in setup instructions (#188) 2021-08-23 17:48:57 +02:00
Robert Kaussow 57bbc46a47
feat: add optional icon menu to site header (#184) 2021-08-12 18:17:49 +02:00
Robert Kaussow 4bae11bdc6
docs: add missing prefix to icon names 2021-08-01 22:31:47 +02:00
Robert Kaussow 8abe25f3cb
feat: add 'back-to-top' link to site footer (#167)
* feat: add 'back-to-top' link to site footer

* add aria-label to link
2021-07-20 09:58:56 +02:00
Oluf Lorenzen 56a0d44a50
feat: collapse every section (#162)
This allows setting `.Site.Params.GeekdocCollapseAllSections` which then
behaves as if you would have set `.Page.Params.geekdocCollapseSection`
in all sections.

It is a hard positive switch, so you can not override it per section
once enabled.

Co-authored-by: Robert Kaussow <xoxys@rknet.org>

Co-authored-by: Robert Kaussow <xoxys@rknet.org>
2021-07-10 13:17:16 +02:00
Robert Kaussow 9682ef999b
fix: adjust colors to improve accessibility (#159) 2021-07-05 08:42:48 +02:00
Robert Kaussow 550745e727
feat: add katex math typesetting shortcode (#157) 2021-07-01 09:05:26 +02:00
Robert Kaussow 8dbea089dc
add missing button sizes documentation 2021-05-24 15:12:58 +02:00
Robert Kaussow 83b8852b8f
fix wording 2021-05-23 22:30:22 +02:00
Robert Kaussow ac8653a141
docs: fix typos 2021-05-23 17:50:58 +02:00
Robert Kaussow 021eaf7ab6
feat: add sizes 'regular' and 'large' to button shortcode (#135) 2021-05-21 15:51:19 +02:00
Robert Kaussow e629d15607
feat: add page parameter geekdocAlign to control a pages text alignment (#130) 2021-05-19 00:00:57 +02:00
Robert Kaussow cd0cfe37ae
feat: add page parameter geekdocNav to disable navigation sidebar (#129) 2021-05-18 23:10:42 +02:00
Robert Kaussow 7938bc7d97
docs: improve wording of columns shortcode description (#127) 2021-05-18 21:50:28 +02:00
Robert Kaussow a92eb9f0aa
docs: fix typos 2021-05-13 15:17:18 +02:00
Robert Kaussow 8df82947b7
chore: fix capitalization for params in while clause (#108)
BREAKING CHANGE: The minimal required Hugo version was bumped to 0.83.0
2021-05-06 21:42:45 +02:00
Robert Kaussow f102d1e62f
fix typo 2021-04-28 23:34:21 +02:00
Robert Kaussow 59be9a504f
Dark mode (#66) 2021-04-27 23:44:35 +02:00
Robert Kaussow 5eff47c68b
fix: rework site header for better title and decription handling (#98) 2021-04-22 22:07:09 +02:00
Robert Kaussow d51f514b90
feat: add option geekdocProtected to exclude pages from data file (#97) 2021-04-22 21:25:43 +02:00
Robert Kaussow 63e44beef4
chore: replace master by main as default branch
BREAKING CHANGE: We have switched to 'main' as default branch. The 'master' branch is no longer maintained and will be removed after April 30, 2021!
2021-04-11 15:11:59 +02:00
Robert Kaussow 72ffa01363
docs: add known limitations (#94)
* docs: add known limitations

* fix typos
2021-04-11 13:58:06 +02:00
Robert Kaussow a8de42c489
fix: remove relURL from markdown render image hook (#93)
* fix: remove relURL from markdown render image hook

BREAKING CHANGE: As the relURL function in markdown render hooks
caused some unwanted side effects we had to remove it. Related to this
change the behavior for sites deployed to a subdirectory has changed as
well! Please check the [documentation](https://geekdocs.de/usage/getting-started/#sub-directories)
how to workaround subdirectory deployments.

* restructure color-schemes page to work as image bundle example

* fix wording
2021-04-10 15:52:27 +02:00
Robert Kaussow 1ace505d27
feat: add option to include pages using the include shortcode (#92)
BREAKING CHANGE: The include shortcode will render files as Markdown
instead of HTML by default now. While the Markdown renderer should be
able to render HTML as well this might still work as before.

BREAKING CHANGE: The include shortcode option markdown was replaces by
a generic type option that could be used to specify special include
types.
2021-04-10 13:55:03 +02:00
Robert Kaussow 9129b07d2f
add toc to dictionary 2021-04-10 13:06:07 +02:00