Commit Graph

156 Commits

Author SHA1 Message Date
fb905bd6c1
feat: add optional page description to search (#550)
Add optional page description to the search result list. The feature can be enabled by `geekdocSearchShowDescription=true` and is disabled by default. The max length of the description is set to `55` and will be truncated automatically if the limit is exceeded.
2022-12-07 08:57:41 +01:00
e9ece03388
feat: add option to enable or disable the dark mode toggle button (#529) 2022-11-02 15:48:45 +01:00
128a55e974
feat: add option to sort items in properties shortcode (#527)
BREAKING CHANGE: To enable sorting of elements in the `properties` shortcode, it was necessary to change the structure of the properties file. Due to this change, the `properties` object now requires a list of maps instead of a map. A [sample file](https://raw.githubusercontent.com/thegeeklab/hugo-geekdoc/main/exampleSite/data/properties/demo.yaml) can be found in the repository.
2022-11-02 13:01:20 +01:00
73c5f6a6b2
fix: fix multi paragraph admonitions formatting (#526) 2022-11-02 11:03:13 +01:00
c1d8443eed
chore: bump hugo in ci to 0.104.3 (#518) 2022-10-14 12:21:12 +02:00
b9876a8640
feat: add origin size to image shortcode (#490) 2022-09-02 10:58:44 +02:00
e7c4453d45
ci: improve version file and tarball creation (#486) 2022-08-29 22:53:07 +02:00
12c81554ac
feat: support mermaid codeblocks (#485) 2022-08-29 21:52:44 +02:00
Dan Čermák
b642716a8a
docs: fix grammar in theming docs (#481) 2022-08-24 10:30:45 +02:00
Dan Čermák
3b9e4ec10b
docs: fix typo side to site (#480) 2022-08-22 21:02:25 +02:00
1a9fe22d64
feat: add option anchor the the bundle menu (#468) 2022-08-04 21:57:02 +02:00
66d456f552
feat: add column size attribute (#455) 2022-07-11 20:46:01 +02:00
c39eee4368
docs: normalize shortcode documentation (#454) 2022-07-11 20:45:55 +02:00
7195431d8c
fix: improve keyboard accessability for anchors and code blocks (#434) 2022-06-10 21:44:08 +02:00
6545ceb24d
feat: add option geekdocDarkModeCode to enforce dark codeblocks (#429) 2022-05-31 14:14:01 +02:00
33ea5c37a9
feat: render popertylist description as markdown (#426) 2022-05-30 21:40:09 +02:00
brett ohland
61ef82104e
fix: remove table formatting from github gists (#416)
* fix: fix CSS issue with gist embeds

* Addressing PR comments

* remove newline

* simplify selector and add example

* fix spellcheck

* fix markdownlint

Co-authored-by: Robert Kaussow <mail@thegeeklab.de>
2022-05-24 00:37:06 +02:00
6b464202c9
fix: fix formatting issue while using nested toc shortcodes (#415) 2022-05-22 22:07:35 +02:00
6ab98d1da3
feat: add propertylist shortcode (#414) 2022-05-22 22:00:37 +02:00
cb68d35c24
ci: switch to linkchecker (#410) 2022-05-18 18:21:11 +02:00
a056805a30
docs: migrate hints to named attributes (#393) 2022-04-30 14:28:48 +02:00
d724618457
fix custom css icon grid 2022-04-23 15:24:10 +02:00
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
b104d6ac70
refactor: rename class .icon to .gdoc-icon (#379)
BREAKING CHANGE: The class `.icon` was renamed to `.gdoc-icon` to avoid conflicts.
2022-04-18 20:33:23 +02:00
a4d1f51b1b
fix template auto-formatting 2022-02-22 21:45:14 +01:00
928906b251
remove unused page resources 2022-02-17 20:45:22 +01:00
2dbe3a4a5f
fix: add schema.org metadata to docs sections (#347) 2022-02-17 20:44:08 +01:00
7df6057ca0
feat: add new option geekdocContentLicense (#346) 2022-02-16 11:53:13 +01:00
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
d2668b43f6
refactor: unify title and description handling in meta files (#329) 2022-02-07 10:57:43 +01:00
39df04c78f
docs: fix theme build documentation (#318) 2022-02-03 14:41:42 +01:00
4f3d48c1d9
fix: fix formatting on code links (#316) 2022-02-03 11:42:26 +01:00
30d3c64c41
fix: fix post metadata positioning (#315) 2022-02-03 10:58:37 +01:00
2805fbd33a
fix: always fetch menu name from data file (#296) 2022-01-23 22:32:21 +01:00
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
8a741d82d8
cleanup include shortcode docs 2022-01-10 23:39:19 +01:00
e9a07f78d2
docs: document how to use different type in include shortcode (#275) 2022-01-10 23:36:20 +01:00
bbfc75ecb0
rework search integration (#262) 2022-01-06 22:52:22 +01:00
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
6e7c01e04f
cleanup formatting and docs (#247) 2021-11-24 09:10:26 +01:00
761caeee47
feat: add site parameter geekdocFileTreeSortBy to controle filetree menu sorting (#237) 2021-11-12 08:57:07 +01:00
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
5d0a9c8207
docs: add missing demo image to the img shortcode page 2021-09-29 22:06:46 +02:00
1932053d5a
feat: add microformats (#214) 2021-09-28 20:44:59 +02:00
4bfc17ac9d
chore: normalize default favicons and add docs (#213) 2021-09-27 22:47:13 +02:00
d8fba29bb5
feat: add robots template (#203) 2021-09-08 21:48:31 +02:00
fff483ea9e
chore: remove rss link from header (#202) 2021-09-08 21:35:43 +02:00
3f296625fb
feat: add tags to post pages (#193) 2021-09-01 10:18:00 +02:00