diff --git a/packages/website/docs/DocSearch-v3.mdx b/packages/website/docs/DocSearch-v3.mdx index 47f4aaa6..9c79cac7 100644 --- a/packages/website/docs/DocSearch-v3.mdx +++ b/packages/website/docs/DocSearch-v3.mdx @@ -251,15 +251,15 @@ By adding this snippet to the `head` of your website, you can hint the browser t [2]: https://github.com/algolia/docsearch/ [3]: https://github.com/algolia/docsearch/tree/master [4]: /docs/legacy/dropdown -[5]: integrations +[5]: /docs/integrations [6]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors [7]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement [8]: https://codesandbox.io/s/docsearch-js-v3-playground-z9oxj [9]: https://codesandbox.io/s/docsearch-react-v3-playground-619yg [10]: https://www.npmjs.com/ -[11]: api#container -[12]: api -[13]: required-configuration#introduce-global-information-as-meta-tags -[14]: record-extractor#with-custom-variables +[11]: /docs/api#container +[12]: /docs/api +[13]: /docs/required-configuration#introduce-global-information-as-meta-tags +[14]: /docs/record-extractor#with-custom-variables [16]: https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/#facetfilters [15]: https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/ diff --git a/packages/website/docs/how-does-it-work.mdx b/packages/website/docs/how-does-it-work.mdx index f1593935..f1e69cb7 100644 --- a/packages/website/docs/how-does-it-work.mdx +++ b/packages/website/docs/how-does-it-work.mdx @@ -41,11 +41,11 @@ We'll then get back to you with the JavaScript snippet you'll need to add to you 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. -[1]: apply -[2]: who-can-apply +[1]: /apply +[2]: /docs/who-can-apply [3]: https://github.com/algolia/docsearch-configs/tree/master/configs -[4]: styling +[4]: /docs/styling [5]: https://www.algolia.com/products/search-and-discovery/crawler/ [6]: https://www.algolia.com/doc/tools/crawler/apis/configuration/ -[7]: DocSearch-v3 +[7]: /docs/DocSearch-v3 [8]: https://crawler.algolia.com/ diff --git a/packages/website/docs/migrating-from-legacy.mdx b/packages/website/docs/migrating-from-legacy.mdx index b9fbb932..f5349f8f 100644 --- a/packages/website/docs/migrating-from-legacy.mdx +++ b/packages/website/docs/migrating-from-legacy.mdx @@ -144,10 +144,10 @@ We plan to also include new indices (< 30 days activity) to the migration batch - [Docusaurus blog post](https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration) - [Algolia Dev chat 11-23-2021](https://www.youtube.com/watch?v=htsjpojpKtc&t=2404s) -[1]: DocSearch-v3 +[1]: /docs/DocSearch-v3 [2]: https://www.algolia.com/products/search-and-discovery/crawler/ [3]: /docs/legacy/run-your-own -[4]: record-extractor +[4]: /docs/record-extractor [7]: https://crawler.algolia.com/ [8]: https://github.com/algolia/docsearch-scraper [9]: https://github.com/algolia/docsearch-configs @@ -167,6 +167,6 @@ We plan to also include new indices (< 30 days activity) to the migration batch [26]: https://www.algolia.com/doc/tools/crawler/apis/configuration/initial-index-settings/ [27]: https://github.com/micromatch/micromatch [28]: https://www.algolia.com/doc/tools/crawler/apis/configuration/actions/#parameter-param-recordextractor -[29]: record-extractor -[30]: record-extractor#with-custom-variables -[31]: record-extractor#pagerank +[29]: /docs/record-extractor +[30]: /docs/record-extractor#with-custom-variables +[31]: /docs/record-extractor#pagerank diff --git a/packages/website/docs/record-extractor.md b/packages/website/docs/record-extractor.md index e8220a0f..7124acae 100644 --- a/packages/website/docs/record-extractor.md +++ b/packages/website/docs/record-extractor.md @@ -252,7 +252,7 @@ type CustomVariable = Contains values that can be used as [`facetFilters`][15] -[1]: DocSearch-v3 +[1]: /docs/DocSearch-v3 [2]: https://github.com/algolia/docsearch/ [3]: https://github.com/algolia/docsearch/tree/master [4]: /docs/legacy/dropdown diff --git a/packages/website/docs/required-configuration.mdx b/packages/website/docs/required-configuration.mdx index 7c272dda..0b75785d 100644 --- a/packages/website/docs/required-configuration.mdx +++ b/packages/website/docs/required-configuration.mdx @@ -19,7 +19,6 @@ If you are using one of [our integrations][13], please see [the templates page][
docsearch-default.js
- ```js new Crawler({ appId: 'YOUR_APP_ID', @@ -129,7 +128,6 @@ new Crawler({
- ### Overview of a clear layout A website implementing these good practises will look simple and crystal clear. It can have this following aspect: @@ -194,7 +192,7 @@ You can then [transform these attributes as `facetFilters`][3] to [filter over t Any questions? [Send us an email][9]. -[1]: integrations +[1]: /docs/integrations [2]: record-extractor#recordProps-api-reference [3]: https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/ [5]: https://html.spec.whatwg.org/dev/common-microsyntaxes.html#comma-separated-tokens @@ -202,7 +200,7 @@ Any questions? [Send us an email][9]. [7]: https://www.sitemaps.org/ [8]: https://www.algolia.com/doc/tools/crawler/apis/configuration/render-java-script/ [9]: mailto:DocSearch@algolia.com -[10]: DocSearch-v3#filtering-your-search -[11]: templates -[12]: record-extractor#complex-extractors -[13]: integrations +[10]: /docs/DocSearch-v3#filtering-your-search +[11]: /docs/templates +[12]: /docs/record-extractor#complex-extractors +[13]: /docs/integrations diff --git a/packages/website/docs/styling.md b/packages/website/docs/styling.md index 7e2e0eef..7432603e 100644 --- a/packages/website/docs/styling.md +++ b/packages/website/docs/styling.md @@ -51,7 +51,7 @@ If you don’t want to use a package manager, you can use a standalone endpoint: └── dist/modal.css # CSS for the modal ``` -[1]: DocSearch-v3 +[1]: /docs/DocSearch-v3 [2]: https://github.com/algolia/docsearch/ [3]: https://github.com/algolia/docsearch/tree/master [4]: /docs/legacy/dropdown diff --git a/packages/website/docs/who-can-apply.md b/packages/website/docs/who-can-apply.md index 81908677..5e236e07 100644 --- a/packages/website/docs/who-can-apply.md +++ b/packages/website/docs/who-can-apply.md @@ -30,7 +30,7 @@ We're receiving dozens of requests every day, and while we strive to answer them - πŸ™ If we need to render your website in the browser through JavaScript, it means that we'll have to crawl it through a much slower browser emulation. We highly recommend that you put in place server-side rendering for the useful textual content. -[1]: DocSearch-v3 +[1]: /docs/DocSearch-v3 [2]: /apply [3]: /docs/legacy/run-your-own [4]: https://www.algolia.com/doc/api-client/getting-started/install/javascript/?client=javascript diff --git a/packages/website/versioned_docs/version-legacy/behavior.md b/packages/website/versioned_docs/version-legacy/behavior.md index 1947151a..5f938d1a 100644 --- a/packages/website/versioned_docs/version-legacy/behavior.md +++ b/packages/website/versioned_docs/version-legacy/behavior.md @@ -123,7 +123,6 @@ docsearch({ ``` [1]: https://github.com/algolia/autocomplete/tree/master -[2]: run-your-own.md [3]: https://codesandbox.io/s/docsearchjs-open-in-new-tab-tgs2h [4]: https://github.com/algolia/autocomplete/tree/master#global-options [5]: https://www.algolia.com/doc/api-reference/api-parameters/ diff --git a/packages/website/versioned_docs/version-legacy/faq.md b/packages/website/versioned_docs/version-legacy/faq.md index b0d4f951..1e5943c0 100644 --- a/packages/website/versioned_docs/version-legacy/faq.md +++ b/packages/website/versioned_docs/version-legacy/faq.md @@ -82,9 +82,9 @@ The `apiKey` the DocSearch team provides is [a search-only key][17] and can be s [1]: mailto:docsearch@algolia.com [4]: https://www.algolia.com/doc/guides/infrastructure/servers/ [5]: https://www.algolia.com/policies/privacy -[6]: run-your-own.md +[6]: /docs/legacy/run-your-own [7]: https://www.algolia.com/doc/api-reference/ -[8]: config-file.md +[8]: /docs/legacy/config-file [9]: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/in-depth/asynchronicity-and-when-to-wait-for-tasks/#atomic-reindexing [10]: https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/ [11]: tips.md diff --git a/packages/website/versioned_docs/version-legacy/inside-the-engine.md b/packages/website/versioned_docs/version-legacy/inside-the-engine.md index 76e16e71..d1008a0a 100644 --- a/packages/website/versioned_docs/version-legacy/inside-the-engine.md +++ b/packages/website/versioned_docs/version-legacy/inside-the-engine.md @@ -35,6 +35,6 @@ You can boost pages depending on their URLs. You should use the `start_urls` and 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. [1]: https://www.sitemaps.org/ -[2]: how-do-we-build-an-index.mdx +[2]: /docs/legacy/how-do-we-build-an-index [3]: https://www.algolia.com/doc/guides/ranking/ranking-formula/#tie-breaking-approach [4]: https://www.algolia.com/doc/guides/ranking/custom-ranking/ diff --git a/packages/website/versioned_docs/version-legacy/required-configuration.md b/packages/website/versioned_docs/version-legacy/required-configuration.md index 630bd9f1..ee7216ad 100644 --- a/packages/website/versioned_docs/version-legacy/required-configuration.md +++ b/packages/website/versioned_docs/version-legacy/required-configuration.md @@ -118,12 +118,12 @@ version:["2.0.0-alpha.62" , "latest"] Any questions? [Send us an email][9]. -[1]: how-do-we-build-an-index.mdx -[2]: config-file.md#selectors +[1]: /docs/legacy/how-do-we-build-an-index +[2]: /docs/legacy/config-file#selectors [3]: https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/ -[4]: config-file.md#custom_settings-optional +[4]: /docs/legacy/config-file#custom_settings-optional [5]: https://html.spec.whatwg.org/dev/common-microsyntaxes.html#comma-separated-tokens [6]: https://semver.org/ [7]: https://www.sitemaps.org/ -[8]: config-file.md#js_render-optional +[8]: /docs/legacy/config-file#js_render-optional [9]: mailto:DocSearch@algolia.com diff --git a/packages/website/versioned_docs/version-legacy/run-your-own.md b/packages/website/versioned_docs/version-legacy/run-your-own.md index 6a093be9..3446f5fb 100644 --- a/packages/website/versioned_docs/version-legacy/run-your-own.md +++ b/packages/website/versioned_docs/version-legacy/run-your-own.md @@ -136,13 +136,13 @@ _Note that we use this command-line tool internally at Algolia to run the free h [2]: https://www.algolia.com/pricing [3]: https://www.algolia.com/doc/guides/security/api-keys/#acl [4]: https://github.com/stedolan/jq/wiki/Installation -[5]: config-file.md +[5]: /docs/legacy/config-file [6]: #integration [7]: https://scrapy.org/ [8]: https://github.com/pypa/pipenv [9]: https://github.com/algolia/docsearch-scraper [10]: https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv -[11]: config-file.md +[11]: /docs/legacy/config-file [12]: http://chromedriver.chromium.org/getting-started [13]: https://github.com/algolia/docsearch-configs/tree/master/configs -[14]: dropdown.md +[14]: /docs/legacy/dropdown diff --git a/packages/website/versioned_docs/version-legacy/scraper-overview.md b/packages/website/versioned_docs/version-legacy/scraper-overview.md index e330ba3e..fec37ba9 100644 --- a/packages/website/versioned_docs/version-legacy/scraper-overview.md +++ b/packages/website/versioned_docs/version-legacy/scraper-overview.md @@ -13,5 +13,5 @@ Those CSS selectors can be overwritten, and each website has its own JSON config 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. [1]: https://scrapy.org/ -[2]: config-file.md -[3]: run-your-own.md +[2]: /docs/legacy/config-file +[3]: /docs/legacy/run-your-own diff --git a/packages/website/versioned_docs/version-legacy/styling.mdx b/packages/website/versioned_docs/version-legacy/styling.mdx index 5a313905..7420bf0c 100644 --- a/packages/website/versioned_docs/version-legacy/styling.mdx +++ b/packages/website/versioned_docs/version-legacy/styling.mdx @@ -90,5 +90,5 @@ Whether you would like to do more heavy styling, feel free to have a look at the 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. [1]: https://www.algolia.com/pricing -[2]: scraper-overview.md +[2]: /docs/legacy/scraper-overview [3]: https://github.com/algolia/docsearch/tree/master/src/styles