Skip to content

Commit 145df84

Browse files
committed
Add dark mode section inside the readme
1 parent c151579 commit 145df84

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,30 @@ module.exports = {
111111
maxSuggestions: 10, // Default: 5
112112
hotKeys: [], // Default: ['s', '/']
113113
cropLength: 50, // Default: 30
114-
layout: 'simple' // Default: "columns"
114+
layout: 'simple', // Default: "columns"
115+
enableDarkMode: true // Default: false
115116
}
116117
]
117118
]
118119
}
119120
```
120121

122+
#### Dark mode
123+
124+
You can enable dark mode by adding `enableDarkMode: true` to your configuration file.
125+
126+
To override the default theme of the searchbar, you can edit your `.vuepress/styles/palette.styl` file.
127+
A few variables are available :
128+
129+
```js
130+
$msAccentDarkColor
131+
$msInputDarkBgColor
132+
$msTextDarkColor
133+
$borderDarkColor
134+
```
135+
136+
You can also find an example in our [playground's `palette.styl` file](./playground/.vuepress/styles/palette.styl)
137+
121138
## Compatibility with MeiliSearch
122139

123140
This package only guarantees the compatibility with the [version v0.20.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.20.0).

0 commit comments

Comments
 (0)