kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #48812 from chalin/chalin-im-docsy-0.5.1-2024-11-22 

Upgrade to Docsy 0.5.1 via NPM module
pull/48756/head
Kubernetes Prow Robot 2024-12-31 07:30:13 +01:00 committed by GitHub
parent 7afde847c5 30b92ffc3d
commit ce1d8e21eb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
20 changed files with 216 additions and 129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitmodules vendored
View File

@ -1,7 +1,3 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy.git
branch = v0.3.0
[submodule "api-ref-generator"] [submodule "api-ref-generator"]
path = api-ref-generator path = api-ref-generator
url = https://github.com/kubernetes-sigs/reference-docs url = https://github.com/kubernetes-sigs/reference-docs

23
Makefile
View File

@ -12,6 +12,19 @@ CONTAINER_IMAGE = $(IMAGE_REGISTRY)/k8s-website-hugo:v$(HUGO_VERSION)-$(IMAGE_
# Mount read-only to allow use with tools like Podman in SELinux mode # Mount read-only to allow use with tools like Podman in SELinux mode
# Container targets don't need to write into /src # Container targets don't need to write into /src
CONTAINER_RUN = "$(CONTAINER_ENGINE)" run --rm --interactive --tty --volume "$(CURDIR):/src:ro,Z" CONTAINER_RUN = "$(CONTAINER_ENGINE)" run --rm --interactive --tty --volume "$(CURDIR):/src:ro,Z"
CONTAINER_RUN_TTY = "$(CONTAINER_ENGINE)" run --rm --interactive --tty
CONTAINER_HUGO_MOUNTS = \
--read-only \
--mount type=bind,source=$(CURDIR)/.git,target=/src/.git,readonly \
--mount type=bind,source=$(CURDIR)/archetypes,target=/src/archetypes,readonly \
--mount type=bind,source=$(CURDIR)/assets,target=/src/assets,readonly \
--mount type=bind,source=$(CURDIR)/content,target=/src/content,readonly \
--mount type=bind,source=$(CURDIR)/data,target=/src/data,readonly \
--mount type=bind,source=$(CURDIR)/i18n,target=/src/i18n,readonly \
--mount type=bind,source=$(CURDIR)/layouts,target=/src/layouts,readonly \
--mount type=bind,source=$(CURDIR)/static,target=/src/static,readonly \
--mount type=tmpfs,destination=/tmp,tmpfs-mode=01777 \
--mount type=bind,source=$(CURDIR)/hugo.toml,target=/src/hugo.toml,readonly
CCRED=\033[0;31m CCRED=\033[0;31m
CCEND=\033[0m CCEND=\033[0m
@ -98,15 +111,13 @@ docker-push: ## Build a multi-architecture image and push that into the registry
container-build: module-check container-build: module-check
mkdir -p public mkdir -p public
$(CONTAINER_RUN) --read-only \ $(CONTAINER_RUN_TTY) $(CONTAINER_HUGO_MOUNTS) $(CONTAINER_IMAGE) \
--mount type=tmpfs,destination=/tmp,tmpfs-mode=01777 \ hugo --destination /tmp/public --cleanDestinationDir --buildDrafts --buildFuture --environment preview --noBuildLock
--mount type=bind,source=$(CURDIR)/public,target=/src/public $(CONTAINER_IMAGE) \
hugo --cleanDestinationDir --buildDrafts --buildFuture --environment preview --noBuildLock
# no build lock to allow for read-only mounts # no build lock to allow for read-only mounts
container-serve: module-check ## Boot the development server using container. container-serve: module-check ## Boot the development server using container.
$(CONTAINER_RUN) --cap-drop=ALL --cap-add=AUDIT_WRITE --read-only \ $(CONTAINER_RUN_TTY) --cap-drop=ALL --cap-add=AUDIT_WRITE $(CONTAINER_HUGO_MOUNTS) \
--mount type=tmpfs,destination=/tmp,tmpfs-mode=01777 -p 1313:1313 $(CONTAINER_IMAGE) \ -p 1313:1313 $(CONTAINER_IMAGE) \
hugo server --buildDrafts --buildFuture --environment development --bind 0.0.0.0 --destination /tmp/public --cleanDestinationDir --noBuildLock hugo server --buildDrafts --buildFuture --environment development --bind 0.0.0.0 --destination /tmp/public --cleanDestinationDir --noBuildLock
test-examples: test-examples:

2
README.md
View File

@ -30,7 +30,7 @@ git clone https://github.com/kubernetes/website.git
cd website cd website
``` ```
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme). Even if you plan to run the website in a container, we strongly recommend pulling in the submodule and other development dependencies by running the following: The Kubernetes website uses git submodules. Even if you plan to run the website in a container, we strongly recommend pulling in the submodule and other development dependencies by running the following:
### Windows ### Windows

9
assets/scss/_custom.scss
View File

@ -98,10 +98,7 @@ body.td-home main[role="main"] > section:first-of-type .content p:first-child {
body.td-404 main .error-details { body.td-404 main .error-details {
max-width: 1100px; max-width: 1100px;
margin-left: auto; margin: 0 auto;
margin-right: auto;
margin-top: 4em;
margin-bottom: 0;
} }
/* Global - Mermaid.js diagrams */ /* Global - Mermaid.js diagrams */
@ -1954,6 +1951,10 @@ body.td-search #search {
padding: 0.2rem; padding: 0.2rem;
} }
.includecode .highlight {
margin-top: 0;
margin-bottom: 0;
}
// handle main page features on narrow viewports // handle main page features on narrow viewports
@media screen and (max-width: 768px) { @media screen and (max-width: 768px) {

17
hugo.toml
View File

@ -3,6 +3,7 @@ title = "Kubernetes"
# Hugo allows theme composition (and inheritance). The precedence is from left to right. # Hugo allows theme composition (and inheritance). The precedence is from left to right.
theme = ["docsy"] theme = ["docsy"]
themesDir = "node_modules"
# Language settings # Language settings
contentDir = "content/en" contentDir = "content/en"
@ -248,44 +249,44 @@ no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY
[[params.links.user]] [[params.links.user]]
name_key = "community_youtube_name" name_key = "community_youtube_name"
url = "https://youtube.com/kubernetescommunity" url = "https://youtube.com/kubernetescommunity"
icon = "fab fa-youtube" icon = "fa-brands fa-youtube"
[[params.links.user]] [[params.links.user]]
name_key = "community_forum_name" name_key = "community_forum_name"
url = "https://discuss.kubernetes.io" url = "https://discuss.kubernetes.io"
icon = "fa fa-envelope" icon = "fa-solid fa-envelope"
[[params.links.user]] [[params.links.user]]
name_key = "community_server_fault_name" name_key = "community_server_fault_name"
url = "https://serverfault.com/questions/tagged/kubernetes" url = "https://serverfault.com/questions/tagged/kubernetes"
icon = "fab fa-stack-overflow" icon = "fa-brands fa-stack-overflow"
[[params.links.user]] [[params.links.user]]
name_key = "community_x_name" name_key = "community_x_name"
url = "https://twitter.com/kubernetesio" url = "https://twitter.com/kubernetesio"
icon = "fab fa-twitter" icon = "fa-brands fa-twitter"
# Replace with fa-x-twitter once available # Replace with fa-x-twitter once available
# Developer relevant links. These will show up on right side of footer and in the community page if you have one. # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]] [[params.links.developer]]
name_key = "community_contributor_site_name" name_key = "community_contributor_site_name"
url = "https://k8s.dev/" url = "https://k8s.dev/"
icon = "fas fa-laptop-code" icon = "fa-solid fa-laptop-code"
[[params.links.developer]] [[params.links.developer]]
name_key = "community_github_name" name_key = "community_github_name"
url = "https://github.com/kubernetes/kubernetes" url = "https://github.com/kubernetes/kubernetes"
icon = "fab fa-github" icon = "fa-brands fa-github"
[[params.links.developer]] [[params.links.developer]]
name_key = "community_slack_name" name_key = "community_slack_name"
url = "https://slack.k8s.io" url = "https://slack.k8s.io"
icon = "fab fa-slack" icon = "fa-brands fa-slack"
[[params.links.developer]] [[params.links.developer]]
name_key = "community_calendar_name" name_key = "community_calendar_name"
url = "https://calendar.google.com/calendar/embed?src=calendar%40kubernetes.io" url = "https://calendar.google.com/calendar/embed?src=calendar%40kubernetes.io"
icon = "fas fa-calendar-alt" icon = "fa-solid fa-calendar-days"
# Language definitions. # Language definitions.

2
layouts/404.html
View File

@ -1,5 +1,6 @@
{{ define "main" }} {{ define "main" }}
{{ partial "handle-version-switch-404.html" . }} {{ partial "handle-version-switch-404.html" . }}
<div class="td-content">
<section id="error-404" class="error-details"> <section id="error-404" class="error-details">
<p> <p>
{{ T "error_404_were_you_looking_for" }} {{ T "error_404_were_you_looking_for" }}
@ -11,4 +12,5 @@
{{ end }} {{ end }}
</ul> </ul>
</section> </section>
</div>
{{ end }} {{ end }}

2
layouts/blog/baseof.html
View File

@ -34,7 +34,7 @@
><!-- inside main element --> ><!-- inside main element -->
{{ with .CurrentSection.OutputFormats.Get "rss" -}} {{ with .CurrentSection.OutputFormats.Get "rss" -}}
<a class="btn btn-lg -bg-orange td-rss-button d-none d-lg-block" href="{{ .Permalink | safeURL }}" target="_blank"> <a class="btn btn-lg -bg-orange td-rss-button d-none d-lg-block" href="{{ .Permalink | safeURL }}" target="_blank">
RSS <i class="fa fa-rss ml-2 "></i> RSS <i class="fa-solid fa-rss ml-2 "></i>
</a> </a>
{{ end -}} {{ end -}}
{{ block "main" . }}{{ end }} {{ block "main" . }}{{ end }}

16
layouts/partials/blog-meta-links.html
View File

@ -1,13 +1,13 @@
<div class="td-page-blog-meta ml-2 pb-1 pt-2 mb-4"> <div class="td-page-blog-meta ml-2 pb-1 pt-2 mb-4">
{{ with site.Home.OutputFormats.Get "rss" -}} {{ with site.Home.OutputFormats.Get "rss" -}}
<link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}" title="{{ site.Title }}"> <link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}" title="{{ site.Title }}">
<a class="widget-link" href="{{ .Permalink | safeURL }}" target="_blank"><div> <i class="fas fa-rss fab-icon"> </i> <span class="widget-link-text">RSS Feed</span></div> </a> <a class="widget-link" href="{{ .Permalink | safeURL }}" target="_blank"><div> <i class="fa-solid fa-rss"> </i> <span class="widget-link-text">RSS Feed</span></div> </a>
{{ end -}} {{ end -}}
<a class="widget-link" href="https://kubernetes.io/docs/contribute/new-content/blogs-case-studies/" target="_blank"><div> <i class="fa fa-edit fab-icon"></i> <span class="widget-link-text">Submit a Post</span></div></a> <a class="widget-link" href="https://kubernetes.io/docs/contribute/new-content/blogs-case-studies/" target="_blank"><div> <i class="fa-solid fa-pen-to-square"></i> <span class="widget-link-text">Submit a Post</span></div></a>
<a class="widget-link" href="https://twitter.com/kubernetesio" target="_blank"><div> <i class="fab fa-twitter-square fab-icon"> </i> <span class="widget-link-text"> @Kubernetesio</span></div></a> <a class="widget-link" href="https://twitter.com/kubernetesio" target="_blank"><div> <i class="fa-brands fa-twitter-square"> </i> <span class="widget-link-text"> @Kubernetesio</span></div></a>
<a class="widget-link" href="https://github.com/kubernetes/kubernetes" target="_blank"><div> <i class="fab fa-github-square fab-icon"></i> <span class="widget-link-text"> on GitHub </span></div></a> <a class="widget-link" href="https://github.com/kubernetes/kubernetes" target="_blank"><div> <i class="fa-brands fa-square-github"></i> <span class="widget-link-text"> on GitHub </span></div></a>
<a class="widget-link" href="http://slack.k8s.io" target="_blank"><div><i class="fab fa-slack fab-icon"> </i> <span class="widget-link-text">#kubernetes-users </span></div></a> <a class="widget-link" href="http://slack.k8s.io" target="_blank"><div><i class="fa-brands fa-slack"> </i> <span class="widget-link-text">#kubernetes-users </span></div></a>
<a class="widget-link" href="https://stackoverflow.com/questions/tagged/kubernetes" target="_blank"><div><i class="fab fa-stack-overflow fab-icon"></i> <span class="widget-link-text"> Stack Overflow</span></div></a> <a class="widget-link" href="https://stackoverflow.com/questions/tagged/kubernetes" target="_blank"><div><i class="fa-brands fa-stack-overflow"></i> <span class="widget-link-text"> Stack Overflow</span></div></a>
<a class="widget-link" href="https://discuss.kubernetes.io" target="_blank"><div> <i class="fab fa-discourse fab-icon"></i><span class="widget-link-text"> Forum </span></div></a> <a class="widget-link" href="https://discuss.kubernetes.io" target="_blank"><div> <i class="fa-brands fa-discourse"></i><span class="widget-link-text"> Forum </span></div></a>
<a class="widget-link" href="https://kubernetes.io/docs/setup"><div><i class="fa fa-download fab-icon"></i> <span class="widget-link-text"> Kubernetes</span></div></a> <a class="widget-link" href="https://kubernetes.io/docs/setup"><div><i class="fa-solid fa-download"></i> <span class="widget-link-text"> Kubernetes</span></div></a>
</div> </div>

2
layouts/partials/blog-sidebar.html
View File

@ -8,7 +8,7 @@ sidebar-tree in use elsewhere on the site. */}}
<form class="td-sidebar__search d-flex align-items-center"> <form class="td-sidebar__search d-flex align-items-center">
{{ partial "search-input.html" . }} {{ partial "search-input.html" . }}
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation"> <button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fa-solid fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
</button> </button>
</form> </form>

6
layouts/partials/head.html
View File

@ -55,9 +55,9 @@
{{ partial "css.html" . }} {{ partial "css.html" . }}
<!-- Content for social media sharing previews --> <!-- Content for social media sharing previews -->
<!-- Facebook uses the og: stuff, while Twitter and others use twitter: --> <!-- Facebook uses the og: stuff, while Twitter and others use twitter: -->
<meta name="description" content="{{ if .Params.description }}{{ .Params.description }}{{ else }}{{ .Summary }}{{ end }}"> <meta name="description" content="{{ template "partials/page-description.html" . }}">
<meta property="og:description" content="{{ if .Params.description }}{{ .Params.description }}{{ else }}{{ .Summary }}{{ end }}"> <meta property="og:description" content="{{ template "partials/page-description.html" . }}">
<meta name="twitter:description" content="{{ if .Params.description }}{{ .Params.description }}{{ else }}{{ .Summary }}{{ end }}"> <meta name="twitter:description" content="{{ template "partials/page-description.html" . }}">
<meta property="og:url" content="{{ .Permalink }}"> <meta property="og:url" content="{{ .Permalink }}">
<meta property="og:title" content="{{ if .Params.title }}{{ .Title }}{{ else }}{{ .Summary | truncate 10 }}{{ end }}"> <meta property="og:title" content="{{ if .Params.title }}{{ .Title }}{{ else }}{{ .Summary | truncate 10 }}{{ end }}">
<meta name="twitter:title" content="{{ if .Params.title }}{{ .Title }}{{ else }}{{ .Summary | truncate 10 }}{{ end }}"> <meta name="twitter:title" content="{{ if .Params.title }}{{ .Title }}{{ else }}{{ .Summary | truncate 10 }}{{ end }}">

16
layouts/partials/page-meta-links.html
View File

@ -29,31 +29,31 @@
<!-- Loop through the API reference links --> <!-- Loop through the API reference links -->
{{- range $apiReferenceMetaLinks -}} {{- range $apiReferenceMetaLinks -}}
{{- $apiRefPageLink := . -}} {{- $apiRefPageLink := . -}}
{{- $apiRefPageLink | replaceRE "<a([^>]*)>" "<a$1><i class=\"fa fa-code fa-fw\"></i> " | safeHTML -}} {{- $apiRefPageLink | replaceRE "<a([^>]*)>" "<a$1><i class=\"fa-solid fa-code fa-fw\"></i> " | safeHTML -}}
{{- end -}} {{- end -}}
{{- end -}} {{- end -}}
{{ if not (.Param "auto_generated") }} {{ if not (.Param "auto_generated") }}
<a href="{{ $editURL }}" target="_blank"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a> <a href="{{ $editURL }}" target="_blank"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ T "post_edit_this" }}</a>
{{- if .HasShortcode "thirdparty-content" -}} {{- if .HasShortcode "thirdparty-content" -}}
<a href="#third-party-content-disclaimer" class="third-party-disclaimer-link"><i class="fa fa-icon-circle fa-fw"></i> {{ T "thirdparty_message_edit_disclaimer" | safeHTML }}</a> <a href="#third-party-content-disclaimer" class="third-party-disclaimer-link"><i class="d-inline-block fa-fw"></i> {{ T "thirdparty_message_edit_disclaimer" | safeHTML }}</a>
{{- end }} {{- end }}
<a href="{{ $newPageURL }}" target="_blank"><i class="fa fa-edit fa-fw"></i> {{ T "post_create_child_page" }}</a> <a href="{{ $newPageURL }}" target="_blank"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ T "post_create_child_page" }}</a>
{{ end }} {{ end }}
<a href="{{ $issuesURL }}" target="_blank"><i class="fab fa-github fa-fw"></i> {{ T "post_create_issue" }}</a> <a href="{{ $issuesURL }}" target="_blank"><i class="fa-brands fa-github fa-fw"></i> {{ T "post_create_issue" }}</a>
{{ if $gh_project_repo }} {{ if $gh_project_repo }}
{{ $project_issueURL := printf "%s/issues/new" $gh_project_repo }} {{ $project_issueURL := printf "%s/issues/new" $gh_project_repo }}
<a href="{{ $project_issueURL }}" target="_blank"><i class="fas fa-tasks fa-fw"></i> {{ T "post_create_project_issue" }}</a> <a href="{{ $project_issueURL }}" target="_blank"><i class="fa-solid fa-list-check fa-fw"></i> {{ T "post_create_project_issue" }}</a>
{{ end }} {{ end }}
{{- if (.Param "auto_generated") -}} {{- if (.Param "auto_generated") -}}
<a href="#auto-generated-edit-notice" class="auto-generated-notice-link"><i class="fa fa-icon-circle fa-fw"></i> {{ T "auto_generated_edit_notice" | safeHTML }}</a> <a href="#auto-generated-edit-notice" class="auto-generated-notice-link"><i class="d-inline-block fa-fw"></i> {{ T "auto_generated_edit_notice" | safeHTML }}</a>
{{- end -}} {{- end -}}
{{ end }} {{ end }}
{{ with .CurrentSection.AlternativeOutputFormats.Get "print" }} {{ with .CurrentSection.AlternativeOutputFormats.Get "print" }}
<a id="print" href="{{ .Permalink | safeURL }}"><i class="fa fa-print fa-fw"></i> {{ T "print_entire_section" }}</a> <a id="print" href="{{ .Permalink | safeURL }}"><i class="fa-solid fa-print fa-fw"></i> {{ T "print_entire_section" }}</a>
{{ end }} {{ end }}
</div> </div>
{{ end }} {{ end }}

35
layouts/partials/scripts.html
View File

@ -1,8 +1,6 @@
<script src="/js/jquery-3.6.0.min.js" integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK" crossorigin="anonymous"></script>
<script src="/js/popper-1.16.1.min.js" intregrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
<script src="/js/bootstrap-4.6.1.min.js" integrity="sha384-VHvPCCyXqtD5DqJeNxl2dtTyhF78xXNXdkwX1CZeRusQfRKp+tA7hAShOK/B/fQ2" crossorigin="anonymous"></script>
<script src="{{ "js/script.js" | relURL }}"></script> <script src="{{ "js/script.js" | relURL }}"></script>
{{ $jsBs := resources.Get "vendor/bootstrap/dist/js/bootstrap.bundle.js" -}}
{{ $jsBase := resources.Get "js/base.js" }} {{ $jsBase := resources.Get "js/base.js" }}
{{ $jsAnchor := resources.Get "js/anchor.js" }} {{ $jsAnchor := resources.Get "js/anchor.js" }}
{{ $jsSearch := resources.Get "js/search.js" | resources.ExecuteAsTemplate "js/search.js" .Site.Home }} {{ $jsSearch := resources.Get "js/search.js" | resources.ExecuteAsTemplate "js/search.js" .Site.Home }}
@ -10,17 +8,25 @@
{{ if .Site.Params.offlineSearch }} {{ if .Site.Params.offlineSearch }}
{{ $jsSearch = resources.Get "js/offline-search.js" }} {{ $jsSearch = resources.Get "js/offline-search.js" }}
{{ end }} {{ end }}
{{ $js := (slice $jsBase $jsAnchor $jsSearch $jsMermaid) | resources.Concat "js/main.js" }} {{ $js := (slice $jsBs $jsBase $jsAnchor $jsSearch $jsMermaid) | resources.Concat "js/main.js" -}}
{{ if hugo.IsServer }} {{ if hugo.IsProduction -}}
<script src="{{ $js.RelPermalink }}"></script> {{ $js := $js | minify | fingerprint -}}
{{ else }} <script src="{{ $js.RelPermalink }}" integrity="{{ $js.Data.Integrity }}" crossorigin="anonymous"></script>
{{ $js := $js | minify | fingerprint }} {{ else -}}
<script src="{{ $js.RelPermalink }}" integrity="{{ $js.Data.Integrity }}" crossorigin="anonymous"></script> <script src="{{ $js.RelPermalink }}"></script>
{{ end }} {{ end -}}
{{ with .Site.Params.prism_syntax_highlighting }}
<!-- scripts for prism --> {{ if .Site.Params.prism_syntax_highlighting -}}
<script src='/js/prism.js'></script> <script src='{{ "js/prism.js" | relURL }}'></script>
{{ end }} {{ else if false -}}
{{ $c2cJS := resources.Get "js/click-to-copy.js" -}}
{{ if hugo.IsProduction -}}
{{ $c2cJS = $c2cJS | minify | fingerprint -}}
{{ end -}}
<script defer src="{{ $c2cJS.RelPermalink }}" {{ with $c2cJS.Data.Integrity -}}
integrity="{{ . }}" {{ end -}}
crossorigin="anonymous"></script>
{{ end -}}
<!--for the splitter--> <!--for the splitter-->
<script> <script>
@ -51,5 +57,4 @@
} }
</script> </script>
{{ partial "hooks/body-end.html" . }} {{ partial "hooks/body-end.html" . }}

