search - control navbar search crumb merging with configuration

Author: cscheid

src/project/types/website/website-search.ts

@@ -252,7 +252,13 @@ export async function updateSearchIndex(
       // link that points to this page / sidebar. If so, inject that level
       // into the crumbs as well. An attempt at improving #7803 and providing
       // better crumbs
-      if (crumbs && sidebar) {
+      // deno-lint-ignore no-explicit-any
+      const mergeNavBarSearchCrumbs = (outputFile.format.metadata as any)
+        ?.website?.search?.["merge-navbar-crumbs"];
+      if (
+        mergeNavBarSearchCrumbs !== false &&
+        crumbs && sidebar
+      ) {
         const navItem = navbarItemForSidebar(sidebar, outputFile.format);
         if (navItem) {
           if (typeof navItem === "object") {

src/resources/editor/tools/vs-code.mjs

@@ -9574,6 +9574,11 @@ var require_yaml_intelligence_resources = __commonJS({
                           schema: "boolean",
                           description: "Provide button for copying search link"
                         },
+                        "merge-navbar-crumbs": {
+                          schema: "boolean",
+                          default: true,
+                          description: "When false, do not merge navbar crumbs into the crumbs in `search.json`."
+                        },
                         "keyboard-shortcut": {
                           maybeArrayOf: {
                             string: {
@@ -22914,8 +22919,6 @@ var require_yaml_intelligence_resources = __commonJS({
         "If <code>true</code>, force the presence of the OJS runtime. If\n<code>false</code>, force the absence instead. If unset, the OJS runtime\nis included only if OJS cells are present in the document.",
         "Use the specified file as a style reference in producing a docx,\npptx, or odt file.",
         "Branding information to use for this document. If a string, the path\nto a brand file. If false, don\u2019t use branding on this document. If an\nobject, an inline brand definition, or an object with light and dark\nbrand paths or definitions.",
-        "The path to a light brand file or an inline light brand\ndefinition.",
-        "The path to a dark brand file or an inline dark brand definition.",
         "Theme name, theme scss file, or a mix of both.",
         "The light theme name, theme scss file, or a mix of both.",
         "The light theme name, theme scss file, or a mix of both.",
@@ -24248,12 +24251,12 @@ var require_yaml_intelligence_resources = __commonJS({
         mermaid: "%%"
       },
       "handlers/mermaid/schema.yml": {
-        _internalId: 196120,
+        _internalId: 194252,
         type: "object",
         description: "be an object",
         properties: {
           "mermaid-format": {
-            _internalId: 196112,
+            _internalId: 194244,
             type: "enum",
             enum: [
               "png",
@@ -24269,7 +24272,7 @@ var require_yaml_intelligence_resources = __commonJS({
             exhaustiveCompletions: true
           },
           theme: {
-            _internalId: 196119,
+            _internalId: 194251,
             type: "anyOf",
             anyOf: [
               {

src/resources/editor/tools/yaml/web-worker.js

@@ -2546,6 +2546,11 @@
                       "schema": "boolean",
                       "description": "Provide button for copying search link"
                     },
+                    "merge-navbar-crumbs": {
+                      "schema": "boolean",
+                      "default": true,
+                      "description": "When false, do not merge navbar crumbs into the crumbs in `search.json`."
+                    },
                     "keyboard-shortcut": {
                       "maybeArrayOf": {
                         "string": {
@@ -15886,8 +15891,6 @@
     "If <code>true</code>, force the presence of the OJS runtime. If\n<code>false</code>, force the absence instead. If unset, the OJS runtime\nis included only if OJS cells are present in the document.",
     "Use the specified file as a style reference in producing a docx,\npptx, or odt file.",
     "Branding information to use for this document. If a string, the path\nto a brand file. If false, don’t use branding on this document. If an\nobject, an inline brand definition, or an object with light and dark\nbrand paths or definitions.",
-    "The path to a light brand file or an inline light brand\ndefinition.",
-    "The path to a dark brand file or an inline dark brand definition.",
     "Theme name, theme scss file, or a mix of both.",
     "The light theme name, theme scss file, or a mix of both.",
     "The light theme name, theme scss file, or a mix of both.",
@@ -17220,12 +17223,12 @@
     "mermaid": "%%"
   },
   "handlers/mermaid/schema.yml": {
-    "_internalId": 196120,
+    "_internalId": 194252,
     "type": "object",
     "description": "be an object",
     "properties": {
       "mermaid-format": {
-        "_internalId": 196112,
+        "_internalId": 194244,
         "type": "enum",
         "enum": [
           "png",
@@ -17241,7 +17244,7 @@
         "exhaustiveCompletions": true
       },
       "theme": {
-        "_internalId": 196119,
+        "_internalId": 194251,
         "type": "anyOf",
         "anyOf": [
           {

src/resources/editor/tools/yaml/yaml-intelligence-resources.json

@@ -858,6 +858,10 @@
                 copy-button:
                   schema: boolean
                   description: "Provide button for copying search link"
+                merge-navbar-crumbs:
+                  schema: boolean
+                  default: true
+                  description: "When false, do not merge navbar crumbs into the crumbs in `search.json`."
                 keyboard-shortcut:
                   maybeArrayOf:
                     string:

src/resources/schema/definitions.yml

@@ -935,6 +935,9 @@
                     "copy-button": {
                       "type": "boolean"
                     },
+                    "merge-navbar-crumbs": {
+                      "type": "boolean"
+                    },
                     "keyboard-shortcut": {
                       "anyOf": [
                         {

src/resources/schema/json-schemas.json

@@ -513,6 +513,7 @@ The user’s cookie preferences will automatically control Google Analytics (if
   search?: boolean | {
     "collapse-after"?: number;
     "copy-button"?: boolean;
+    "merge-navbar-crumbs"?: boolean;
     "keyboard-shortcut"?: MaybeArrayOf<
       string /* One or more keys that will act as a shortcut to launch search (single characters) */
     >;