nikon/docsearch
1
0
Fork 0
Code Activity Actions

docs: fix pageRank type (#1848)

Browse source 
* docs: fix `pageRank` type

* lint
This commit is contained in:
Clément Vannicatte 2023-04-07 14:43:10 +02:00 committed by GitHub
parent d7f5e00704
commit f241cc7869
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
packages/website/docs/record-extractor.md
View file

@ -176,8 +176,6 @@ You can now use them to [filter your search in the frontend][16]
### Boost search results with `pageRank`
_[`pageRank`](#pagerank) used to be an **integer**, it is now a **string**_
This parameter allow you to boost records built from the current `pathsToMatch`. Pages with highest [`pageRank`](#pagerank) will be returned before pages with a lower [`pageRank`](#pagerank). Note that you can pass any numeric value **as a string**, including negative values:
```js
@ -194,7 +192,7 @@ This parameter allow you to boost records built from the current `pathsToMatch`.
lvl4: "article h5",
lvl5: "article h6",
content: "article p, article li",
pageRank: "30",
pageRank: 30,
},
});
},
@ -274,7 +272,7 @@ type Lvl0 = {
### `pageRank`
> `type: string` | **optional**
> `type: number` | **optional**
See the [live example](#boost-search-results-with-pagerank)

7
packages/website/src/components/Home.js
View file

@ -162,9 +162,10 @@ function Home() {
Made for Developer docs
</h4>
<p className="mt-2 text-base leading-6 text-description">
Initially created to fulfill our own documentation needs,
DocSearch eventually became a community project for open source docs.
But, now it is available for any/all kinds of developer documentation.
Initially created to fulfill our own documentation
needs, DocSearch eventually became a community project
for open source docs. But, now it is available for
any/all kinds of developer documentation.
</p>
</div>
</div>