Skip to content

Instantly share code, notes, and snippets.

@dholbach
Created March 29, 2023 09:42
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save dholbach/0c3d6dd05d7734539e3d986b77ab1976 to your computer and use it in GitHub Desktop.
Save dholbach/0c3d6dd05d7734539e3d986b77ab1976 to your computer and use it in GitHub Desktop.
fluxcd.io changes over upstream docsy
diff -ru ../../docsy/layouts/partials/favicons.html layouts/partials/favicons.html
--- ../../docsy/layouts/partials/favicons.html 2021-09-08 09:40:18.423978322 +0200
+++ layouts/partials/favicons.html 2022-11-02 10:46:12.673000298 +0100
@@ -1,12 +1,15 @@
-
-<!-- Favicons as generated by http://cthedot.de/icongen -->
-<link rel="shortcut icon" href="{{ "favicons/favicon.ico" | relURL }}" >
-<link rel="apple-touch-icon" href="{{ "favicons/apple-touch-icon-180x180.png" | relURL }}" sizes="180x180">
-<link rel="icon" type="image/png" href="{{ "favicons/favicon-16x16.png" | relURL }}" sizes="16x16">
-<link rel="icon" type="image/png" href="{{ "favicons/favicon-32x32.png" | relURL }}" sizes="32x32">
-<link rel="icon" type="image/png" href="{{ "favicons/android-36x36.png" | relURL }}" sizes="36x36">
-<link rel="icon" type="image/png" href="{{ "favicons/android-48x48.png" | relURL }}" sizes="48x48">
-<link rel="icon" type="image/png" href="{{ "favicons/android-72x72.png" | relURL }}" sizes="72x72">
-<link rel="icon" type="image/png" href="{{ "favicons/android-96x96.png" | relURL }}" sizes="96x96">
-<link rel="icon" type="image/png" href="{{ "favicons/android-144x144.png" | relURL }}" sizes="144x144">
-<link rel="icon" type="image/png" href="{{ "favicons/android-192x192.png" | relURL }}" sizes="192x192">
+<!-- Favicon changes:
+ - https://github.com/fluxcd/website/pull/872
+ - https://github.com/fluxcd/website/pull/1071
+-->
+<link rel="apple-touch-icon" sizes="180x180" href="{{ "/favicons/apple-touch-icon.png" | relURL }}">
+<link rel="icon" type="image/png" sizes="32x32" href="{{ "/favicons/favicon-32x32.png" | relURL }}">
+<link rel="icon" type="image/png" sizes="16x16" href="{{ "/favicons/favicon-16x16.png" | relURL }}">
+<link rel="icon" type="image/svg+xml" href="{{ "/favicons/favicon.svg" | relURL }}">
+<link rel="icon" type="image/png" href="{{ "/favicons/favicon.png" | relURL }}">
+<link rel="manifest" href="{{ "/favicons/site.webmanifest" | relURL }}">
+<link rel="shortcut icon" type="image/x-icon" href="{{ "/favicons/favicon.ico" | relURL }}"/>
+<link rel="mask-icon" color="#1a1a1a" href="{{ "/favicons/safari-pinned-tab.svg" | relURL }}">
+<meta name="msapplication-config" content="{{ "/favicons/browserconfig.xml" | relURL }}" />
+<meta name="msapplication-TileColor" content="#1a1a1a">
+<meta name="theme-color" content="#1a1a1a">
diff -ru ../../docsy/layouts/partials/hooks/body-end.html layouts/partials/hooks/body-end.html
--- ../../docsy/layouts/partials/hooks/body-end.html 2021-09-08 09:40:18.423978322 +0200
+++ layouts/partials/hooks/body-end.html 2023-03-15 11:34:00.015667430 +0100
@@ -1,3 +1,18 @@
-{{ with .Site.Params.algolia_docsearch }}
-<!-- scripts for algolia docsearch -->
-{{ end }}
\ No newline at end of file
+<!-- Calendar changes: https://github.com/fluxcd/website/pull/487 -->
+{{ $calendar := resources.Get "js/calendar.js" | js.Build "calendar.js" }}
+<script type="text/javascript" src="{{ $calendar.RelPermalink }}" defer></script>
+
+<!-- Algolia changes: https://github.com/fluxcd/website/pull/936 -->
+{{ if isset .Site.Params "algolia_docsearch" }}
+<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
+<script type="text/javascript">
+
+docsearch({
+ container: '#docsearch',
+ apiKey: 'd466984187cbf406354da362d45b8e3f',
+ appId: 'Z41T3FAXIU',
+ indexName: 'fluxcd',
+});
+
+</script>
+{{ end }}
diff -ru ../../docsy/layouts/partials/hooks/head-end.html layouts/partials/hooks/head-end.html
--- ../../docsy/layouts/partials/hooks/head-end.html 2021-09-08 09:40:18.423978322 +0200
+++ layouts/partials/hooks/head-end.html 2023-03-13 11:44:57.329543629 +0100
@@ -1,3 +1,4 @@
+<!-- Algolia changes: https://github.com/fluxcd/website/pull/936 -->
{{ with .Site.Params.algolia_docsearch }}
-<!-- stylesheet for algolia docsearch -->
-{{ end }}
\ No newline at end of file
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
+{{ end }}
diff -ru ../../docsy/layouts/partials/navbar.html layouts/partials/navbar.html
--- ../../docsy/layouts/partials/navbar.html 2023-03-29 11:39:29.464191837 +0200
+++ layouts/partials/navbar.html 2023-03-15 11:34:00.015667430 +0100
@@ -1,36 +1,70 @@
+<!-- Switch between Flux / Flagger logo and title -->
+{{ $logo := "icons/logo.svg" }}
+{{ $title := .Site.Title }}
+
+{{ if in .Permalink "/flagger" }}
+{{ $logo = "icons/flagger.svg" }}
+{{ $title = "Flagger" }}
+{{ end }}
+
{{ $cover := and
(.HasShortcode "blocks/cover")
(not .Site.Params.ui.navbar_translucent_over_cover_disable)
-}}
-<nav class="js-navbar-scroll navbar navbar-expand navbar-dark
- {{- if $cover }} td-navbar-cover {{- end }} flex-column flex-md-row td-navbar">
+<nav class="js-navbar-scroll navbar navbar-expand-lg navbar-dark
+ {{- if $cover }} td-navbar-cover {{- end }} flex-row td-navbar">
<a class="navbar-brand" href="{{ .Site.Home.RelPermalink }}">
{{- /**/ -}}
<span class="navbar-brand__logo navbar-logo">
{{- if ne .Site.Params.ui.navbar_logo false -}}
- {{ with resources.Get "icons/logo.svg" -}}
+ {{ with resources.Get $logo -}}
{{ ( . | minify).Content | safeHTML -}}
{{ end -}}
{{ end -}}
</span>
{{- /**/ -}}
<span class="navbar-brand__name">
- {{- .Site.Title -}}
+ {{- $title -}}
</span>
{{- /**/ -}}
</a>
- <div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
+ <!-- toggle navbar on mobile: https://github.com/fluxcd/website/pull/879 -->
+ <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarContent" aria-controls="navbarContent" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+ <div class="collapse navbar-collapse justify-content-end" id="navbarContent">
<ul class="navbar-nav mt-2 mt-lg-0">
+ <!-- Move docs selector forward -->
+ {{ if .Site.Params.versions -}}
+ <li class="nav-item dropdown mr-4">
+ {{ partial "navbar-version-selector.html" . -}}
+ </li>
+ {{ end -}}
{{ $p := . -}}
{{ range .Site.Menus.main -}}
- <li class="nav-item mr-4 mb-2 mb-lg-0">
{{ $active := or ($p.IsMenuCurrent "main" .) ($p.HasMenuCurrent "main" .) -}}
{{ with .Page }}{{ $active = or $active ( $.IsDescendant .) }}{{ end -}}
{{ $pre := .Pre -}}
{{ $post := .Post -}}
{{ $url := urls.Parse .URL -}}
{{ $baseurl := urls.Parse $.Site.Params.Baseurl -}}
+
+ <!-- navbar with nested dropdown: https://github.com/fluxcd/website/commit/32c6b2f61886c3ede54483b399566ea40bea18a7 -->
+ {{ if .HasChildren }}
+ <li class="nav-item dropdown">
+ <a class="nav-link {{if $active }} active{{end}} dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ {{ .Name }}
+ </a>
+ <div class="dropdown-menu dropdown-menu-right" aria-labelledby="navbarDropdownMenuLink">
+ {{ range .Children }}
+ {{ $childrenurl := urls.Parse .URL }}
+ <a class="dropdown-item" href="{{ with .Page }}{{ .RelPermalink }}{{ else }}{{ .URL | relLangURL }}{{ end }}" {{ if ne $childrenurl.Host $baseurl.Host }}target="_blank" {{ end }}>{{ .Name }}</a>
+ {{ end }}
+ </div>
+ </li>
+ {{ else }}
+ <li class="nav-item mr-4 mb-2 mb-lg-0">
<a {{/**/ -}}
class="nav-link {{- if $active }} active {{- end }}" {{/**/ -}}
href="{{ with .Page }}{{ .RelPermalink }}{{ else }}{{ .URL | relLangURL }}{{ end }}"
@@ -44,19 +78,15 @@
</a>
</li>
{{ end -}}
- {{ if .Site.Params.versions -}}
- <li class="nav-item dropdown mr-4 d-none d-lg-block">
- {{ partial "navbar-version-selector.html" . -}}
- </li>
- {{ end -}}
+ {{ end -}}
{{ if (gt (len .Site.Home.Translations) 0) -}}
<li class="nav-item dropdown mr-4 d-none d-lg-block">
{{ partial "navbar-lang-selector.html" . -}}
</li>
{{ end -}}
+ <li class="nav-item nav-search-item">
+ {{ partial "search-input.html" . }}
+ </li>
</ul>
</div>
- <div class="navbar-nav d-none d-lg-block">
- {{ partial "search-input.html" . }}
- </div>
-</nav>
\ No newline at end of file
+</nav>
diff -ru ../../docsy/layouts/partials/page-meta-links.html layouts/partials/page-meta-links.html
--- ../../docsy/layouts/partials/page-meta-links.html 2023-03-29 11:39:29.464191837 +0200
+++ layouts/partials/page-meta-links.html 2023-03-15 11:34:00.015667430 +0100
@@ -5,6 +5,8 @@
{{ $gh_subdir := ($.Param "github_subdir") -}}
{{ $gh_project_repo := ($.Param "github_project_repo") -}}
{{ $gh_branch := (default "main" ($.Param "github_branch")) -}}
+<!-- Imported docs can't be edited: https://github.com/fluxcd/website/pull/145 -->
+{{ $importedDoc := $.Param "importedDoc" | default "false" }}
<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
{{ if $gh_url -}}
{{ warnf "Warning: use of `github_url` is deprecated. For details see https://www.docsy.dev/docs/adding-content/repository-links/#github_url-optional" -}}
@@ -37,9 +39,11 @@
{{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL -}}
{{ $newPageURL := printf "%s/new/%s?%s" $gh_repo $gh_repo_path $newPageQS -}}
+ {{ if eq $importedDoc "false" }}
<a href="{{ $viewURL }}" class="td-page-meta--view" target="_blank" rel="noopener"><i class="fa-solid fa-file-lines fa-fw"></i> {{ T "post_view_this" }}</a>
<a href="{{ $editURL }}" class="td-page-meta--edit" target="_blank" rel="noopener"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ T "post_edit_this" }}</a>
<a href="{{ $newPageURL }}" class="td-page-meta--child" target="_blank" rel="noopener"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ T "post_create_child_page" }}</a>
+ {{ end }}
<a href="{{ $issuesURL }}" class="td-page-meta--issue" target="_blank" rel="noopener"><i class="fa-solid fa-list-check fa-fw"></i> {{ T "post_create_issue" }}</a>
{{ with $gh_project_repo -}}
{{ $project_issueURL := printf "%s/issues/new" . -}}
diff -ru ../../docsy/layouts/partials/sidebar-tree.html layouts/partials/sidebar-tree.html
--- ../../docsy/layouts/partials/sidebar-tree.html 2023-03-29 11:39:29.464191837 +0200
+++ layouts/partials/sidebar-tree.html 2023-03-15 11:34:00.015667430 +0100
@@ -11,7 +11,7 @@
{{ else -}}
<div id="content-mobile">
<form class="td-sidebar__search d-flex align-items-center">
- {{ partial "search-input.html" . }}
+ <!-- Don't show extra search on mobile: https://github.com/fluxcd/website/pull/247 -->
<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>
</form>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment