Doc/update content (#419)
* # This is a combination of 2 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: chore(deps): update dependency onchange to v4.1.0 integrate previous work enhance tyle/content reformat part 1 wait for review adance start_urls enhance attributes description fix typo proofread documentation/docsearch add apiKey mention intefrate review and small fixes finished proofreading update sclient-rendering use unseen review # This is the commit message #2: update README #269 # This is the commit message #3: fix json # This is the commit message #2: enhance as algolia/docsearch-configs#387 # This is the commit message #3: updating flavicon # This is the commit message #2: Update 1-customize-configuration-file.html.md.erb * # This is a combination of 2 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: chore(deps): update dependency onchange to v4.1.0 integrate previous work enhance tyle/content reformat part 1 wait for review adance start_urls enhance attributes description fix typo proofread documentation/docsearch add apiKey mention intefrate review and small fixes finished proofreading update sclient-rendering use unseen review # This is the commit message #2: update README #269 # This is the commit message #3: fix json # This is the commit message #2: enhance as algolia/docsearch-configs#387 # This is the commit message #3: updating flavicon # This is the commit message #2: Update 1-customize-configuration-file.html.md.erb * documenting algolia/docsearch-scraper#387 * documenting algolia/docsearch-scraper#387 * fixing changelog * fixing typo * # This is a combination of 2 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: chore(deps): update dependency onchange to v4.1.0 integrate previous work enhance tyle/content reformat part 1 wait for review adance start_urls enhance attributes description fix typo proofread documentation/docsearch add apiKey mention intefrate review and small fixes finished proofreading update sclient-rendering use unseen review # This is the commit message #2: update README #269 # This is the commit message #3: fix json # This is the commit message #2: enhance as algolia/docsearch-configs#387 # This is the commit message #3: updating flavicon # This is the commit message #2: Update 1-customize-configuration-file.html.md.erb * # This is a combination of 2 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: # This is a combination of 3 commits. # This is the 1st commit message: chore(deps): update dependency onchange to v4.1.0 integrate previous work enhance tyle/content reformat part 1 wait for review adance start_urls enhance attributes description fix typo proofread documentation/docsearch add apiKey mention intefrate review and small fixes finished proofreading update sclient-rendering use unseen review # This is the commit message #2: update README #269 # This is the commit message #3: fix json # This is the commit message #2: enhance as algolia/docsearch-configs#387 # This is the commit message #3: updating flavicon # This is the commit message #2: Update 1-customize-configuration-file.html.md.erb * documenting algolia/docsearch-scraper#387 * documenting algolia/docsearch-scraper#387 * fixing typo * fixing style issue * fixing recurrnet issue * general github handle * fixing missed conflict * fix and closes algolia/docsearch-configs-private#82 * remove builded content * adding hitsperpage
This commit is contained in:
Sylvain Pace
GitHub
parent
6330a469fc
commit
5e897d3f4d
3 changed files with 11 additions and 12 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -8,3 +8,4 @@ yarn-error.log
|
|||
dist-es5-module/
|
||||
yarn.lock
|
||||
tmp
|
||||
docs/build/
|
||||
|
|
@ -100,14 +100,20 @@ search.autocomplete.on('autocomplete:opened', event => {
|
|||
You can pass options to the Algolia API by using the `algoliaOptions`
|
||||
key. You will find all Algolia API options in their [own documentation][3].
|
||||
|
||||
For example, you might want to increase the number of results displayed in the dropdown.
|
||||
[`hitsPerPage `set the number of shown hits][4].
|
||||
|
||||
```javascript
|
||||
docsearch({
|
||||
algoliaOptions: {
|
||||
hitsPerPage: 10,
|
||||
// See https://www.algolia.com/doc/api-reference/api-parameters/
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
[1]: https://github.com/algolia/autocomplete.js
|
||||
[2]: https://github.com/algolia/autocomplete.js#options
|
||||
[3]: https://www.algolia.com/doc/api-reference/api-parameters/
|
||||
[4]: https://www.algolia.com/doc/api-reference/api-parameters/hitsPerPage/
|
||||
|
|
|
|||
|
|
@ -95,7 +95,6 @@ docsearch({
|
|||
},
|
||||
});
|
||||
```
|
||||
>>>>>>> Updating config doc
|
||||
|
||||
### Using custom tags
|
||||
|
||||
|
|
@ -195,17 +194,10 @@ set of selectors should be applied to specific pages.
|
|||
}
|
||||
```
|
||||
|
||||
<<<<<<< HEAD
|
||||
### `start_urls.tags`
|
||||
|
||||
Tags will be apllied to every record from the matchin matched pages, i.e., its URL is matchin the `url`. These `tags` will [be processed as `attributesForFaceting`](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/) . If you want further detail, [check the original documentation](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
|
||||
We do recommend to use `tags` if you want [to refine the scope of your search](https://www.algolia.com/doc/guides/searching/faceting/#faceting-overview).
|
||||
=======
|
||||
Here, all documentation pages will use the selectors defined in
|
||||
`selectors.default` while the page under `./concepts` will use
|
||||
`selectors.concepts` and those under `./contributors` will use
|
||||
`selectors.contributors`.
|
||||
>>>>>>> Updating config doc
|
||||
|
||||
## `selectors`
|
||||
|
||||
|
|
@ -406,13 +398,13 @@ If used, `min_indexed_level` is ignored.
|
|||
|
||||
### `scrape_start_urls` _Optional_
|
||||
|
||||
By default, the crawler will not extract content from the pages defined in
|
||||
`starts_urls`. If you have valuable content on your homepage, you should set
|
||||
this to `true`.
|
||||
By default, the crawler will extract content from the pages defined in
|
||||
`starts_urls`. If you do have valuable content on your `starts_urls` or these pages are duplicates from another one, you should set
|
||||
this to `false`.
|
||||
|
||||
```json
|
||||
{
|
||||
"scrape_start_urls": true
|
||||
"scrape_start_urls": false
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue