mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-04 01:09:20 +02:00
update website [ci skip]
This commit is contained in:
Facebook GitHub Bot
parent
e57658bc1d
commit
3de45c3798
25 changed files with 188 additions and 151 deletions
|
|
@ -1,37 +0,0 @@
|
|||
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Enabling Search · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Enabling Search · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus supports search using [Algolia DocSearch](https://community.algolia.com/docsearch/). Once you have set up your site, [enter your site information](https://community.algolia.com/docsearch/) to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="/css/main.css"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body class="sideNavVisible"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Guides</span></h2></div><div class="navGroups"><div class="navGroup navGroupActive"><h3>Getting Started</h3><ul><li class="navListItem"><a class="navItem" href="/docs/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-creation.html#content">Creating your site</a></li></ul></div><div class="navGroup navGroupActive"><h3>Guides</h3><ul><li class="navListItem"><a class="navItem" href="/docs/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/doc-markdown.html#content">Markdown Features</a></li></ul></div></div></section></div><script>
|
||||
var toggler = document.getElementById('navToggler');
|
||||
var nav = document.getElementById('docsNav');
|
||||
toggler.onclick = function() {
|
||||
nav.classList.toggle('docsSliderActive');
|
||||
};
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/facebookexperimental/docusaurus/edit/master/docs/guides-search.md" target="_blank">Edit this Doc</a><h1>Enabling Search</h1></header><article><div><p>Docusaurus supports search using <a href="https://community.algolia.com/docsearch/" target="_blank">Algolia DocSearch</a>. Once you have set up your site, <a href="https://community.algolia.com/docsearch/" target="_blank">enter your site information</a> to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.</p><h3><a class="anchor" name="enabling-the-search-bar"></a>Enabling the Search Bar <a class="hash-link" href="#enabling-the-search-bar">#</a></h3><p>Enter your search-only API key and index name into <code>siteConfig.js</code> in the <code>algolia</code> section to enable search for your site.</p><pre class="prism language-js"><span class="token keyword">const</span> siteConfig <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||
<span class="token operator">...</span>
|
||||
algolia<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||
apiKey<span class="token punctuation">:</span> <span class="token string">"my-search-only-api-key-1234"</span><span class="token punctuation">,</span>
|
||||
indexName<span class="token punctuation">:</span> <span class="token string">"my-index-name"</span>
|
||||
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||
<span class="token operator">...</span>
|
||||
<span class="token punctuation">}</span></pre><h3><a class="anchor" name="extra-search-options"></a>Extra Search Options <a class="hash-link" href="#extra-search-options">#</a></h3><p>You can also specify extra <a href="https://community.algolia.com/docsearch/documentation/" target="_blank">search options used by Algolia</a> by using an <code>algoliaOptions</code> field in <code>algolia</code>. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be <a href="https://www.algolia.com/doc/api-reference/api-parameters/#overview" target="_blank">found here</a>.</p><pre class="prism language-js"><span class="token keyword">const</span> siteConfig <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||
<span class="token operator">...</span>
|
||||
algolia<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||
<span class="token operator">...</span>
|
||||
algoliaOptions<span class="token punctuation">:</span> <span class="token string">'{ facetFilters: [ "tags:VERSION" ], hitsPerPage: 5 }'</span>
|
||||
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||
<span class="token punctuation">}</span></pre><h3><a class="anchor" name="controlling-the-location-of-the-search-bar"></a>Controlling the Location of the Search Bar <a class="hash-link" href="#controlling-the-location-of-the-search-bar">#</a></h3><p>By default, the search bar will be the rightmost element in the top navigation bar.</p><p>If you want to change the default location, add the <code>searchBar</code> flag in the <code>headerLinks</code> field of <code>siteConfig.js</code> in your desired location. For example, you may want the search bar in between your internal and external links.</p><pre class="prism language-js"><span class="token keyword">const</span> siteConfig <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||
<span class="token operator">...</span>
|
||||
headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||
<span class="token punctuation">{</span><span class="token operator">...</span><span class="token punctuation">}</span>
|
||||
<span class="token punctuation">{</span><span class="token operator">...</span><span class="token punctuation">}</span>
|
||||
<span class="token punctuation">{</span> search<span class="token punctuation">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span>
|
||||
<span class="token punctuation">{</span><span class="token operator">...</span><span class="token punctuation">}</span>
|
||||
<span class="token punctuation">{</span><span class="token operator">...</span><span class="token punctuation">}</span>
|
||||
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
||||
<span class="token operator">...</span>
|
||||
<span class="token punctuation">}</span></pre><h3><a class="anchor" name="disabling-the-search-bar"></a>Disabling the Search Bar <a class="hash-link" href="#disabling-the-search-bar">#</a></h3><p>To disable the search bar, comment out (recommended) or delete the <code>algolia</code> section in the <code>siteConfig.js</code> file.</p><p>Also, if you have customized the location of the search bar in <code>headerLinks</code>, set <code>search: false</code>.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="translation.html#content">← Previous</a><a class="docs-next button" href="versioning.html#content">Next →</a></div></div></div></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div><h5>Docs</h5><a href="
|
||||
/docs/installation.html">Getting Started</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a></div><div><h5>More</h5><a href="https://github.com/facebookexperimental/docusaurus">GitHub</a><a class="github-button" href="https://github.com/facebookexperimental/docusaurus" data-icon="octicon-star" data-count-href="/facebookexperimental/docusaurus/stargazers" data-count-api="/repos/facebookexperimental/docusaurus#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2017 Facebook Inc.</section></footer></div><script type="text/javascript" src="//cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
|
||||
var search = docsearch({
|
||||
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
|
||||
indexName: 'docusaurus',
|
||||
inputSelector: '#search_input_react'
|
||||
});
|
||||
</script></body></html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue