feat: plugin-search

Author: ulivz

Diff for: packages/@vuepress/plugin-search/.npmignore

@@ -0,0 +1,2 @@
+__tests__
+__mocks__

Diff for: packages/@vuepress/plugin-search/README.md

@@ -0,0 +1,42 @@
+# @vuepress/plugin-search
+
+> header-based search plugin for vuepress
+
+## Usage
+
+1. Enable this plugin:
+
+```js
+// .vuepress/config.js or themedir/index.js
+
+module.exports = {
+  plugins: [
+    ['@vuepress/search', {
+      searchMaxSuggestions: 10
+    }]
+  ],
+  // Tweak the default color via palette.
+  palette: {
+    $accentColor: '#b58900',
+    $textColor: '#586e75',
+    $borderColor: '#eaecef',
+    $codeBgColor: '#282c34',
+    $arrowBgColor: '#ccc'
+  }
+}
+```
+
+2. Using search component:
+
+```vue
+import SearchBox from '@SearchBox'
+```
+
+## Options
+
+### searchMaxSuggestions
+
+- Type: `number`
+- Default: `true`
+
+Set the maximum number of results for search

Diff for: packages/@vuepress/theme-default/components/SearchBox.vue renamed to packages/@vuepress/plugin-search/SearchBox.vue

@@ -36,6 +36,7 @@
 </template>
 
 <script>
+/* global SEARCH_MAX_SUGGESTIONS */
 export default {
   data () {
     return {
@@ -60,8 +61,8 @@ export default {
         return
       }
 
-      const { pages, themeConfig } = this.$site
-      const max = themeConfig.searchMaxSuggestions || 5
+      const { pages } = this.$site
+      const max = SEARCH_MAX_SUGGESTIONS
       const localePath = this.$localePath
       const matches = item => (
         item.title &&

Diff for: packages/@vuepress/plugin-search/index.js

@@ -0,0 +1,11 @@
+const path = require('path')
+
+module.exports = (options) => ({
+  alias: {
+    '@SearchBox':
+      path.resolve(__dirname, 'SearchBox.vue')
+  },
+  define: {
+    SEARCH_MAX_SUGGESTIONS: options.searchMaxSuggestions || 5
+  }
+})

Diff for: packages/@vuepress/plugin-search/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@vuepress/plugin-search",
+  "version": "1.0.0",
+  "description": "search plugin for vuepress",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vuejs/vuepress.git"
+  },
+  "keywords": [
+    "documentation",
+    "vue",
+    "vuepress",
+    "generator"
+  ],
+  "author": "Evan You",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/vuejs/vuepress/issues"
+  },
+  "homepage": "https://github.com/vuejs/vuepress/packages/@vuepress/plugin-search#readme"
+}

Diff for: packages/@vuepress/theme-default/components/search.svg renamed to packages/@vuepress/plugin-search/search.svg

@@ -39,7 +39,7 @@
 <script>
 import SidebarButton from './SidebarButton.vue'
 import AlgoliaSearchBox from '@AlgoliaSearchBox'
-import SearchBox from './SearchBox.vue'
+import SearchBox from '@SearchBox'
 import NavLinks from './NavLinks.vue'
 
 export default {