docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
64,577 Commits 13 Branches 28 Tags 824 MiB
Commit Graph

111 Commits

Author SHA1 Message Date
David Karlsson b21e0573af hugo: add support for absolute markdown links 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-06-13 12:56:42 +02:00
David Karlsson 5fe793f3a5 search: exclude hidden pages from index 
Hidden pages (pages excluded from the sitemap) shouldn't be included in
the pagefind index.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-05-24 16:12:43 +02:00
David Karlsson 97307d4c66 search: pagefind v1.1.0 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-05-23 14:05:59 +02:00
David Karlsson bbb894f3e4
Merge pull request #19973 from dvdksn/fix-toc-html 
fix: pass heading text through md renderer
 2024-05-11 14:17:08 +02:00
Michael Irwin efadb1fdcc
Fix URL used for images in twitter/og previews (#19989) 
* Fix URL used for images in twitter/og previews

* Use absURL to create absolute URLs for meta tag URLs

* Update other uses of base URL generation to use absURL helper
 2024-05-08 09:07:42 +02:00
David Karlsson 401468ac4c fix: pass heading text through md renderer 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-05-06 17:36:56 +02:00
David Karlsson f6a44142c1
Merge pull request #19602 from dvdksn/fuse-search 
hugo: use fuse.js search instead of algolia
 2024-04-30 12:15:11 +02:00
David Karlsson 0a7cb792ec
Merge pull request #19854 from dvdksn/scout-prometheus-exporter 
scout: metrics exporter endpoint
 2024-04-29 14:18:59 +02:00
David Karlsson 6ccbfa3f64 hugo: use fuse.js search instead of algolia 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-26 14:36:13 +02:00
David Karlsson f2b49281d9 fix: copy codeblock 
JavaScript methods were lowercased in a bad rebase

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-25 18:56:56 +02:00
David Karlsson 5f563c6c41 fix: sidebar-width sm screens 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-25 15:50:09 +02:00
David Karlsson 14b42c807b hugo: add support for figure titles 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-25 15:01:13 +02:00
David Karlsson 7755120664 fix: prune double leading slash in favicon url 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-25 12:08:28 +02:00
David Karlsson 86dbe42ff3
fix: cap left-hand sidebar to 300px max-width (#19870) 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-25 10:35:52 +01:00
David Karlsson 6e181ff28a fix: copy codeblocks for powershell 
Handle PowerShell prompt char (>) and PS1 script syntax for env var
assignments

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-24 23:04:36 +02:00
David Karlsson 1fb862bcf9 hugo: improve site layout on medium screens 
- Keep the top-nav menu on medium screens
- Keep the sidebar navigation on medium screens
- Keep the right-hand toc on large screens
- Adjust breakpoints

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-24 18:14:02 +02:00
David Karlsson 46a3512a54 hugo: css overhaul 
- Remove manual breakpoint definitions and use tailwind defaults
- Fix various overflow and other rendering issues

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-24 18:14:02 +02:00
David Karlsson ccb50a8467 hugo: add tags 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-23 10:47:54 +02:00
David Karlsson 5f6848ae8b hugo: add support for code block titles 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-11 16:19:22 +02:00
David Karlsson 66b5b990de hugo: add collapse attribute for code blocks 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-03 14:06:21 +02:00
David Karlsson 4267ce33e4 hugo: use "text" as a fallback lang for codeblocks 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-04-02 17:43:50 +02:00
David Karlsson df0455d16f hugo: improve build performance 
use cached partials for repeat templates and icons

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-03-04 16:05:28 +01:00
David Karlsson d29dbaf482 style: design updates march 2024 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-03-04 11:58:08 +01:00
David Karlsson 51c1bedfb1 cli: add subcommand links 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-29 16:08:10 +01:00
David Karlsson c04c83ff58 cli: don't render options table if only hidden options 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-29 15:13:29 +01:00
David Karlsson 56679aec98 cli: alternative alias rendering 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-23 15:11:05 +01:00
David Karlsson adcb1edfa7 chore: style and script refactor 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-23 15:03:27 +01:00
David Karlsson 846bf77f93 cli: hoist content in CLI stubs to top 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-15 12:36:56 +01:00
David Karlsson 75dc05388d cli: add links for cli flags 
... and remove the column for shorthands.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-08 16:00:01 +01:00
David Karlsson ee3c9c6448 site: add lazy loading for images 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-07 17:10:16 +01:00
David Karlsson f6191387b6 chore: remove mermaid.js 
We're not using mermaid for diagrams anymore so we can prune the
dependency.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-01 09:46:24 +01:00
David Karlsson d6627bcbce fix: use flexbox to simplify templates and fix overflow on mobile 
The grid col templates weren't working correctly, switched to flexbox to
make it easier to understand and work better on smaller screens.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-28 23:22:17 +01:00
David Karlsson ce9e6317fc css: prevent horizontal overflow on md/sm/xs screens 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-25 21:12:07 +01:00
David Karlsson 047a48d0ab fix: sidebar background in light mode 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-25 14:22:09 +01:00
David Karlsson 0ff3eb3aab hugo: migrate font icons to svg 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-25 12:28:38 +01:00
David Karlsson ff459f0dcd css: improve styles to reduce layout shifts 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-25 08:35:33 +01:00
David Karlsson 15485594b4 hugo: do not render hidden cli options 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-24 15:51:18 +01:00
David Karlsson f0260dbf20 hugo: display command aliases 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-19 16:13:36 +01:00
David Karlsson 04a5ee0915 hugo: use icon utility class for external links 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-08 13:25:03 +01:00
David Karlsson 834db3da41 css: refactor and improve styles 
- Refactoring styles to prevent unwanted specificity issues by using
  tailwind directives
- Improve color consistency for code blocks and other components by
  replacing adhoc hex values with theme colors

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-03 14:54:57 +01:00
David Karlsson 77b0a087c5 fix: remove heading IDs for h1 elements 
Closes #18983

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2023-12-28 20:55:13 +01:00
David Karlsson 72725b7708 hugo: handle multiline flag descriptions 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2023-12-13 21:14:31 +01:00
David Karlsson c710541f28 a11y: add aria-hidden to external link icons 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2023-12-11 09:43:11 +01:00
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