Skip to content

Commit 88f7435

Browse files
committed
chore: address comments
1 parent a95aa89 commit 88f7435

File tree

6 files changed

+18
-8
lines changed

6 files changed

+18
-8
lines changed

docs/config/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Also, only enable this if you are able to deploy your site with SSL, since servi
103103
- Type: `Object`
104104
- Default: `undefined`
105105

106-
Using `algolia` option allows you to disable the default built-in headers-based search and leverage the [algolia docsearch](https://github.com/algolia/docsearch), to enable this search, You have to provide at least `apiKey` and `indexName`:
106+
Using `algolia` option allows you to leverage [algolia docsearch](https://github.com/algolia/docsearch) to displace the default built-in headers-based search, to enable this search, you have to provide at least `apiKey` and `indexName`:
107107

108108
```js
109109
module.exports = {

docs/zh/config/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ module.exports = {
102102
- 类型: `Object`
103103
- 默认值: `undefined`
104104

105-
使用 `algolia` 选项可以让你禁用掉默认的基于 headers 的搜索,从而使用 [algolia docsearch](https://github.com/algolia/docsearch)。为了使其生效,你必须提供至少 `apiKey``indexName` 这两个选项:
105+
使用 `algolia` 选项可以让你用 [algolia docsearch](https://github.com/algolia/docsearch) 取代默认的基于 headers 的搜索 。为了使其生效,你必须提供至少 `apiKey``indexName` 这两个选项:
106106

107107
```js
108108
module.exports = {
@@ -113,7 +113,7 @@ module.exports = {
113113
}
114114
```
115115

116-
其他可用的选项可以参考 [docsearch options](https://github.com/algolia/docsearch#docsearch-options)
116+
其他可用的选项请参考 [docsearch options](https://github.com/algolia/docsearch#docsearch-options)
117117

118118
### locales
119119

lib/default-theme/Navbar.vue

+2-5
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
</router-link>
1414
<div class="links">
1515
<AlgoliaSearchBox v-if="isAlgoliaSearch" :options="algolia"/>
16-
<SearchBox v-if="isSearch"/>
16+
<SearchBox v-else-if="$site.themeConfig.search !== false"/>
1717
<NavLinks class="can-hide"/>
1818
</div>
1919
</header>
2020
</template>
2121

2222
<script>
2323
import SidebarButton from './SidebarButton.vue'
24-
import AlgoliaSearchBox from './AlgoliaSearchBox.vue'
24+
import AlgoliaSearchBox from '@AlgoliaSearchBox'
2525
import SearchBox from './SearchBox.vue'
2626
import NavLinks from './NavLinks.vue'
2727
@@ -34,9 +34,6 @@ export default {
3434
isAlgoliaSearch () {
3535
const algolia = this.algolia
3636
return algolia && algolia.apiKey && algolia.indexName
37-
},
38-
isSearch() {
39-
return !this.isAlgoliaSearch && this.$site.themeConfig.search !== false
4037
}
4138
}
4239
}

lib/noop.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {}

lib/prepare.js

+8
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,13 @@ async function resolveOptions (sourceDir) {
112112
!fs.existsSync(path.resolve(vuepressDir, 'theme'))
113113
)
114114

115+
// resolve algolia
116+
const isAlgoliaSearch = (
117+
siteConfig.algolia ||
118+
Object.keys(siteConfig.locales && siteConfig.themeConfig && siteConfig.themeConfig.locales || {})
119+
.some(base => siteConfig.themeConfig.locales[base].algolia)
120+
)
121+
115122
const options = {
116123
siteConfig,
117124
sourceDir,
@@ -124,6 +131,7 @@ async function resolveOptions (sourceDir) {
124131
themePath: null,
125132
notFoundPath: null,
126133
useDefaultTheme,
134+
isAlgoliaSearch,
127135
markdown: createMarkdown(siteConfig)
128136
}
129137

lib/webpack/createBaseConfig.js

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ module.exports = function createBaseConfig ({
77
publicPath,
88
themePath,
99
notFoundPath,
10+
isAlgoliaSearch,
1011
markdown
1112
}, { debug } = {}, isServer) {
1213
const Config = require('webpack-chain')
@@ -39,6 +40,9 @@ module.exports = function createBaseConfig ({
3940
.set('@source', sourceDir)
4041
.set('@app', path.resolve(__dirname, '../app'))
4142
.set('@temp', path.resolve(__dirname, '../app/.temp'))
43+
.set('@AlgoliaSearchBox', isAlgoliaSearch
44+
? path.resolve(__dirname, '../default-theme/AlgoliaSearchBox.vue')
45+
: path.resolve(__dirname, '../noop.js'))
4246
.end()
4347
.extensions
4448
.merge(['.js', '.jsx', '.vue', '.json'])

0 commit comments

Comments
 (0)