6
layouts/partials/search-input.html
View File

@ -1,6 +1,6 @@
{{ if or .Site.Params.gcs_engine_id .Site.Params.algolia_docsearch }} {{ if or .Site.Params.gcs_engine_id .Site.Params.algolia_docsearch }}
<div class="search-bar"> <div class="search-bar">
<i class="search-icon fas fa-search"></i> <i class="search-icon fa-solid fa-search"></i>
<input <input
type="search" type="search"
class="search-input td-search-input" class="search-input td-search-input"
@ -11,7 +11,7 @@
</div> </div>
{{ else if .Site.Params.offlineSearch }} {{ else if .Site.Params.offlineSearch }}
<div class="search-bar" id="search-nav-container"> <div class="search-bar" id="search-nav-container">
<i class="search-icon fas fa-search"></i> <i class="search-icon fa-solid fa-search"></i>
<input <input
type="search" type="search"
class="search-input td-search-input" class="search-input td-search-input"
@ -27,7 +27,7 @@
{{ $searchFile := printf "content/%s/search.md" $lang }} {{ $searchFile := printf "content/%s/search.md" $lang }}
<div class="search-bar"> <div class="search-bar">
<i class="search-icon fas fa-search"></i> <i class="search-icon fa-solid fa-search"></i>
<input <input
type="search" type="search"
name="q" name="q"

