Merge bf25ed7 into 6459d95

Orange-OpenSource · Mar 29, 2024 · 69abf60 · 69abf60
2 parents 6459d95 + bf25ed7
commit 69abf60
Show file tree

Hide file tree

Showing 13 changed files with 430 additions and 432 deletions.
diff --git a/hugo.yml b/hugo.yml
@@ -81,6 +81,11 @@ params:
   ods:
     web:                            "https://oran.ge/dsweb"
 
+  algolia:
+    appId:                          "F4PKENW3TB"
+    apiKey:                         "d04e794979727856a09d53f12ead9069"
+    indexName:                      "boosted-orange"
+
   download:
     source:                         "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/archive/v5.3.3.zip"
     dist:                           "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/download/v5.3.3/boosted-5.3.3-dist.zip"

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -79,7 +79,7 @@
     "docs-serve": "hugo server --port 9001 --disableFastRender --noHTTPCache --renderToMemory --printPathWarnings --printUnusedTemplates",
     "docs-serve-only": "sirv _site --no-clear --port 9001",
     "lockfile-lint": "lockfile-lint --allowed-hosts npm --allowed-schemes https: --empty-hostname false --type npm --path package-lock.json",
-    "update-deps": "ncu -u -x jasmine,karma-browserstack-launcher,karma-rollup-preprocessor",
+    "update-deps": "ncu -u -x karma-browserstack-launcher,karma-rollup-preprocessor",
     "release": "npm-run-all dist release-sri docs-build storybook-build release-zip*",
     "release-sri": "node build/generate-sri.mjs",
     "release-version": "node build/change-version.mjs",
