nikon/docsearch
1
0
Fork 0
Code Activity Actions

docs(template): update Docusaurus v2 template (#1184)

Browse source
This commit is contained in:
Clément Vannicatte 2021-11-22 17:46:50 +01:00 committed by GitHub
parent ef13dea393
commit 07bbb80a24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
packages/website/docs/templates.mdx
View file

@ -28,7 +28,6 @@ Templates are available when you [create a new Crawler](https://crawler.algolia.
<details><summary>docusaurus-v1.js</summary> <details><summary>docusaurus-v1.js</summary>
<div> <div>
```js ```js
new Crawler({ new Crawler({
appId: 'YOUR_APP_ID', appId: 'YOUR_APP_ID',
@ -177,13 +176,11 @@ new Crawler({
</div> </div>
</details> </details>
## Docusaurus v2 template ## Docusaurus v2 template
<details><summary>docusaurus-v2.js</summary> <details><summary>docusaurus-v2.js</summary>
<div> <div>
```js ```js
new Crawler({ new Crawler({
appId: 'YOUR_APP_ID', appId: 'YOUR_APP_ID',
@ -198,14 +195,19 @@ new Crawler({
indexName: 'YOUR_INDEX_NAME', indexName: 'YOUR_INDEX_NAME',
pathsToMatch: ['https://YOUR_WEBSITE_URL/**'], pathsToMatch: ['https://YOUR_WEBSITE_URL/**'],
recordExtractor: ({ $, helpers }) => { recordExtractor: ({ $, helpers }) => {
// priority order: deepest active sub list header -> navbar active item -> 'Documentation'
const lvl0 =
$(
'.menu__link.menu__link--sublist.menu__link--active, .navbar__item.navbar__link--active'
)
.last()
.text() || 'Documentation';
return helpers.docsearch({ return helpers.docsearch({
recordProps: { recordProps: {
lvl0: { lvl0: {
selectors: [ selectors: '',
'.menu__link.menu__link--sublist.menu__link--active', defaultValue: lvl0,
'.navbar__item.navbar__link--active',
],
defaultValue: 'Documentation',
}, },
lvl1: 'header h1', lvl1: 'header h1',
lvl2: 'article h2', lvl2: 'article h2',
@ -306,13 +308,11 @@ new Crawler({
</div> </div>
</details> </details>
## Vuepress v1 template ## Vuepress v1 template
<details><summary>vuepress-v1.js</summary> <details><summary>vuepress-v1.js</summary>
<div> <div>
```js ```js
new Crawler({ new Crawler({
appId: 'YOUR_APP_ID', appId: 'YOUR_APP_ID',
@ -417,13 +417,11 @@ new Crawler({
</div> </div>
</details> </details>
## Vuepress v2 template ## Vuepress v2 template
<details><summary>vuepress-v2.js</summary> <details><summary>vuepress-v2.js</summary>
<div> <div>
```js ```js
new Crawler({ new Crawler({
appId: 'YOUR_APP_ID', appId: 'YOUR_APP_ID',
@ -528,13 +526,11 @@ new Crawler({
</div> </div>
</details> </details>
## Vitepress template ## Vitepress template
<details><summary>vitepress.js</summary> <details><summary>vitepress.js</summary>
<div> <div>
```js ```js
new Crawler({ new Crawler({
appId: 'YOUR_APP_ID', appId: 'YOUR_APP_ID',
@ -638,13 +634,11 @@ new Crawler({
</div> </div>
</details> </details>
## pkgdown template ## pkgdown template
<details><summary>pkgdown.js</summary> <details><summary>pkgdown.js</summary>
<div> <div>
```js ```js
new Crawler({ new Crawler({
appId: 'YOUR_APP_ID', appId: 'YOUR_APP_ID',
@ -820,6 +814,5 @@ new Crawler({
</div> </div>
</details> </details>
[1]: mailto:docsearch@algolia.com [1]: mailto:docsearch@algolia.com
[2]: https://github.com/algolia/docsearch [2]: https://github.com/algolia/docsearch