4
layouts/partials/sidebar-tree.html
View File

@ -4,14 +4,14 @@
{{ if not .Site.Params.ui.sidebar_search_disable -}} {{ if not .Site.Params.ui.sidebar_search_disable -}}
<form class="td-sidebar__search d-flex align-items-center"> <form class="td-sidebar__search d-flex align-items-center">
{{ partial "search-input.html" . }} {{ partial "search-input.html" . }}
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-section-nav" aria-expanded="false" aria-label="Toggle section navigation"> <button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fa-solid fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
</button> </button>
</form> </form>
{{ else -}} {{ else -}}
<div id="content-mobile"> <div id="content-mobile">
<form class="td-sidebar__search d-flex align-items-center"> <form class="td-sidebar__search d-flex align-items-center">
{{ partial "search-input.html" . }} {{ partial "search-input.html" . }}
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-section-nav" aria-expanded="false" aria-label="Toggle section navigation"> <button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fa-solid fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
</button> </button>
</form> </form>
</div> </div>

2
layouts/shortcodes/release-binaries.html
View File

@ -137,7 +137,7 @@
</td> </td>
<td> <td>
<span class="icon"> <span class="icon">
<i class="fa fa-copy"></i> <i class="fa-solid fa-copy"></i>
</span> </span>
<span title="{{ T "release_binary_copy_link_tooltip" }}"> <span title="{{ T "release_binary_copy_link_tooltip" }}">
<a class="release-binary-copy" href="{{$BinaryLink}}">{{$LinkText}}</a> <a class="release-binary-copy" href="{{$BinaryLink}}">{{$LinkText}}</a>

