19 |
25 | );
26 | }
27 |
--------------------------------------------------------------------------------
/packages/docsearch-react/src/Footer.tsx:
--------------------------------------------------------------------------------
1 | import React, { type JSX } from 'react';
2 |
3 | import { AlgoliaLogo } from './AlgoliaLogo';
4 |
5 | export type FooterTranslations = Partial<{
6 | selectText: string;
7 | selectKeyAriaLabel: string;
8 | navigateText: string;
9 | navigateUpKeyAriaLabel: string;
10 | navigateDownKeyAriaLabel: string;
11 | closeText: string;
12 | closeKeyAriaLabel: string;
13 | searchByText: string;
14 | }>;
15 |
16 | type FooterProps = Partial<{
17 | translations: FooterTranslations;
18 | }>;
19 |
20 | interface CommandIconProps {
21 | children: React.ReactNode;
22 | ariaLabel: string;
23 | }
24 |
25 | function CommandIcon(props: CommandIconProps): JSX.Element {
26 | return (
27 |
32 | );
33 | }
34 |
35 | export function Footer({ translations = {} }: FooterProps): JSX.Element {
36 | const {
37 | selectText = 'to select',
38 | selectKeyAriaLabel = 'Enter key',
39 | navigateText = 'to navigate',
40 | navigateUpKeyAriaLabel = 'Arrow up',
41 | navigateDownKeyAriaLabel = 'Arrow down',
42 | closeText = 'to close',
43 | closeKeyAriaLabel = 'Escape key',
44 | searchByText = 'Search by',
45 | } = translations;
46 |
47 | return (
48 | <>
49 |
20 |
22 | {titleText}
23 |{helpText}
24 |
50 |
52 | -
53 |
-
54 |
55 |
56 | 58 | 59 | {selectText} 60 |57 |
61 | -
62 |
63 |
64 | 66 | 67 | 68 |65 | 69 | 71 | 72 | {navigateText} 73 |70 |
74 | -
75 |
76 |
77 | 79 | 80 | {closeText} 81 |78 |
82 |
29 |
73 | );
74 | }
75 |
--------------------------------------------------------------------------------
/packages/docsearch-react/src/ResultsScreen.tsx:
--------------------------------------------------------------------------------
1 | import React, { type JSX } from 'react';
2 |
3 | import { SelectIcon, SourceIcon } from './icons';
4 | import { Results } from './Results';
5 | import type { ScreenStateProps } from './ScreenState';
6 | import type { InternalDocSearchHit } from './types';
7 | import { removeHighlightTags } from './utils';
8 |
9 | type ResultsScreenProps = Omit
30 |
32 | 33 | {noResultsText} "{props.state.query}" 34 |
35 | 36 | {searchSuggestions && searchSuggestions.length > 0 && ( 37 |
38 |
62 | )}
63 |
64 | {props.getMissingResultsUrl && (
65 | {suggestedQueryText}:
39 |-
40 | {searchSuggestions.slice(0, 3).reduce
- 44 | 56 | , 57 | ], 58 | [], 59 | )} 60 |
66 | {`${reportMissingResultsText} `} 67 | 68 | {reportMissingResultsLinkText} 69 | 70 |
71 | )} 72 |
14 | {props.state.collections.map((collection) => {
15 | if (collection.items.length === 0) {
16 | return null;
17 | }
18 |
19 | const title = removeHighlightTags(collection.items[0]);
20 |
21 | return (
22 | (
28 | <>
29 | {item.__docsearch_parent && (
30 |
45 | )}
46 |
47 |
63 |
65 | )}
66 |
67 | );
68 | }
69 |
--------------------------------------------------------------------------------
/packages/docsearch-react/src/ScreenState.tsx:
--------------------------------------------------------------------------------
1 | import type { AutocompleteApi, AutocompleteState, BaseItem } from '@algolia/autocomplete-core';
2 | import React from 'react';
3 |
4 | import type { DocSearchProps } from './DocSearch';
5 | import type { ErrorScreenTranslations } from './ErrorScreen';
6 | import { ErrorScreen } from './ErrorScreen';
7 | import type { NoResultsScreenTranslations } from './NoResultsScreen';
8 | import { NoResultsScreen } from './NoResultsScreen';
9 | import { ResultsScreen } from './ResultsScreen';
10 | import type { StartScreenTranslations } from './StartScreen';
11 | import { StartScreen } from './StartScreen';
12 | import type { StoredSearchPlugin } from './stored-searches';
13 | import type { InternalDocSearchHit, StoredDocSearchHit } from './types';
14 |
15 | export type ScreenStateTranslations = Partial<{
16 | errorScreen: ErrorScreenTranslations;
17 | startScreen: StartScreenTranslations;
18 | noResultsScreen: NoResultsScreenTranslations;
19 | }>;
20 |
21 | export interface ScreenStateProps
48 |
50 |
51 | )}
52 | renderAction={() => (
53 |
54 |
56 | )}
57 | />
58 | );
59 | })}
60 |
61 | {props.resultsFooterComponent && (
62 | })
13 |
14 | ## You apply
15 |
16 | The first thing you'll need to do is to apply for DocSearch by [filling out the form on this page][1] (double check first that [you qualify][2]). We are receiving a lot of requests, so this form makes sure we won't be forgetting anyone.
17 |
18 | We guarantee that we will answer every request, but as we receive a lot of applications, please give us a couple of days to get back to you :)
19 |
20 | ## We create your Algolia application and a dedicated crawler
21 |
22 | Once we receive [your application][1], we'll have a look at your website, create an Algolia application and a dedicated [crawler][5] for it. Your crawler comes with [a configuration file][6] which defines which URLs we should crawl or ignore, as well as the specific CSS selectors to use for selecting headers, subheaders, etc.
23 |
24 | This step still requires some manual work and human brain, but thanks to the +4,000 configs we already created, we're able to automate most of it. Once this creation finishes, we'll run a first indexing of your website and have it run automatically at a random time of the week.
25 |
26 | **With the Crawler, comes [a dedicated interface][8] for you to:**
27 |
28 | - Start, schedule and monitor your crawls
29 | - Edit and test your config file directly with [DocSearch v3][7]
30 |
31 | **With the Algolia application comes access to the dashboard for you to:**
32 |
33 | - Browse your index and see how your content is indexed
34 | - Various analytics to understand how your search performs and ensure that your users are able to find what they’re searching for
35 | - Trials for other Algolia features
36 | - Team management
37 |
38 | ## You update your website
39 |
40 | We'll then get back to you with the JavaScript snippet you'll need to add to your website. This will bind your [DocSearch component][7] to display results from your Algolia index on each keystroke in a pop-up modal.
41 |
42 | Now that DocSearch is set, you don't have anything else to do. We'll keep crawling your website and update your search results automatically. All we ask is that you keep the "Search by Algolia" logo next to your search results.
43 |
44 | [1]: /apply
45 | [2]: /docs/who-can-apply
46 | [3]: https://github.com/algolia/docsearch-configs/tree/master/configs
47 | [4]: /docs/styling
48 | [5]: https://www.algolia.com/products/search-and-discovery/crawler/
49 | [6]: https://www.algolia.com/doc/tools/crawler/apis/configuration/
50 | [7]: /docs/docsearch-v3
51 | [8]: https://crawler.algolia.com/
52 |
--------------------------------------------------------------------------------
/packages/website/docs/integrations.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Supported Integrations
3 | ---
4 |
5 | We worked with **documentation website generators** to have DocSearch directly embedded as a first class citizen in the websites they produce.
6 |
7 | ## Our great integrations
8 |
9 | So, if you're using one of the following tools, checkout their documentation to see how to enable DocSearch on your website:
10 |
11 | - [Docusaurus v1][1] - [How to enable search][2]
12 | - [Docusaurus v2 & v3][3] - [Using Algolia DocSearch][4]
13 | - [VuePress][5] - [Algolia Search][6]
14 | - [VitePress][21] - [Search][22]
15 | - [Starlight][7] - [Algolia Search][8]
16 | - [LaRecipe][9] - [Algolia Search][10]
17 | - [Orchid][11] - [Algolia Search][12]
18 | - [Smooth DOC][13] - [DocSearch][14]
19 | - [Docsy][15] - [Configure Algolia DocSearch][16]
20 | - [Lotus Docs][19] - [Enabling the DocSearch Plugin][20]
21 | - [Sphinx](https://www.sphinx-doc.org/en/master/) - [Algolia DocSearch for Sphinx](https://sphinx-docsearch.readthedocs.io/)
22 |
23 | If you're maintaining a similar tool and want us to add you to the list, [feel free to make a pull request](https://github.com/algolia/docsearch/edit/main/packages/website/docs/integrations.md) and [contribute to Code Exchange](https://www.algolia.com/developers/code-exchange/contribute/). We're happy to help.
24 |
25 | [1]: https://v1.docusaurus.io/
26 | [2]: https://v1.docusaurus.io/docs/en/search
27 | [3]: https://docusaurus.io/
28 | [4]: https://docusaurus.io/docs/search#using-algolia-docsearch
29 | [5]: https://vuepress.vuejs.org/
30 | [6]: https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-search
31 | [7]: https://starlight.astro.build/
32 | [8]: https://starlight.astro.build/guides/site-search/#algolia-docsearch
33 | [9]: https://larecipe.saleem.dev/docs/2.2/overview
34 | [10]: https://larecipe.saleem.dev/docs/2.2/search#available-engines
35 | [11]: https://orchid.run
36 | [12]: https://orchid.run/plugins/orchidsearch#algolia-docsearch
37 | [13]: https://next-smooth-doc.vercel.app/
38 | [14]: https://next-smooth-doc.vercel.app/docs/docsearch/
39 | [15]: https://www.docsy.dev/
40 | [16]: https://www.docsy.dev/docs/adding-content/search/#algolia-docsearch
41 | [19]: https://lotusdocs.dev/docs/
42 | [20]: https://lotusdocs.dev/docs/guides/features/docsearch/#enabling-the-docsearch-plugin
43 | [21]: https://vitepress.dev/
44 | [22]: https://vitepress.dev/reference/default-theme-search#algolia-search
45 |
--------------------------------------------------------------------------------
/packages/website/docs/manage-your-crawls.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Manage your crawls
3 | ---
4 |
5 | import useBaseUrl from '@docusaurus/useBaseUrl';
6 |
7 | DocSearch comes with the [Algolia Crawler web interface](https://crawler.algolia.com/) that allows you to configure how and when your Algolia index will be populated.
8 |
9 | ## Trigger a new crawl
10 |
11 | Head over to the `Overview` section to `start`, `restart` or `pause` your crawls and view a real-time summary.
12 |
13 |
14 | })
18 |
19 |
20 | ## Monitor your crawls
21 |
22 | The `monitoring` section helps you find crawl errors or improve your search results.
23 |
24 |
18 |
25 | })
29 |
30 |
31 | ## Update your config
32 |
33 | The live editor allows you to update your config file and test your URLs (`URL tester`).
34 |
35 |
29 |
36 | })
40 |
41 |
42 | ## Search preview
43 |
44 | From the [`editor`](#update-your-config), you have access to a `Search preview` tab to browse search results with [`DocSearch v3`](/docs/docsearch-v3).
45 |
46 |
40 |
47 | })
51 |
52 |
53 | ## URL tester
54 |
55 | From the [`editor`](#update-your-config), your can use the URL tester to [debug selectors](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#debugging-selectors) or how we crawl your website.
56 |
57 |
51 |
58 | })
62 |
63 |
--------------------------------------------------------------------------------
/packages/website/docs/migrating-from-v2.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Migrating from DocSearch v2
3 | ---
4 |
5 | This page lists the differences between the [DocSearch v2](/docs/legacy/dropdown) and [DocSearch v3](/docs/docsearch-v3) API, you can also take a look at [the exhaustive `API reference` list](/docs/api) and [the `Getting started` guide](/docs/docsearch-v3).
6 |
7 | ```diff
8 | docsearch({
9 | indexName: 'YOUR_INDEX_NAME',
10 | apiKey: 'YOUR_SEARCH_API_KEY',
11 |
12 | - inputSelector: '
62 |
15 |
18 | })
15 |
16 | ## We extract the payload with to your set of `selectors`
17 |
18 | })
22 |
23 | We will focus on the highlighted information depending on your selectors.
24 |
25 | ## We iterate through the HTML flow and build the payload
26 |
27 | })
31 |
32 | This payload will be the only data extracted from your page.
33 |
34 | ## We iterate through the payload and start pushing records
35 |
36 | })
40 |
41 | We index the temporary record when we add an element to it (if `min_indexed_level` equals `0`)
42 |
43 | ## We pile up the elements based on the current temporary record
44 |
45 | })
49 |
50 | Based on the position within the flow, we nest elements as much as possible to keep the context and increase the relevancy.
51 |
52 | ## We iterate until we match a `text` element
53 |
54 | })
58 |
59 | ## We override the text element when we find a newer one
60 |
61 | })
65 |
66 | ## We remove the stashed, deeper elements when we add a higher level
67 |
68 | })
72 |
73 | Contextual information and hierarchy must be updated once we encounter a new level. We are doing that because it highlights a new sub-section not related to the previous one.
74 |
75 | If you need any further information, please connect with us on [Discord][1] or let our [support][2] team know.
76 |
77 | [1]: https://alg.li/discord
78 | [2]: https://support.algolia.com/
79 |
--------------------------------------------------------------------------------
/packages/website/versioned_docs/version-legacy/inside-the-engine.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Inside the engine
3 | ---
4 |
5 | This page explains in more detail how the crawler extracts content from your page, and how it ranks the results.
6 |
7 | ## Crawling
8 |
9 | Each crawl begins its journey at `start_urls` value specified in your config. It will read those pages, recursively extract and follow every link in those pages until it has browsed every compliant page.
10 |
11 | If you have explicitly defined a `sitemap.xml`, our crawler will scrape every provided and compliant page. We recommend using [a sitemap][1] since it explicitly exposes URLs to crawl and avoid missing pages that aren't linked from another page.
12 |
13 | ## Extracting content
14 |
15 | Building records using the scraper is pretty intuitive. Based on your settings, we extract the payload of your web page and index it, preserving your data structure. It achieves this in a simple way:
16 |
17 | - We **read top down** your web page following your HTML flow and pick out your matching elements according to their **levels** based on the `selectors_level` defined.
18 | - We create a record for each paragraph along with its hierarchical path. This construction is based on their **time of appearance** along the flow.
19 | - We **index** these records with the appropriate global settings (e.g. metadata, tags, etc.)
20 |
21 | _**Note:** The above process performs sanity tests as it scrapes to detect errors. If there are any serious warnings, it aborts and hence does not overwrite your current index. These checks ensure that your dedicated index isn't flushed._
22 |
23 | You can [find more explanations in this dedicated section.][2]
24 |
25 | ## Ranking records
26 |
27 | Algolia always returns the most relevant results first, using a [tie-breaking approach][3]. DocSearch will first search for exact matches in your keywords, and then fallback to partial matches. It sorts those results, once again, on the page hierarchy, as extracted from the `selectors`.
28 |
29 | The default strategy is to promote records having matching words in the highest level first. Thus if two results have the same matching words, the one having them in the highest level (`lvl0`) will be ranked higher. We also use the position of the matching words. The sooner they appear within the HTML flow, the higher the record will be ranked.
30 |
31 | We base relevancy on several factors and customize it according to the Algolia tie-breaking method.
32 |
33 | You can boost pages depending on their URLs. You should use the `start_urls` and its `page_rank` attributes. Its value is a numeric value (defaults to 0). The higher the value is, the higher results from the matching pages are ranked. For example, all pages with a `page_rank` of 5 will be returned before pages with a `page_rank` of 1.
34 |
35 | You could even change the relevancy strategy by [overwriting the default `customRanking`][4] used by the index by using the `custom_settings` option of your config.
36 |
37 | [1]: https://www.sitemaps.org/
38 | [2]: /docs/legacy/how-do-we-build-an-index
39 | [3]: https://www.algolia.com/doc/guides/ranking/ranking-formula/#tie-breaking-approach
40 | [4]: https://www.algolia.com/doc/guides/ranking/custom-ranking/
41 |
--------------------------------------------------------------------------------
/packages/website/versioned_docs/version-legacy/integrations.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Supported Integrations
3 | ---
4 |
5 | We worked with **documentation website generators** to have DocSearch directly embedded as a first class citizen in the websites they produce.
6 |
7 | ## Our great integrations
8 |
9 | If you're using one of the following tools, checkout their documentation to see how to enable DocSearch on your website:
10 |
11 | - [Docusaurus v1][1] - [How to enable search][2]
12 | - [Docusaurus v2][3] - [Using Algolia DocSearch][4]
13 | - [VuePress][5] - [Algolia Search][6]
14 | - [pkgdown][7] - [DocSearch indexing][8]
15 | - [LaRecipe][9] - [Algolia Search][10]
16 | - [Orchid][11] - [Algolia Search][12]
17 | - [Smooth DOC][13] - [DocSearch][14]
18 | - [Docsy][15] - [Configure Algolia DocSearch][16]
19 |
20 | If you're maintaining a similar tool and want us to add you to the list, [get in touch with us on Discord][17]. We'd be happy to help.
21 |
22 | [1]: https://v1.docusaurus.io/
23 | [2]: https://v1.docusaurus.io/docs/en/search
24 | [3]: https://docusaurus.io/
25 | [4]: https://docusaurus.io/docs/search#using-algolia-docsearch
26 | [5]: https://vuepress.vuejs.org/
27 | [6]: https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-search
28 | [7]: https://pkgdown.r-lib.org/
29 | [8]: https://pkgdown.r-lib.org/articles/search.html
30 | [9]: https://larecipe.binarytorch.com.my/docs/2.2/overview
31 | [10]: https://larecipe.binarytorch.com.my/docs/2.2/configurations#search
32 | [11]: https://orchid.run
33 | [12]: https://orchid.run/plugins/orchidsearch#algolia-docsearch
34 | [13]: https://smooth-doc.com/
35 | [14]: https://smooth-doc.com/docs/docsearch/
36 | [15]: https://www.docsy.dev/
37 | [16]: https://www.docsy.dev/docs/adding-content/navigation/#configure-algolia-docsearch
38 | [17]: https://alg.li/discord
39 |
--------------------------------------------------------------------------------
/packages/website/versioned_docs/version-legacy/scraper-overview.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Scraper Overview
3 | ---
4 |
5 | ## How?
6 |
7 | The DocSearch scraper is written in Python and heavily inspired by the [Scrapy][1] framework. It goes through all pages of your website and extracts content from the HTML structure to populate an Algolia index.
8 |
9 | It automatically follows every internal link to make sure we are not missing any content, and uses the semantics of your HTML structure to construct its records. This means that `h1`,`h2`, etc., (`selectors`) titles are used as hierarchy, and each `p` is used as a potential result.
10 |
11 | Those CSS selectors can be overwritten, and each website has its own JSON configuration file that describes in more detail how the scraper should behave. You can find the complete list of options in [the related section][2].
12 |
13 | If you'd like to [run DocSearch on your own][3], all the code is open sourced and even packaged as a Docker image. Download it, and run it with your own credentials.
14 |
15 | [1]: https://scrapy.org/
16 | [2]: /docs/legacy/config-file
17 | [3]: /docs/legacy/run-your-own
18 |
--------------------------------------------------------------------------------
/packages/website/versioned_docs/version-legacy/styling.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Styling DocSearch
3 | ---
4 |
5 | import useBaseUrl from '@docusaurus/useBaseUrl';
6 |
7 | DocSearch default color scheme comes in a grey theme with blue highlight.
8 |
9 | ## Colorscheme
10 |
11 | })
15 |
16 | This theme works well with most websites, but we encourage you to style it to your own theme. You can achieved it by overriding the CSS classes used by the default theme.
17 |
18 | The following annotated example will help you style each part:
19 |
20 | ```css
21 | /* Main dropdown wrapper */
22 | .algolia-autocomplete .ds-dropdown-menu {
23 | width: 500px;
24 | }
25 |
26 | /* Main category (eg. Getting Started) */
27 | .algolia-autocomplete .algolia-docsearch-suggestion--category-header {
28 | color: darkgray;
29 | border: 1px solid gray;
30 | }
31 |
32 | /* Category (eg. Downloads) */
33 | .algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {
34 | color: gray;
35 | }
36 |
37 | /* Title (eg. Bootstrap CDN) */
38 | .algolia-autocomplete .algolia-docsearch-suggestion--title {
39 | font-weight: bold;
40 | color: black;
41 | }
42 |
43 | /* Description description (eg. Bootstrap currently works...) */
44 | .algolia-autocomplete .algolia-docsearch-suggestion--text {
45 | font-size: 0.8rem;
46 | color: gray;
47 | }
48 |
49 | /* Highlighted text */
50 | .algolia-autocomplete .algolia-docsearch-suggestion--highlight {
51 | color: blue;
52 | }
53 | ```
54 |
55 | ## Attribution
56 |
57 | We're happy to provide DocSearch free of charge for any documentation website, and you're encouraged to style it to fit your own theming. All we ask is that you keep the "Search by Algolia" logo and link next to your search results.
58 |
59 | The logo is automatically added in the dropdown with the default styling. It's our way to let more people know about what we do, and how they could benefit from a fast and relevant search on their website.
60 |
61 | If you're using your own [paid Algolia account][1] and [run the crawler yourself][2], you don't have to keep the logo.
62 |
63 | ## Debugging
64 |
65 | To inspect the dropdown markup with your browser tools, you should add `debug: true` to your `docsearch` call to prevent it from closing on inspection.
66 |
67 | ```javascript
68 | docsearch({
69 | […],
70 | debug: true
71 | });
72 | ```
73 |
74 | ## Other considerations
75 |
76 | The dropdown wraps selected suggestions in a `.ds-cursor` class. This means that you can use `.ds-cursor .algolia-docsearch-suggestion--content` to style the selected suggestion for example.
77 |
78 | On small screens, DocSearch reverts to a single column layout, while is uses the two-column layout shown in the screenshot on larger screens. You can add media queries (for example `@media (min-width: 768px) {}`) to target different displays.
79 |
80 | ## Advanced styling
81 |
82 | Whether you would like to do more heavy styling, feel free to have a look at the [SCSS source code][3]. `_variables.scss` contains all the default theming, sizing and breakpoints.
83 |
84 | You can generate your own CSS file by cloning the repository and running `yarn run build:css`. It generates the resulting file in `./dist/cdn`, and you should use them instead of the default one.
85 |
86 | [1]: https://www.algolia.com/pricing
87 | [2]: /docs/legacy/scraper-overview
88 | [3]: https://github.com/algolia/docsearch/tree/master/src/styles
89 |
--------------------------------------------------------------------------------
/packages/website/versioned_sidebars/version-legacy-sidebars.json:
--------------------------------------------------------------------------------
1 | {
2 | "docs": [
3 | {
4 | "collapsed": true,
5 | "type": "category",
6 | "label": "Adding DocSearch to your UI",
7 | "items": [
8 | {
9 | "type": "doc",
10 | "id": "dropdown"
11 | },
12 | {
13 | "type": "doc",
14 | "id": "styling"
15 | },
16 | {
17 | "type": "doc",
18 | "id": "behavior"
19 | }
20 | ]
21 | },
22 | {
23 | "collapsed": true,
24 | "type": "category",
25 | "label": "Requirements, tips, FAQ",
26 | "items": [
27 | {
28 | "type": "doc",
29 | "id": "required-configuration"
30 | },
31 | {
32 | "type": "doc",
33 | "id": "tips"
34 | },
35 | {
36 | "type": "doc",
37 | "id": "faq"
38 | },
39 | {
40 | "type": "doc",
41 | "id": "integrations"
42 | }
43 | ]
44 | },
45 | {
46 | "collapsed": true,
47 | "type": "category",
48 | "label": "Under the Hood",
49 | "items": [
50 | {
51 | "type": "doc",
52 | "id": "inside-the-engine"
53 | },
54 | {
55 | "type": "doc",
56 | "id": "config-file"
57 | },
58 | {
59 | "type": "doc",
60 | "id": "how-do-we-build-an-index"
61 | },
62 | {
63 | "type": "doc",
64 | "id": "run-your-own"
65 | }
66 | ]
67 | }
68 | ]
69 | }
70 |
--------------------------------------------------------------------------------
/packages/website/versions.json:
--------------------------------------------------------------------------------
1 | ["legacy"]
2 |
--------------------------------------------------------------------------------
/renovate.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3 | "extends": [
4 | "config:js-lib",
5 | "github>algolia/renovate-config-algolia"
6 | ],
7 | "baseBranches": [
8 | "chore/renovateBaseBranch"
9 | ],
10 | "packageRules": [
11 | {
12 | "packagePatterns": [
13 | "^@types"
14 | ],
15 | "depTypeList": [
16 | "devDependencies"
17 | ],
18 | "rangeStrategy": "replace"
19 | }
20 | ],
21 | "prHourlyLimit": 20
22 | }
23 |
--------------------------------------------------------------------------------
/rollup.base.config.js:
--------------------------------------------------------------------------------
1 | import { babel } from '@rollup/plugin-babel';
2 | import json from '@rollup/plugin-json';
3 | import resolve from '@rollup/plugin-node-resolve';
4 | import replace from '@rollup/plugin-replace';
5 | import terser from '@rollup/plugin-terser';
6 | import { dts } from 'rollup-plugin-dts';
7 | import filesize from 'rollup-plugin-filesize';
8 |
9 | export const plugins = [
10 | replace({
11 | preventAssignment: true,
12 | __DEV__: JSON.stringify(process.env.NODE_ENV === 'development'),
13 | }),
14 | json(),
15 | resolve({
16 | extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
17 | browser: true,
18 | }),
19 | babel({
20 | babelHelpers: 'bundled',
21 | exclude: 'node_modules/**',
22 | extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
23 | rootMode: 'upward',
24 | }),
25 | terser(),
26 | filesize({
27 | showMinifiedSize: false,
28 | showGzippedSize: true,
29 | }),
30 | ];
31 |
32 | export const typesConfig = {
33 | input: 'dist/esm/types/index.d.ts',
34 | output: [{ file: 'dist/esm/index.d.ts', format: 'es' }],
35 | plugins: [dts()],
36 | };
37 |
--------------------------------------------------------------------------------
/scripts/getBundleBanner.js:
--------------------------------------------------------------------------------
1 | import { execSync } from 'child_process';
2 |
3 | export function getBundleBanner(pkg) {
4 | const lastCommitHash = execSync('git rev-parse --short HEAD').toString().trim();
5 | const version = process.env.SHIPJS ? pkg.version : `${pkg.version} (UNRELEASED ${lastCommitHash})`;
6 | const authors = '© Algolia, Inc. and contributors';
7 |
8 | return `/*! ${pkg.name} ${version} | MIT License | ${authors} | ${pkg.homepage} */`;
9 | }
10 |
--------------------------------------------------------------------------------
/scripts/setupTests.ts:
--------------------------------------------------------------------------------
1 | import type { Mock } from 'vitest';
2 | import { vi } from 'vitest';
3 |
4 | type MatchMediaProps = Partial<{
5 | matches: boolean;
6 | media: string;
7 | onchange: null;
8 | addListener: Mock;
9 | removeListener: Mock;
10 | addEventListener: Mock;
11 | removeEventListener: Mock;
12 | dispatchEvent: Mock;
13 | }>;
14 |
15 | const createMatchMedia = (props: MatchMediaProps): Mock => {
16 | return vi.fn((query) => ({
17 | matches: false,
18 | media: query,
19 | onchange: null,
20 | addListener: vi.fn(),
21 | removeListener: vi.fn(),
22 | addEventListener: vi.fn(),
23 | removeEventListener: vi.fn(),
24 | dispatchEvent: vi.fn(),
25 | ...props,
26 | }));
27 | };
28 |
29 | vi.stubGlobal('scrollTo', vi.fn());
30 | vi.stubGlobal('matchMedia', createMatchMedia({ matches: true }));
31 |
--------------------------------------------------------------------------------
/ship.config.mjs:
--------------------------------------------------------------------------------
1 | import fs from 'fs';
2 | import path from 'path';
3 |
4 | const packages = ['packages/docsearch-css', 'packages/docsearch-react', 'packages/docsearch-js'];
5 |
6 | export default {
7 | monorepo: {
8 | mainVersionFile: 'lerna.json',
9 | // We rely on Lerna to bump our dependencies.
10 | packagesToBump: [],
11 | packagesToPublish: packages,
12 | },
13 | publishCommand({ tag }) {
14 | return `npm publish --tag ${tag}`;
15 | },
16 | versionUpdated({ exec, dir, version }) {
17 | // Update package dependencies
18 | exec(`yarn lerna version ${version} --exact --no-git-tag-version --no-push --yes`);
19 |
20 | // Ship.js reads JSON and writes with `fs.writeFileSync(JSON.stringify(json, null, 2))`
21 | // which causes a lint error in the `lerna.json` file.
22 | exec('yarn eslint lerna.json --fix');
23 |
24 | fs.writeFileSync(
25 | path.resolve(dir, 'packages', 'docsearch-react', 'src', 'version.ts'),
26 | `export const version = '${version}';\n`,
27 | );
28 | },
29 | };
30 |
--------------------------------------------------------------------------------
/tsconfig.declaration.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "./tsconfig",
3 | "compilerOptions": {
4 | "noEmit": false,
5 | "declaration": true,
6 | "emitDeclarationOnly": true
7 | }
8 | }
9 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "allowSyntheticDefaultImports": true,
4 | "jsx": "react",
5 | "module": "NodeNext",
6 | "moduleResolution": "NodeNext",
7 | "noFallthroughCasesInSwitch": true,
8 | "noImplicitAny": false,
9 | "noImplicitReturns": true,
10 | "noUnusedLocals": true,
11 | "noUnusedParameters": true,
12 | "resolveJsonModule": true,
13 | "skipLibCheck": true,
14 | "strict": true,
15 | "target": "ESNEXT"
16 | },
17 | "exclude": [
18 | "**/__fixtures__/**/*",
19 | "**/__mocks__/**/*",
20 | "**/dist",
21 | "**/node_modules",
22 | "cypress",
23 | "examples"
24 | ]
25 | }
26 |
--------------------------------------------------------------------------------
/vite.config.mts:
--------------------------------------------------------------------------------
1 | import { defineConfig } from 'vitest/config';
2 |
3 | export default defineConfig({
4 | test: {
5 | environment: 'jsdom',
6 | setupFiles: ['./scripts/setupTests.ts'],
7 | }
8 | });
9 |
--------------------------------------------------------------------------------