From fa4587a28774719ca06ad2643d00e7ecec4494ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Vannicatte?= Date: Mon, 6 Jun 2022 15:51:46 +0200 Subject: [PATCH] docs: remove v2 settings from v3 configs (#1409) --- packages/website/docs/record-extractor.md | 4 +- .../website/docs/required-configuration.mdx | 26 +---- packages/website/docs/templates.mdx | 105 ++---------------- 3 files changed, 17 insertions(+), 118 deletions(-) diff --git a/packages/website/docs/record-extractor.md b/packages/website/docs/record-extractor.md index 87c25eb89..8f7c35066 100644 --- a/packages/website/docs/record-extractor.md +++ b/packages/website/docs/record-extractor.md @@ -301,13 +301,13 @@ Custom variables are used to [`filter your search`](/docs/DocSearch-v3#filtering > `type: boolean` | default: `true` | **optional** -[This options](#reduce-the-number-records) groups the Algolia records created at the `content` level of the selector into a single record for its matching heading. +[This option](#reduce-the-number-records) groups the Algolia records created at the `content` level of the selector into a single record for its matching heading. ### `recordVersion` > `type: 'v3' | 'v2'` | default: `v2` | **optional** -[This options](#reduce-the-record-size) remove content from the Algolia records that are only used for [DocSearch v2](/docs/legacy/dropdown). If you are using [the latest version of DocSearch](/docs/DocSearch-v3), you can [set it to `v3`](#reduce-the-record-size). +This option remove content from the Algolia records that are only used for [DocSearch v2](/docs/legacy/dropdown). If you are using [the latest version of DocSearch](/docs/DocSearch-v3), you can [set it to `v3`](#reduce-the-record-size). ### `indexHeadings` diff --git a/packages/website/docs/required-configuration.mdx b/packages/website/docs/required-configuration.mdx index 230b383cf..7e18858ba 100644 --- a/packages/website/docs/required-configuration.mdx +++ b/packages/website/docs/required-configuration.mdx @@ -45,6 +45,7 @@ new Crawler({ content: ['article p, article li', 'main p, main li', 'p, li'], }, aggregateContent: true, + recordVersion: 'v3', }); }, }, @@ -60,37 +61,16 @@ new Crawler({ 'url_without_anchor', 'type', ], - attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'], + attributesToHighlight: ['hierarchy', 'content'], attributesToSnippet: ['content:10'], - camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'], + camelCaseAttributes: ['hierarchy', 'content'], searchableAttributes: [ - 'unordered(hierarchy_radio_camel.lvl0)', - 'unordered(hierarchy_radio.lvl0)', - 'unordered(hierarchy_radio_camel.lvl1)', - 'unordered(hierarchy_radio.lvl1)', - 'unordered(hierarchy_radio_camel.lvl2)', - 'unordered(hierarchy_radio.lvl2)', - 'unordered(hierarchy_radio_camel.lvl3)', - 'unordered(hierarchy_radio.lvl3)', - 'unordered(hierarchy_radio_camel.lvl4)', - 'unordered(hierarchy_radio.lvl4)', - 'unordered(hierarchy_radio_camel.lvl5)', - 'unordered(hierarchy_radio.lvl5)', - 'unordered(hierarchy_radio_camel.lvl6)', - 'unordered(hierarchy_radio.lvl6)', - 'unordered(hierarchy_camel.lvl0)', 'unordered(hierarchy.lvl0)', - 'unordered(hierarchy_camel.lvl1)', 'unordered(hierarchy.lvl1)', - 'unordered(hierarchy_camel.lvl2)', 'unordered(hierarchy.lvl2)', - 'unordered(hierarchy_camel.lvl3)', 'unordered(hierarchy.lvl3)', - 'unordered(hierarchy_camel.lvl4)', 'unordered(hierarchy.lvl4)', - 'unordered(hierarchy_camel.lvl5)', 'unordered(hierarchy.lvl5)', - 'unordered(hierarchy_camel.lvl6)', 'unordered(hierarchy.lvl6)', 'content', ], diff --git a/packages/website/docs/templates.mdx b/packages/website/docs/templates.mdx index 328c50098..b00453f83 100644 --- a/packages/website/docs/templates.mdx +++ b/packages/website/docs/templates.mdx @@ -205,7 +205,7 @@ new Crawler({ selectors: '', defaultValue: lvl0, }, - lvl1: 'header h1', + lvl1: ['header h1', 'article h1'], lvl2: 'article h2', lvl3: 'article h3', lvl4: 'article h4', @@ -215,6 +215,7 @@ new Crawler({ }, indexHeadings: true, aggregateContent: true, + recordVersion: 'v3', }); }, }, @@ -236,37 +237,16 @@ new Crawler({ 'url_without_anchor', 'type', ], - attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'], + attributesToHighlight: ['hierarchy', 'content'], attributesToSnippet: ['content:10'], - camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'], + camelCaseAttributes: ['hierarchy', 'content'], searchableAttributes: [ - 'unordered(hierarchy_radio_camel.lvl0)', - 'unordered(hierarchy_radio.lvl0)', - 'unordered(hierarchy_radio_camel.lvl1)', - 'unordered(hierarchy_radio.lvl1)', - 'unordered(hierarchy_radio_camel.lvl2)', - 'unordered(hierarchy_radio.lvl2)', - 'unordered(hierarchy_radio_camel.lvl3)', - 'unordered(hierarchy_radio.lvl3)', - 'unordered(hierarchy_radio_camel.lvl4)', - 'unordered(hierarchy_radio.lvl4)', - 'unordered(hierarchy_radio_camel.lvl5)', - 'unordered(hierarchy_radio.lvl5)', - 'unordered(hierarchy_radio_camel.lvl6)', - 'unordered(hierarchy_radio.lvl6)', - 'unordered(hierarchy_camel.lvl0)', 'unordered(hierarchy.lvl0)', - 'unordered(hierarchy_camel.lvl1)', 'unordered(hierarchy.lvl1)', - 'unordered(hierarchy_camel.lvl2)', 'unordered(hierarchy.lvl2)', - 'unordered(hierarchy_camel.lvl3)', 'unordered(hierarchy.lvl3)', - 'unordered(hierarchy_camel.lvl4)', 'unordered(hierarchy.lvl4)', - 'unordered(hierarchy_camel.lvl5)', 'unordered(hierarchy.lvl5)', - 'unordered(hierarchy_camel.lvl6)', 'unordered(hierarchy.lvl6)', 'content', ], @@ -449,6 +429,7 @@ new Crawler({ }, indexHeadings: true, aggregateContent: true, + recordVersion: 'v3', }); }, }, @@ -457,37 +438,16 @@ new Crawler({ YOUR_INDEX_NAME: { attributesForFaceting: ['type', 'lang'], attributesToRetrieve: ['hierarchy', 'content', 'anchor', 'url'], - attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'], + attributesToHighlight: ['hierarchy', 'content'], attributesToSnippet: ['content:10'], - camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'], + camelCaseAttributes: ['hierarchy', 'content'], searchableAttributes: [ - 'unordered(hierarchy_radio_camel.lvl0)', - 'unordered(hierarchy_radio.lvl0)', - 'unordered(hierarchy_radio_camel.lvl1)', - 'unordered(hierarchy_radio.lvl1)', - 'unordered(hierarchy_radio_camel.lvl2)', - 'unordered(hierarchy_radio.lvl2)', - 'unordered(hierarchy_radio_camel.lvl3)', - 'unordered(hierarchy_radio.lvl3)', - 'unordered(hierarchy_radio_camel.lvl4)', - 'unordered(hierarchy_radio.lvl4)', - 'unordered(hierarchy_radio_camel.lvl5)', - 'unordered(hierarchy_radio.lvl5)', - 'unordered(hierarchy_radio_camel.lvl6)', - 'unordered(hierarchy_radio.lvl6)', - 'unordered(hierarchy_camel.lvl0)', 'unordered(hierarchy.lvl0)', - 'unordered(hierarchy_camel.lvl1)', 'unordered(hierarchy.lvl1)', - 'unordered(hierarchy_camel.lvl2)', 'unordered(hierarchy.lvl2)', - 'unordered(hierarchy_camel.lvl3)', 'unordered(hierarchy.lvl3)', - 'unordered(hierarchy_camel.lvl4)', 'unordered(hierarchy.lvl4)', - 'unordered(hierarchy_camel.lvl5)', 'unordered(hierarchy.lvl5)', - 'unordered(hierarchy_camel.lvl6)', 'unordered(hierarchy.lvl6)', 'content', ], @@ -558,6 +518,7 @@ new Crawler({ }, indexHeadings: true, aggregateContent: true, + recordVersion: 'v3', }); }, }, @@ -566,37 +527,16 @@ new Crawler({ YOUR_INDEX_NAME: { attributesForFaceting: ['type', 'lang'], attributesToRetrieve: ['hierarchy', 'content', 'anchor', 'url'], - attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'], + attributesToHighlight: ['hierarchy', 'content'], attributesToSnippet: ['content:10'], - camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'], + camelCaseAttributes: ['hierarchy', 'content'], searchableAttributes: [ - 'unordered(hierarchy_radio_camel.lvl0)', - 'unordered(hierarchy_radio.lvl0)', - 'unordered(hierarchy_radio_camel.lvl1)', - 'unordered(hierarchy_radio.lvl1)', - 'unordered(hierarchy_radio_camel.lvl2)', - 'unordered(hierarchy_radio.lvl2)', - 'unordered(hierarchy_radio_camel.lvl3)', - 'unordered(hierarchy_radio.lvl3)', - 'unordered(hierarchy_radio_camel.lvl4)', - 'unordered(hierarchy_radio.lvl4)', - 'unordered(hierarchy_radio_camel.lvl5)', - 'unordered(hierarchy_radio.lvl5)', - 'unordered(hierarchy_radio_camel.lvl6)', - 'unordered(hierarchy_radio.lvl6)', - 'unordered(hierarchy_camel.lvl0)', 'unordered(hierarchy.lvl0)', - 'unordered(hierarchy_camel.lvl1)', 'unordered(hierarchy.lvl1)', - 'unordered(hierarchy_camel.lvl2)', 'unordered(hierarchy.lvl2)', - 'unordered(hierarchy_camel.lvl3)', 'unordered(hierarchy.lvl3)', - 'unordered(hierarchy_camel.lvl4)', 'unordered(hierarchy.lvl4)', - 'unordered(hierarchy_camel.lvl5)', 'unordered(hierarchy.lvl5)', - 'unordered(hierarchy_camel.lvl6)', 'unordered(hierarchy.lvl6)', 'content', ], @@ -748,37 +688,16 @@ new Crawler({ 'url', 'url_without_anchor', ], - attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'], + attributesToHighlight: ['hierarchy', 'content'], attributesToSnippet: ['content:10'], - camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'], + camelCaseAttributes: ['hierarchy', 'content'], searchableAttributes: [ - 'unordered(hierarchy_radio_camel.lvl0)', - 'unordered(hierarchy_radio.lvl0)', - 'unordered(hierarchy_radio_camel.lvl1)', - 'unordered(hierarchy_radio.lvl1)', - 'unordered(hierarchy_radio_camel.lvl2)', - 'unordered(hierarchy_radio.lvl2)', - 'unordered(hierarchy_radio_camel.lvl3)', - 'unordered(hierarchy_radio.lvl3)', - 'unordered(hierarchy_radio_camel.lvl4)', - 'unordered(hierarchy_radio.lvl4)', - 'unordered(hierarchy_radio_camel.lvl5)', - 'unordered(hierarchy_radio.lvl5)', - 'unordered(hierarchy_radio_camel.lvl6)', - 'unordered(hierarchy_radio.lvl6)', - 'unordered(hierarchy_camel.lvl0)', 'unordered(hierarchy.lvl0)', - 'unordered(hierarchy_camel.lvl1)', 'unordered(hierarchy.lvl1)', - 'unordered(hierarchy_camel.lvl2)', 'unordered(hierarchy.lvl2)', - 'unordered(hierarchy_camel.lvl3)', 'unordered(hierarchy.lvl3)', - 'unordered(hierarchy_camel.lvl4)', 'unordered(hierarchy.lvl4)', - 'unordered(hierarchy_camel.lvl5)', 'unordered(hierarchy.lvl5)', - 'unordered(hierarchy_camel.lvl6)', 'unordered(hierarchy.lvl6)', 'content', ],