{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/developer-portal/search/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#search\" aria-label=\"search permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"search\"></div>Search</h1>\n<p>We can enable, disable, or change the order the search box appears.</p>\n<p>Also, the actual search index functionality does not work in the development server environment.</p>\n<h2 style=\"position:relative;\"><a href=\"#disable-the-search-box\" aria-label=\"disable the search box permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"disable-the-search-box\"></div>Disable the search box</h2>\n<p>Open the <code class=\"language-text\">siteConfig.yaml</code>.</p>\n\n      <div class=\"code-snippets-tabs\" >\n    <div class=\"snippets-tabs-headers\">\n      <span class=\"tab-header active\" data-lang=\"yaml\" data-snippet-id=\"before\">before</span><span class=\"tab-header \" data-lang=\"yaml\" data-snippet-id=\"after\">after</span>\n    </div>\n    <div class=\"snippets-tabs-contents\">\n      <div class=\"tab-content active\" data-lang=\"yaml\" data-snippet-id=\"before\"><div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"19045949393087947000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`  - search: true`, `19045949393087947000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-19045949393087947000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"yaml\"><pre class=\"language-yaml\"><code class=\"language-yaml\">  <span class=\"token punctuation\">-</span> <span class=\"token key atrule\">search</span><span class=\"token punctuation\">:</span> <span class=\"token boolean important\">true</span></code></pre></div>\n      </div></div><div class=\"tab-content \" data-lang=\"yaml\" data-snippet-id=\"after\"><div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"88013899799810720000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`#  - search: true`, `88013899799810720000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-88013899799810720000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"yaml\"><pre class=\"language-yaml\"><code class=\"language-yaml\"><span class=\"token comment\">#  - search: true</span></code></pre></div>\n      </div></div>\n    </div></div>\n    \n<p>The <code class=\"language-text\">#</code> acts as a \"comment\" token for the rest of the yaml line.</p>\n<h2 style=\"position:relative;\"><a href=\"#enable-the-search-box\" aria-label=\"enable the search box permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"enable-the-search-box\"></div>Enable the search box</h2>\n<p>Now, we're remove the <code class=\"language-text\">#</code> comment, or add back the line.</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"58400896380915745000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`nav:\n\n  - label: Training exercises\n    page: developer-portal/index.md\n\n  - label: External docs\n    href: https://docs.redoc.ly/developer-portal/introduction/\n\n  - search: true`, `58400896380915745000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-58400896380915745000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"yaml\"><pre class=\"language-yaml\"><code class=\"language-yaml\"><span class=\"token key atrule\">nav</span><span class=\"token punctuation\">:</span>\n\n  <span class=\"token punctuation\">-</span> <span class=\"token key atrule\">label</span><span class=\"token punctuation\">:</span> Training exercises\n    <span class=\"token key atrule\">page</span><span class=\"token punctuation\">:</span> developer<span class=\"token punctuation\">-</span>portal/index.md\n\n  <span class=\"token punctuation\">-</span> <span class=\"token key atrule\">label</span><span class=\"token punctuation\">:</span> External docs\n    <span class=\"token key atrule\">href</span><span class=\"token punctuation\">:</span> https<span class=\"token punctuation\">:</span>//docs.redoc.ly/developer<span class=\"token punctuation\">-</span>portal/introduction/\n\n  <span class=\"token punctuation\">-</span> <span class=\"token key atrule\">search</span><span class=\"token punctuation\">:</span> <span class=\"token boolean important\">true</span></code></pre></div>\n      </div>\n<p>Notice that search is defined within the <code class=\"language-text\">nav</code> section.</p>\n<h2 style=\"position:relative;\"><a href=\"#display-search-first\" aria-label=\"display search first permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"display-search-first\"></div>Display search first</h2>\n<p>We move <code class=\"language-text\">search</code> first in the <code class=\"language-text\">nav</code> definition.</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"54424893833226770000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`nav:\n  - search: true\n\n  - label: Training exercises\n    page: developer-portal/index.md\n\n  - label: External docs\n    href: https://docs.redoc.ly/developer-portal/introduction/`, `54424893833226770000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-54424893833226770000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"yaml\"><pre class=\"language-yaml\"><code class=\"language-yaml\"><span class=\"token key atrule\">nav</span><span class=\"token punctuation\">:</span>\n  <span class=\"token punctuation\">-</span> <span class=\"token key atrule\">search</span><span class=\"token punctuation\">:</span> <span class=\"token boolean important\">true</span>\n\n  <span class=\"token punctuation\">-</span> <span class=\"token key atrule\">label</span><span class=\"token punctuation\">:</span> Training exercises\n    <span class=\"token key atrule\">page</span><span class=\"token punctuation\">:</span> developer<span class=\"token punctuation\">-</span>portal/index.md\n\n  <span class=\"token punctuation\">-</span> <span class=\"token key atrule\">label</span><span class=\"token punctuation\">:</span> External docs\n    <span class=\"token key atrule\">href</span><span class=\"token punctuation\">:</span> https<span class=\"token punctuation\">:</span>//docs.redoc.ly/developer<span class=\"token punctuation\">-</span>portal/introduction/</code></pre></div>\n      </div>\n<p>Notice the change on the top navigation.</p>","headings":[{"value":"Search","depth":1},{"value":"Disable the search box","depth":2},{"value":"Enable the search box","depth":2},{"value":"Display search first","depth":2}]},"contentItem":{"data":{"lastModified":"2025-12-17T21:55:39.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"cae909a1-63bc-55ec-b795-f2dfc5ff7b62__redocly content/developer-portal/search/","seo":{"title":"Search","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"developer-portal/search.md","pageBaseUrl":"/developer-portal/search","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Search","id":"search"},{"depth":2,"value":"Disable the search box","id":"disable-the-search-box"},{"depth":2,"value":"Enable the search box","id":"enable-the-search-box"},{"depth":2,"value":"Display search first","id":"display-search-first"}]},"data":{"title":""},"catalogInfo":null,"link":"/developer-portal/search/","sidebarName":"","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}