@@ -104,9 +104,9 @@
     "@popperjs/core": "^2.11.8"
   },
   "devDependencies": {
-    "@babel/cli": "^7.23.9",
-    "@babel/core": "^7.24.0",
-    "@babel/preset-env": "^7.24.0",
+    "@babel/cli": "^7.24.1",
+    "@babel/core": "^7.24.1",
+    "@babel/preset-env": "^7.24.1",
     "@docsearch/js": "^3.6.0",
     "@percy/cli": "^1.28.2",
     "@popperjs/core": "^2.11.8",
@@ -139,7 +139,7 @@
     "focus-visible": "^5.2.0",
     "globby": "^14.0.1",
     "hammer-simulator": "0.0.1",
-    "hugo-bin": "^0.120.8",
+    "hugo-bin": "^0.121.0",
     "ip": "^2.0.0",
     "jasmine": "^5.1.0",
     "jquery": "^3.7.1",
@@ -158,12 +158,12 @@
     "ods-storybook-theme": "^1.1.0",
     "pa11y-ci": "^3.1.0",
     "pa11y-ci-reporter-html": "^6.0.2",
-    "postcss": "^8.4.35",
+    "postcss": "^8.4.36",
     "postcss-cli": "^11.0.0",
     "rollup": "^4.13.0",
     "rollup-plugin-istanbul": "^5.0.0",
     "rtlcss": "^4.1.1",
-    "sass": "^1.71.1",
+    "sass": "^1.72.0",
     "sass-loader": "^14.1.1",
     "sass-true": "^8.0.0",
     "shelljs": "^0.8.5",
@@ -172,7 +172,7 @@
     "stylelint": "^16.2.1",
     "stylelint-config-twbs-bootstrap": "^14.0.0",
     "tarteaucitronjs": "^1.17.0",
-    "terser": "^5.29.1",
+    "terser": "^5.29.2",
     "vnu-jar": "^23.4.11"
   },
   "files": [

diff --git a/site/assets/js/search.js b/site/assets/js/search.js
@@ -10,6 +10,9 @@
  */
 
 import docsearch from '@docsearch/js'
+// https://gohugo.io/hugo-pipes/js/#options
+// eslint-disable-next-line import/no-unresolved
+import { appId, apiKey, indexName } from '@params';
 
 (() => {
   const searchElement = document.getElementById('docsearch')
@@ -21,9 +24,9 @@ import docsearch from '@docsearch/js'
   const siteDocsVersion = searchElement.getAttribute('data-bd-docs-version')
 
   docsearch({
-    apiKey: 'd04e794979727856a09d53f12ead9069',
-    indexName: 'boosted-orange',
-    appId: 'F4PKENW3TB',
+    apiKey,
+    indexName,
+    appId,
     container: searchElement,
     searchParameters: {
       facetFilters: [`version:${siteDocsVersion}`]

diff --git a/site/assets/js/stackblitz.js b/site/assets/js/stackblitz.js
@@ -28,12 +28,12 @@ document.querySelectorAll('.btn-edit').forEach(btn => {
     // Get extra classes for this example
     const classes = Array.from(exampleEl.classList).join(' ')
 
-    sdk.openBoostedSnippet(htmlSnippet, jsSnippet, classes)
+    openBoostedSnippet(htmlSnippet, jsSnippet, classes)
   })
 })
 
-sdk.openBoostedSnippet = (htmlSnippet, jsSnippet, classes) => {
-  const markup = `<!doctype html>
+const openBoostedSnippet = (htmlSnippet, jsSnippet, classes) => {
+  const indexHtml = `<!doctype html>
 <html lang="en">
 <head>
   <meta charset="utf-8">
@@ -54,20 +54,20 @@ sdk.openBoostedSnippet = (htmlSnippet, jsSnippet, classes) => {
   <link href="${cssCdn}" rel="stylesheet">
   <link href="https://boosted.orange.com/docs/${docsVersion}/assets/css/docs.css" rel="stylesheet">
   <title>Boosted Example</title>
-  <${'script'} src="${jsBundleCdn}"></${'script'}>
+  <${'script'} defer src="${jsBundleCdn}"></${'script'}>
 </head>
 <body class="p-3 m-0 border-0 ${classes}">
   <!-- Example Code -->
-  ${htmlSnippet.replace(/^/gm, '    ')}
+${htmlSnippet.trimStart().replace(/^/gm, '    ').replace(/^ {4}$/gm, '').trimEnd()}
   <!-- End Example Code -->
 </body>
-</html>`
+</html>
+`
 
-  const jsSnippetContent = jsSnippet ? jsSnippetFile : null
   const project = {
     files: {
-      'index.html': markup,
-      'index.js': jsSnippetContent
+      'index.html': indexHtml,
+      ...(jsSnippet && { 'index.js': jsSnippetFile })
     },
     title: 'Boosted Example',
     description: `Official example from ${window.location.href}`,

diff --git a/site/assets/scss/_search.scss b/site/assets/scss/_search.scss
@@ -1,7 +1,5 @@
 // stylelint-disable selector-class-pattern
 
-@import "@docsearch/css/dist/style";
-
 // Boosted mod: the entire file is modified and is specific to Boosted
 
 :root {

diff --git a/site/assets/scss/docs.scss b/site/assets/scss/docs.scss
@@ -36,7 +36,6 @@ $enable-cssgrid: true;
 // Load docs components
 @import "variables";
 @import "navbar";
-@import "search";
 @import "subnav";
 @import "masthead";
 @import "content";

diff --git a/site/assets/scss/search.scss b/site/assets/scss/search.scss
@@ -0,0 +1,14 @@
+/*!
+ * Bootstrap Docs (https://getbootstrap.com/)
+ * Copyright 2024 The Bootstrap Authors
+ * Licensed under the Creative Commons Attribution 3.0 Unported License.
+ * For details, see https://creativecommons.org/licenses/by/3.0/.
+ */
+
+@import "../../../scss/functions";
+@import "../../../scss/variables";
+@import "../../../scss/mixins";
+@import "variables";
+
+@import "@docsearch/css/dist/style";
+@import "search";
diff --git a/site/layouts/_default/docs.html b/site/layouts/_default/docs.html
@@ -67,7 +67,7 @@ <h1 class="bd-title mb-0" id="content">{{ .Title | markdownify }}</h1>
 {{ end }}
 {{ define "footer" }}
   {{ range .Page.Params.extra_js -}}
-    <script{{ with .async }} async{{ end }} src="{{ .src }}"></script>
+    <script{{ with .async }} async{{ end }}{{ with .defer }} defer{{ end }} src="{{ .src }}"></script>
   {{- end -}}
   <div class="position-fixed" aria-hidden="true"><input type="text" tabindex="-1"></div>
 {{ end }}
diff --git a/site/layouts/_default/examples.html b/site/layouts/_default/examples.html
@@ -150,13 +150,13 @@
     {{ .Content }}
 
     {{- if hugo.IsProduction -}}
-      <script src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.min.js" {{ printf "integrity=%q" .Site.Params.cdn.js_bundle_hash | safeHTMLAttr }}></script>
+      <script defer src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.min.js" {{ printf "integrity=%q" .Site.Params.cdn.js_bundle_hash | safeHTMLAttr }}></script>
     {{- else -}}
-      <script src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.js"></script>
+      <script defer src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.js"></script>
     {{- end }}
 
     {{ range .Page.Params.extra_js -}}
-      <script{{ with .async }} async{{ end }} src="{{ .src }}"{{ with .integrity }} {{ printf "integrity=%q" . | safeHTMLAttr }} crossorigin="anonymous"{{ end }}></script>
+      <script{{ with .async }} async{{ end }}{{ with .defer }} defer{{ end }} src="{{ .src }}"{{ with .integrity }} {{ printf "integrity=%q" . | safeHTMLAttr }} crossorigin="anonymous"{{ end }}></script>
     {{- end -}}
   </body>
 </html>
diff --git a/site/layouts/partials/header.html b/site/layouts/partials/header.html
@@ -10,7 +10,7 @@
 <link rel="canonical" href="{{ .Permalink }}">
 
 {{ if (ne .Page.Layout "examples") -}}
-<link rel="preconnect" href="https://F4PKENW3TB-dsn.algolia.net" crossorigin>
+<link rel="preconnect" href="https://{{ .Site.Params.algolia.appId | lower }}-dsn.algolia.net" crossorigin>
 {{- end }}
 
 <title>{{ if .IsHome }}{{ .Site.Title | markdownify }} · {{ .Site.Params.subtitle | markdownify }}{{ else }}{{ .Title | markdownify }} · {{ .Site.Title | markdownify }} v{{ .Site.Params.docs_version }}{{ end }}</title>

diff --git a/site/layouts/partials/scripts.html b/site/layouts/partials/scripts.html
@@ -1,29 +1,35 @@
 {{ if hugo.IsProduction -}}
-  <script src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.min.js" {{ printf "integrity=%q" .Site.Params.cdn.js_bundle_hash | safeHTMLAttr }}></script>
+  <script defer src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.min.js" {{ printf "integrity=%q" .Site.Params.cdn.js_bundle_hash | safeHTMLAttr }}></script>
 {{ else -}}
-  <script src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.js"></script>
+  <script defer src="/docs/{{ .Site.Params.docs_version }}/dist/js/boosted.bundle.js"></script>
 {{- end }}
 
 {{- $esbuildOptions := dict "target" "es2019" -}}
 {{- $targetDocsJSPath := path.Join "/docs" .Site.Params.docs_version -}}
 {{- $esbuildOptions = merge $esbuildOptions (dict "minify" "true") -}}
 
 {{- $applicationJs := resources.Get "js/application.js" | js.Build $esbuildOptions | resources.Copy (path.Join $targetDocsJSPath "/assets/js/application.js") }}
-<script src="{{ $applicationJs.RelPermalink }}"></script>
+<script defer src="{{ $applicationJs.RelPermalink }}"></script>
 
 <!--Boosted mod-->
-<script src="/docs/{{ .Site.Params.docs_version }}/assets/js/tarteaucitron.min.js"></script>
+<script defer src="/docs/{{ .Site.Params.docs_version }}/assets/js/tarteaucitron.min.js"></script>
 
 {{- $js := resources.Match "js/tac.js" -}}
 {{- $targetTacJSPath := path.Join "/docs" .Site.Params.docs_version "assets/js/docs.js" -}}
 {{- $tacJs := $js | resources.Concat $targetTacJSPath -}}
 {{- $tacJs = $tacJs | resources.Minify -}}
-<script src="{{ $tacJs.Permalink | relURL }}"></script>
+<script defer src="{{ $tacJs.Permalink | relURL }}"></script>
 <!--End mod-->
 
 {{- if (ne .Page.Layout "examples") -}}
+{{- $esbuildParams := dict
+  "apiKey" .Site.Params.algolia.apiKey
+  "appId" .Site.Params.algolia.appId
+  "indexName" .Site.Params.algolia.indexName
+-}}
+{{- $esbuildOptions = merge $esbuildOptions (dict "params" $esbuildParams) -}}
 {{- $searchJs := resources.Get "js/search.js" | js.Build $esbuildOptions | resources.Copy (path.Join $targetDocsJSPath "/assets/js/search.js") }}
-<script async src="{{ $searchJs.RelPermalink }}"></script>
+<script defer src="{{ $searchJs.RelPermalink }}"></script>
 {{- end -}}
 
 {{ if eq .Page.Layout "docs" -}}
@@ -43,11 +49,11 @@
 -}}
 {{- $esbuildOptions = merge $esbuildOptions (dict "params" $esbuildParams) -}}
 {{- $stackblitzJs := resources.Get "js/stackblitz.js" | js.Build $esbuildOptions | resources.Copy (path.Join $targetDocsJSPath "/assets/js/stackblitz.js") }}
-<script async src="{{ $stackblitzJs.RelPermalink }}"></script>
+<script defer src="{{ $stackblitzJs.RelPermalink }}"></script>
 
 <!--Boosted mod-->
 {{- $colorJs := resources.Get "js/color.js" | js.Build $esbuildOptions | resources.Copy (path.Join $targetDocsJSPath "/assets/js/color.js") }}
-<script src="{{ $colorJs.RelPermalink }}"></script>
+<script defer src="{{ $colorJs.RelPermalink }}"></script>
 <!--End mod-->
 {{- end -}}
 
diff --git a/site/layouts/partials/stylesheet.html b/site/layouts/partials/stylesheet.html
@@ -13,14 +13,19 @@
 
 {{- if (ne .Page.Layout "examples") }}
 {{- $targetDocsCssPath := path.Join "/docs" .Site.Params.docs_version "assets/css/docs.css" -}}
-{{- $sassOptions := dict "targetPath" $targetDocsCssPath "outputStyle" "expanded" "precision" 6 -}}
+{{- $sassOptions := dict "outputStyle" "expanded" "precision" 6 -}}
 {{- $postcssOptions := dict "use" "autoprefixer" "noMap" true -}}
 
+{{- $targetDocsCssPath := path.Join "/docs" .Site.Params.docs_version "assets/css/docs.css" -}}
+{{- $targetSearchCssPath := path.Join "/docs" .Site.Params.docs_version "assets/css/search.css" -}}
+
 {{ if hugo.IsProduction -}}
   {{- $sassOptions = merge $sassOptions (dict "outputStyle" "compressed") -}}
 {{- end -}}
 
-{{- $style := resources.Get "scss/docs.scss" | toCSS $sassOptions | postCSS $postcssOptions }}
+{{- $docsCss := resources.Get "scss/docs.scss" | toCSS (merge (dict "targetPath" $targetDocsCssPath) $sassOptions) | postCSS $postcssOptions -}}
+{{- $searchCss := resources.Get "scss/search.scss" | toCSS (merge (dict "targetPath" $targetSearchCssPath) $sassOptions) | postCSS $postcssOptions -}}
 
-<link href="{{ $style.RelPermalink }}" rel="stylesheet">
+<link href="{{ $docsCss.RelPermalink }}" rel="stylesheet">
+<link href="{{ $searchCss.RelPermalink }}" rel="stylesheet">
 {{- end }}