Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Mar 3, 2025
1 parent ad78483 commit 093bca8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ search:
provider : algolia #Select a provider for enable search: lunr, algolia, google, simplesearch, fusejs
label : #default ["Search"] Text on navbar when search is enabled
landing_page : #default ["/search"] Link on navbar
maxwords : #default [30] simplesearch, fusejs only - May slow down your site build
maxwords : #default [30] lunr simplesearch, fusejs only - May slow down your site build
show_attrib : #default ["true"] Show attributions/logo on search engine
algolia_logo : true #Displays algolia logo. Should be set to true if you are on a community plan, otherwise false.

Expand Down
8 changes: 5 additions & 3 deletions docs/collections/_docs/02_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ To enable v4 support, set `fa_v4_support: true`.

When enabled, this theme would install an internal search capability of your site.
The following engines are available:

- [Lunr.js](https://lunrjs.com/)
- [Fuse.js](https://www.fusejs.io/)
- [Simple-Jekyll-Search](https://github.com/christian-fei/Simple-Jekyll-Search)
Expand All @@ -84,9 +85,10 @@ Algolia and Google CSE you may need to create an account and perform some additi
- `provider`: Select a provider for enable search: `lunr`, `algolia`, `google`, `simplesearch`, `fusejs`.
- `label`: Text to be displayed on the navbar when enabled. Useful for localization (i.e. you can set it as Búsqueda or Ricerca). **Search**.
- `landing_page`: url of your search page, useful for localization. **"/search"**.
- `lunr_maxwords`: `lunr` only, number of word to be included in the index. **30**.
- `simplesearch_maxwords`: `simplesearch` only, number of word to be included in the index. **30**.
- `fusejs_maxwords`: `fusejs` only, number of word to be included in the index. **30**.
- `lunr_maxwords`: **DEPRECATED**, use `maxwords`.
- `maxwords: `simplesearch`, `fusejs`, `lunr` only, number of word to be
included in the index. **30**.
- `show_attrib`: Show attributions/logo on search engine **true**.
- `algolia_logo`: Your must set it as `true` if your are on a Community (Free) Algolia plan.

- `google_cse_id`: Your Google Custom Search id, available on *cse.google.com > Your search engine > Settings*.
Expand Down

0 comments on commit 093bca8

Please sign in to comment.