Skip to content

Commit

Permalink
README.md - explanation of config
Browse files Browse the repository at this point in the history
  • Loading branch information
smori1983 committed Sep 5, 2023
1 parent a8e37a6 commit 3e1ae11
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ module.exports = {
//searchHotKeys: ['s', '/'],
//searchMaxSuggestions: 20,
//searchPaths: null,
//uiAlignRightFactor: 10,
//excerptAroundLength: 100,
//excerptHeadText: '... ',
//excerptTailText: ' ...',
//tokenizerType: 'kuromoji.default',
//ngramSize: 3,
//uiAlignRightFactor: 10,
}],
],

Expand Down Expand Up @@ -50,6 +50,13 @@ The maximum number of results for search.

Configure if you want to limit the searchable paths.

### uiAlignRightFactor

- Type: `number`
- Default: `10`

Condition to add class attribute of `align-light` to suggestions area, which will be added when the number of navbar menus is less than `uiAlignRightFactor`.

### excerptAroundLength

- Type: `number`
Expand Down Expand Up @@ -81,13 +88,6 @@ Define text which is shown for abbreviation if succeeding text is longer than `e
- Type: `number`
- Default: `3`

### uiAlignRightFactor

- Type: `number`
- Default: `10`

Condition to add class attribute of `align-light` to suggestions area, which will be added when the number of navbar menus is less than `uiAlignRightFactor`.


## Dev server launch option

Expand Down

0 comments on commit 3e1ae11

Please sign in to comment.