154
package-lock.json generated
View File

@ -6,9 +6,21 @@
"": { "": {
"devDependencies": { "devDependencies": {
"autoprefixer": "^10.4.20", "autoprefixer": "^10.4.20",
"docsy": "github:google/docsy#v0.5.x",
"postcss-cli": "^11.0.0" "postcss-cli": "^11.0.0"
} }
}, },
"node_modules/@fortawesome/fontawesome-free": {
"version": "6.2.0",
"resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-free/-/fontawesome-free-6.2.0.tgz",
"integrity": "sha512-CNR7qRIfCwWHNN7FnKUniva94edPdyQzil/zCwk3v6k4R6rR2Fr8i4s3PM7n/lyfPA6Zfko9z5WDzFxG9SW1uQ==",
"dev": true,
"hasInstallScript": true,
"license": "(CC-BY-4.0 AND OFL-1.1 AND MIT)",
"engines": {
"node": ">=6"
}
},
"node_modules/@nodelib/fs.scandir": { "node_modules/@nodelib/fs.scandir": {
"version": "2.1.5", "version": "2.1.5",
"resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
@ -87,10 +99,11 @@
} }
}, },
"node_modules/anymatch": { "node_modules/anymatch": {
"version": "3.1.1", "version": "3.1.3",
"resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.1.tgz", "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz",
"integrity": "sha512-mM8522psRCqzV+6LhomX5wgp25YVibjh8Wj23I5RPkPppSVSjyKD2A2mBJmWGa+KN7f2D6LNh9jkBCeyLktzjg==", "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==",
"dev": true, "dev": true,
"license": "ISC",
"dependencies": { "dependencies": {
"normalize-path": "^3.0.0", "normalize-path": "^3.0.0",
"picomatch": "^2.0.4" "picomatch": "^2.0.4"
@ -138,12 +151,37 @@
} }
}, },
"node_modules/binary-extensions": { "node_modules/binary-extensions": {
"version": "2.1.0", "version": "2.3.0",
"resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.1.0.tgz", "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz",
"integrity": "sha512-1Yj8h9Q+QDF5FzhMs/c9+6UntbD5MkRfRwac8DoEm9ZfUBZ7tZ55YcGVAzEe4bXsdQHEk+s9S5wsOKVdZrw0tQ==", "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==",
"dev": true, "dev": true,
"license": "MIT",
"engines": { "engines": {
"node": ">=8" "node": ">=8"
},
"funding": {
"url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/bootstrap": {
"version": "4.6.2",
"resolved": "https://registry.npmjs.org/bootstrap/-/bootstrap-4.6.2.tgz",
"integrity": "sha512-51Bbp/Uxr9aTuy6ca/8FbFloBUJZLHwnhTcnjIeRn2suQWsWzcuJhGjKDB5eppVte/8oCdOL3VuwxvZDUggwGQ==",
"dev": true,
"funding": [
{
"type": "github",
"url": "https://github.com/sponsors/twbs"
},
{
"type": "opencollective",
"url": "https://opencollective.com/bootstrap"
}
],
"license": "MIT",
"peerDependencies": {
"jquery": "1.9.1 - 3",
"popper.js": "^1.16.1"
} }
}, },
"node_modules/braces": { "node_modules/braces": {
@ -193,9 +231,9 @@
} }
}, },
"node_modules/caniuse-lite": { "node_modules/caniuse-lite": {
"version": "1.0.30001680", "version": "1.0.30001683",
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001680.tgz", "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001683.tgz",
"integrity": "sha512-rPQy70G6AGUMnbwS1z6Xg+RkHYPAi18ihs47GH0jcxIG7wArmPgY3XbS2sRdBbxJljp3thdT8BIqv9ccCypiPA==", "integrity": "sha512-iqmNnThZ0n70mNwvxpEC2nBJ037ZHZUoBI5Gorh1Mw6IlEAZujEoU1tXA628iZfzm7R9FvFzxbfdgml82a3k8Q==",
"dev": true, "dev": true,
"funding": [ "funding": [
{ {
@ -214,24 +252,28 @@
"license": "CC-BY-4.0" "license": "CC-BY-4.0"
}, },
"node_modules/chokidar": { "node_modules/chokidar": {
"version": "3.4.0", "version": "3.6.0",
"resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.4.0.tgz", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
"integrity": "sha512-aXAaho2VJtisB/1fg1+3nlLJqGOuewTzQpd/Tz0yTg2R0e4IGtshYvtjowyEumcBv2z+y4+kc75Mz7j5xJskcQ==", "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==",
"dev": true, "dev": true,
"license": "MIT",
"dependencies": { "dependencies": {
"anymatch": "~3.1.1", "anymatch": "~3.1.2",
"braces": "~3.0.2", "braces": "~3.0.2",
"glob-parent": "~5.1.0", "glob-parent": "~5.1.2",
"is-binary-path": "~2.1.0", "is-binary-path": "~2.1.0",
"is-glob": "~4.0.1", "is-glob": "~4.0.1",
"normalize-path": "~3.0.0", "normalize-path": "~3.0.0",
"readdirp": "~3.4.0" "readdirp": "~3.6.0"
}, },
"engines": { "engines": {
"node": ">= 8.10.0" "node": ">= 8.10.0"
}, },
"funding": {
"url": "https://paulmillr.com/funding/"
},
"optionalDependencies": { "optionalDependencies": {
"fsevents": "~2.1.2" "fsevents": "~2.3.2"
} }
}, },
"node_modules/cliui": { "node_modules/cliui": {
@ -279,10 +321,19 @@
"node": ">= 0.6.0" "node": ">= 0.6.0"
} }
}, },
"node_modules/docsy": {
"version": "0.5.1+2",
"resolved": "git+ssh://git@github.com/google/docsy.git#cc857439cbba9e9aebeac726bf45bba95d1e6406",
"dev": true,
"dependencies": {
"@fortawesome/fontawesome-free": "6.2.0",
"bootstrap": "4.6.2"
}
},
"node_modules/electron-to-chromium": { "node_modules/electron-to-chromium": {
"version": "1.5.62", "version": "1.5.64",
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.62.tgz", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.64.tgz",
"integrity": "sha512-t8c+zLmJHa9dJy96yBZRXGQYoiCEnHYgFwn1asvSPZSUdVxnB62A4RASd7k41ytG3ErFBA0TpHlKg9D9SQBmLg==", "integrity": "sha512-IXEuxU+5ClW2IGEYFC2T7szbyVgehupCWQe5GNh+H065CD6U6IFN0s4KeAMFGNmQolRU4IV7zGBWSYMmZ8uuqQ==",
"dev": true, "dev": true,
"license": "ISC" "license": "ISC"
}, },
@ -373,11 +424,12 @@
} }
}, },
"node_modules/fsevents": { "node_modules/fsevents": {
"version": "2.1.3", "version": "2.3.3",
"resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.1.3.tgz", "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
"integrity": "sha512-Auw9a4AxqWpa9GUfj370BMPzzyncfBABW8Mab7BGWBYDj4Isgq+cDKtx0i6u9jcX9pQDnswsaaOTgTmA5pEjuQ==", "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
"dev": true, "dev": true,
"hasInstallScript": true, "hasInstallScript": true,
"license": "MIT",
"optional": true, "optional": true,
"os": [ "os": [
"darwin" "darwin"
@ -465,6 +517,7 @@
"resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz",
"integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==",
"dev": true, "dev": true,
"license": "MIT",
"dependencies": { "dependencies": {
"binary-extensions": "^2.0.0" "binary-extensions": "^2.0.0"
}, },
@ -475,8 +528,9 @@
"node_modules/is-extglob": { "node_modules/is-extglob": {
"version": "2.1.1", "version": "2.1.1",
"resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
"integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==",
"dev": true, "dev": true,
"license": "MIT",
"engines": { "engines": {
"node": ">=0.10.0" "node": ">=0.10.0"
} }
@ -492,10 +546,11 @@
} }
}, },
"node_modules/is-glob": { "node_modules/is-glob": {
"version": "4.0.1", "version": "4.0.3",
"resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
"integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
"dev": true, "dev": true,
"license": "MIT",
"dependencies": { "dependencies": {
"is-extglob": "^2.1.1" "is-extglob": "^2.1.1"
}, },
@ -513,6 +568,14 @@
"node": ">=0.12.0" "node": ">=0.12.0"
} }
}, },
"node_modules/jquery": {
"version": "3.7.1",
"resolved": "https://registry.npmjs.org/jquery/-/jquery-3.7.1.tgz",
"integrity": "sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg==",
"dev": true,
"license": "MIT",
"peer": true
},
"node_modules/jsonfile": { "node_modules/jsonfile": {
"version": "6.1.0", "version": "6.1.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
@ -595,6 +658,7 @@
"resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz",
"integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==",
"dev": true, "dev": true,
"license": "MIT",
"engines": { "engines": {
"node": ">=0.10.0" "node": ">=0.10.0"
} }
@ -602,8 +666,9 @@
"node_modules/normalize-range": { "node_modules/normalize-range": {
"version": "0.1.2", "version": "0.1.2",
"resolved": "https://registry.npmjs.org/normalize-range/-/normalize-range-0.1.2.tgz", "resolved": "https://registry.npmjs.org/normalize-range/-/normalize-range-0.1.2.tgz",
"integrity": "sha1-LRDAa9/TEuqXd2laTShDlFa3WUI=", "integrity": "sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA==",
"dev": true, "dev": true,
"license": "MIT",
"engines": { "engines": {
"node": ">=0.10.0" "node": ">=0.10.0"
} }
@ -644,12 +709,26 @@
"node_modules/pify": { "node_modules/pify": {
"version": "2.3.0", "version": "2.3.0",
"resolved": "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz", "resolved": "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz",
"integrity": "sha1-7RQaasBDqEnqWISY59yosVMw6Qw=", "integrity": "sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog==",
"dev": true, "dev": true,
"license": "MIT",
"engines": { "engines": {
"node": ">=0.10.0" "node": ">=0.10.0"
} }
}, },
"node_modules/popper.js": {
"version": "1.16.1",
"resolved": "https://registry.npmjs.org/popper.js/-/popper.js-1.16.1.tgz",
"integrity": "sha512-Wb4p1J4zyFTbM+u6WuO4XstYx4Ky9Cewe4DWrel7B0w6VVICvPwdOpotjzcf6eD8TsckVnIMNONQyPIUFOUbCQ==",
"deprecated": "You can find the new Popper v2 at @popperjs/core, this package is dedicated to the legacy v1",
"dev": true,
"license": "MIT",
"peer": true,
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/popperjs"
}
},
"node_modules/postcss": { "node_modules/postcss": {
"version": "8.4.49", "version": "8.4.49",
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.49.tgz", "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.49.tgz",
@ -787,8 +866,9 @@
"node_modules/pretty-hrtime": { "node_modules/pretty-hrtime": {
"version": "1.0.3", "version": "1.0.3",
"resolved": "https://registry.npmjs.org/pretty-hrtime/-/pretty-hrtime-1.0.3.tgz", "resolved": "https://registry.npmjs.org/pretty-hrtime/-/pretty-hrtime-1.0.3.tgz",
"integrity": "sha1-t+PqQkNaTJsnWdmeDyAesZWALuE=", "integrity": "sha512-66hKPCr+72mlfiSjlEB1+45IjXSqvVAIy6mocupoww4tBFE9R9IhwwUGoI4G++Tc9Aq+2rxOt0RFU6gPcrte0A==",
"dev": true, "dev": true,
"license": "MIT",
"engines": { "engines": {
"node": ">= 0.8" "node": ">= 0.8"
} }
@ -817,17 +897,19 @@
"node_modules/read-cache": { "node_modules/read-cache": {
"version": "1.0.0", "version": "1.0.0",
"resolved": "https://registry.npmjs.org/read-cache/-/read-cache-1.0.0.tgz", "resolved": "https://registry.npmjs.org/read-cache/-/read-cache-1.0.0.tgz",
"integrity": "sha1-5mTvMRYRZsl1HNvo28+GtftY93Q=", "integrity": "sha512-Owdv/Ft7IjOgm/i0xvNDZ1LrRANRfew4b2prF3OWMQLxLfu3bS8FVhCsrSCMK4lR56Y9ya+AThoTpDCTxCmpRA==",
"dev": true, "dev": true,
"license": "MIT",
"dependencies": { "dependencies": {
"pify": "^2.3.0" "pify": "^2.3.0"
} }
}, },
"node_modules/readdirp": { "node_modules/readdirp": {
"version": "3.4.0", "version": "3.6.0",
"resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.4.0.tgz", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz",
"integrity": "sha512-0xe001vZBnJEK+uKcj8qOhyAKPzIT+gStxWr3LCB0DwcXR5NZJ3IaC+yGnHCYzB/S7ov3m3EEbZI2zeNvX+hGQ==", "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==",
"dev": true, "dev": true,
"license": "MIT",
"dependencies": { "dependencies": {
"picomatch": "^2.2.1" "picomatch": "^2.2.1"
}, },
@ -1035,9 +1117,9 @@
} }
}, },
"node_modules/yaml": { "node_modules/yaml": {
"version": "2.6.0", "version": "2.6.1",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.6.0.tgz", "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.6.1.tgz",
"integrity": "sha512-a6ae//JvKDEra2kdi1qzCyrJW/WZCgFi8ydDV+eXExl95t+5R+ijnqHJbz9tmMh8FUjx3iv2fCQ4dclAQlO2UQ==", "integrity": "sha512-7r0XPzioN/Q9kXBro/XPnA6kznR73DHq+GXh5ON7ZozRO6aMjbmiBuKste2wslTFkC5d1dw0GooOCepZXJ2SAg==",
"dev": true, "dev": true,
"license": "ISC", "license": "ISC",
"bin": { "bin": {

4
package.json
View File

@ -5,6 +5,8 @@
}, },
"devDependencies": { "devDependencies": {
"autoprefixer": "^10.4.20", "autoprefixer": "^10.4.20",
"docsy": "github:google/docsy#v0.5.x",
"postcss-cli": "^11.0.0" "postcss-cli": "^11.0.0"
} },
"spelling": "cSpell:ignore docsy pkgs -"
} }

7
static/js/bootstrap-5.3.2.min.js vendored
View File

File diff suppressed because one or more lines are too long

5
static/js/popper-1.16.1.min.js vendored
View File

File diff suppressed because one or more lines are too long

1
themes/docsy

@ -1 +0,0 @@
Subproject commit 9f55cf34808d720bcfff9398c9f9bb7fd8fce4ec