Commit Graph

18 Commits

Author SHA1 Message Date
David Karlsson 210ac7bb11 fix: add scroll margin for h1s
h1 elements with IDs need a scroll margin to account for the header and
margin height. These anchors are linked automatically by Algolia.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-11-23 12:27:31 +01:00
David Karlsson fd264a9df3 search: add docsearch container class and h1 ids
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-11-22 20:42:52 +01:00
David Karlsson a0dca716e9
Revert "search: add a stronger main content identifier" 2023-11-10 15:37:39 +01:00
David Karlsson 72a1be8ec1 search: add a stronger main content identifier
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-11-10 13:34:25 +01:00
David Karlsson f64276790d feat: numbered lines for code blocks
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-10-30 20:48:59 +01:00
David Karlsson f7bbe06d27 feat: special rendering for codeblock variables
This change adds special rendering for variables in codeblocks.
Variables (placeholder values in examples subject to change)
can be denoted using the following syntax:

    <VARIABLE_NAME>

Using this format will render the variable in a special color, and
without the angle brackets, akin to:

    \033[95mVARIABLE_NAME\033[39m

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-10-13 20:17:16 +02:00
David Karlsson 26ee37b52a feat: add image border as query param
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-10-02 13:08:40 +02:00
David Karlsson 2eb97d7fe7 fix: use links with leading slash as-is
Links that started with a slash were being prepended the URL hostname
and rendered as absolute links before. This caused our link checker to
miss broken links that contained a leading slash.

This change fixes this issue by rendering links with a leading slash as-is,
without modification.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-09-29 21:06:55 +02:00
David Karlsson d5420c616e
Merge pull request #18310 from dvdksn/style-dds-updates
styling updates
2023-09-28 11:11:01 +02:00
David Karlsson 0905e312e3 chore: remove unused templates
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-09-28 10:56:12 +02:00
David Karlsson 0eca2035e7 fix: add no-select to external link icon
Prevents users from having the icon ligature text included in
clipboard text when copying text from the docs site.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-09-28 10:36:49 +02:00
David Karlsson d8c4f4f353 fix: ignore empty default values for cli flags
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-09-15 16:19:10 +02:00
David Karlsson b5f365e0ec style: center images and adjust border radius 💅
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-31 16:44:15 +02:00
David Karlsson 57c9b961fe js: fix copy function for multiline code blocks
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-23 11:19:53 +02:00
David Karlsson 1f2062db67 fix: add logo background for api docs
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-22 15:03:22 +02:00
David Karlsson 1c6f0ee337
hugo: fix edge case causing duplicate h1 (#17959)
Some documents are missing a `title` front matter,
and instead use an H1 from the document body.
This change introduces a fix to render an external
h1 only if the front matter field is set.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-22 10:48:51 +01:00
David Karlsson 2284afe898 hugo: fix html escape for headings
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-22 11:27:27 +02:00
David Karlsson a0d21ade2f migrate to hugo
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-22 09:41:02 +02:00