nezhahq.github.io/developer/algolia-search.html

54 lines
16 KiB
HTML

<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Theme Config: Algolia Search | 哪吒监控</title>
<meta name="description" content="哪吒监控是一个轻量化的运维工具">
<link rel="stylesheet" href="/assets/style.17a88c2e.css">
<link rel="modulepreload" href="/assets/app.0bd0e305.js">
<link rel="modulepreload" href="/assets/developer_algolia-search.md.64bfe4e3.lean.js">
<meta name="twitter:title" content="Theme Config: Algolia Search | 哪吒监控">
<meta property="og:title" content="Theme Config: Algolia Search | 哪吒监控">
</head>
<body>
<div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-675d8756><div class="sidebar-button" data-v-675d8756><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/" aria-label="哪吒监控, back to home" data-v-675d8756 data-v-cc01ef16><!----> 哪吒监控</a><div class="flex-grow" data-v-675d8756></div><div class="nav" data-v-675d8756><nav class="nav-links" data-v-675d8756 data-v-eab3edfe><!--[--><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item" href="/" data-v-b8818f8c>使用指南 <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item active" href="/developer/basics" data-v-b8818f8c>开发手册 <!----></a></div></div><!--]--><div class="item" data-v-eab3edfe><div class="nav-dropdown-link" data-v-eab3edfe data-v-56bf3a3f><button class="button" data-v-56bf3a3f><span class="button-text" data-v-56bf3a3f>Languages</span><span class="right button-arrow" data-v-56bf3a3f></span></button><ul class="dialog" data-v-56bf3a3f><!--[--><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item active" href="/developer/algolia-search.html" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>简体中文</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/en_US/developer/algolia-search.html" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>English</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><!--]--></ul></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item isExternal" href="https://github.com/nezhahq/nezhahq.github.io" target="_blank" rel="noopener noreferrer" data-v-b8818f8c>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-b8818f8c><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-83e92a68><nav class="nav-links nav" data-v-83e92a68 data-v-eab3edfe><!--[--><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item" href="/" data-v-b8818f8c>使用指南 <!----></a></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item active" href="/developer/basics" data-v-b8818f8c>开发手册 <!----></a></div></div><!--]--><div class="item" data-v-eab3edfe><div class="nav-dropdown-link" data-v-eab3edfe data-v-56bf3a3f><button class="button" data-v-56bf3a3f><span class="button-text" data-v-56bf3a3f>Languages</span><span class="right button-arrow" data-v-56bf3a3f></span></button><ul class="dialog" data-v-56bf3a3f><!--[--><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item active" href="/developer/algolia-search.html" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>简体中文</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><li class="dialog-item" data-v-56bf3a3f><div class="nav-dropdown-link-item" data-v-56bf3a3f data-v-bbc27490><a class="item" href="/en_US/developer/algolia-search.html" data-v-bbc27490><span class="arrow" data-v-bbc27490></span><span class="text" data-v-bbc27490>English</span><span class="icon" data-v-bbc27490><!----></span></a></div></li><!--]--></ul></div></div><div class="item" data-v-eab3edfe><div class="nav-link" data-v-eab3edfe data-v-b8818f8c><a class="item isExternal" href="https://github.com/nezhahq/nezhahq.github.io" target="_blank" rel="noopener noreferrer" data-v-b8818f8c>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-b8818f8c><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-83e92a68><!--[--><li class="sidebar-link"><p class="sidebar-link-item">App Config</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/developer/basics">Basics</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Theme Config</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/developer/homepage">Homepage</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/developer/algolia-search">Algolia Search</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#internationalization-i18n">Internationalization (i18n)</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/developer/carbon-ads">Carbon Ads</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-7eddb2c4><div class="container" data-v-7eddb2c4><!--[--><!--]--><div style="position:relative;" class="content" data-v-7eddb2c4><div><h1 id="theme-config-algolia-search" tabindex="-1">Theme Config: Algolia Search <a class="header-anchor" href="#theme-config-algolia-search" aria-hidden="true">#</a></h1><p>The <code>themeConfig.algolia</code> option allows you to use <a href="https://docsearch.algolia.com" target="_blank" rel="noopener noreferrer">Algolia DocSearch</a>. To enable it, you need to provide at least appId, apiKey and indexName:</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">themeConfig</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">algolia</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">appId</span><span class="token operator">:</span> <span class="token string">&#39;your_app_id&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">apiKey</span><span class="token operator">:</span> <span class="token string">&#39;your_api_key&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">indexName</span><span class="token operator">:</span> <span class="token string">&#39;index_name&#39;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p>For more options, check out <a href="https://docsearch.algolia.com/docs/api/" target="_blank" rel="noopener noreferrer">Algolia DocSearch&#39;s documentation</a>. You can pass any extra option alongside other options, e.g. passing <code>searchParameters</code>:</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">themeConfig</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">algolia</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">appId</span><span class="token operator">:</span> <span class="token string">&#39;your_app_id&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">apiKey</span><span class="token operator">:</span> <span class="token string">&#39;your_api_key&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">indexName</span><span class="token operator">:</span> <span class="token string">&#39;index_name&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">searchParameters</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">facetFilters</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">&#39;tags:guide,api&#39;</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><h2 id="internationalization-i18n" tabindex="-1">Internationalization (i18n) <a class="header-anchor" href="#internationalization-i18n" aria-hidden="true">#</a></h2><p>If you have multiple locales in your documentation and you have defined a <code>locales</code> object in your <code>themeConfig</code>:</p><div class="language-js"><pre><code>module<span class="token punctuation">.</span>exports <span class="token operator">=</span> <span class="token punctuation">{</span>
<span class="token literal-property property">themeConfig</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">locales</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// ...</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token literal-property property">algolia</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">appId</span><span class="token operator">:</span> <span class="token string">&#39;your_app_id&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">apiKey</span><span class="token operator">:</span> <span class="token string">&#39;your_api_key&#39;</span><span class="token punctuation">,</span>
<span class="token literal-property property">indexName</span><span class="token operator">:</span> <span class="token string">&#39;index_name&#39;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre></div><p>VitePress will automatically add a <code>lang</code> <em>facetFilter</em> to the <code>searchParameters.facetFilter</code> array with the correct language value. Algolia automatically adds the correct facet filter based on the <code>lang</code> attribute on the <code>&lt;html&gt;</code> tag. This will match search results with the currently viewed language of the page.</p></div></div><footer class="page-footer" data-v-7eddb2c4 data-v-07c132fc><div class="edit" data-v-07c132fc><div class="edit-link" data-v-07c132fc data-v-1ed99556><a class="link" href="https://github.com/nezhahq/nezhahq.github.io/edit/main/docs/developer/algolia-search.md" target="_blank" rel="noopener noreferrer" data-v-1ed99556>在GitHub中编辑 <svg class="icon outbound icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-1ed99556><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="updated" data-v-07c132fc><!----></div></footer><div class="next-and-prev-link" data-v-7eddb2c4 data-v-38ede35f><div class="container" data-v-38ede35f><div class="prev" data-v-38ede35f><a class="link" href="/developer/homepage" data-v-38ede35f><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-38ede35f><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-38ede35f>Homepage</span></a></div><div class="next" data-v-38ede35f><a class="link" href="/developer/carbon-ads" data-v-38ede35f><span class="text" data-v-38ede35f>Carbon Ads</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-38ede35f><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
<script>__VP_HASH_MAP__ = JSON.parse("{\"developer_algolia-search.md\":\"64bfe4e3\",\"developer_basics.md\":\"5633887d\",\"developer_carbon-ads.md\":\"3455e72e\",\"developer_homepage.md\":\"5fcd3da5\",\"en_us_developer_algolia-search.md\":\"8cc4bbdc\",\"en_us_developer_basics.md\":\"413898e4\",\"en_us_developer_carbon-ads.md\":\"6c85c102\",\"en_us_developer_homepage.md\":\"04079155\",\"en_us_guide_agent.md\":\"743f0cf3\",\"en_us_guide_dashboard.md\":\"2126504b\",\"en_us_guide_notifications.md\":\"fd0fbc68\",\"en_us_guide_q2.md\":\"2ef984ad\",\"en_us_guide_q3.md\":\"5a2ee1b2\",\"en_us_guide_q4.md\":\"5fd3c2e1\",\"en_us_guide_q5.md\":\"9213a1d9\",\"en_us_guide_servers.md\":\"81fca59f\",\"en_us_guide_services.md\":\"454a41ef\",\"en_us_guide_settings.md\":\"434d82b0\",\"en_us_guide_tasks.md\":\"c8eb4c7e\",\"en_us_index.md\":\"a675940b\",\"guide_agent.md\":\"913e362f\",\"guide_dashboard.md\":\"9f2fda52\",\"guide_notifications.md\":\"33c483a1\",\"guide_q1.md\":\"6e999393\",\"guide_q2.md\":\"b0724251\",\"guide_q3.md\":\"8095ecd9\",\"guide_q4.md\":\"baadc4a9\",\"guide_q5.md\":\"ddba06e3\",\"guide_servers.md\":\"9e63f0b3\",\"guide_services.md\":\"f3d9de01\",\"guide_settings.md\":\"1a145ca7\",\"guide_tasks.md\":\"c5594dbb\",\"index.md\":\"13b009d3\"}")</script>
<script type="module" async src="/assets/app.0bd0e305.js"></script>
</body>
</html>