recipe/docs/search-pro/src
2024-08-18 19:16:25 +08:00
..
.vuepress first load 2024-08-18 19:16:25 +08:00
zh first load 2024-08-18 19:16:25 +08:00
README.md first load 2024-08-18 19:16:25 +08:00

home title icon heroText tagline actions features footer copyrightText
true Home home vuepress-plugin-search-pro Powerful client search plugin for VuePress2
text icon link type
Guide lightbulb ./guide.html primary
text icon link
Config tools ./config.html
title icon details link
High Performance rocket High speed searching in a separated worker powered by <strong>slimsearch</strong> ./guide.html#ultra-fast
title icon details link
Full Indexing file-zipper Indexing all contents in your site ./guide.html#index-range
title icon details link
Highlight and Context highlighter Highlight keywords and show related context in search result ./guide.html#highlighting-and-context
title icon details link
Auto Suggest lightbulb Get query suggestions while typing ./guide.html#auto-suggestions
title icon details link
Custom Fields gears Adding data to index with options ./guide.html#custom-fields
title icon details link
Search History clock Preserve history of queries and results ./guide.html#query-and-search-history
MIT Licensed | Copyright © 2022-present Mr.Hope false

How to use

Install

::: code-tabs#shell

@tab pnpm

pnpm add -D vuepress-plugin-search-pro

@tab yarn

yarn add -D vuepress-plugin-search-pro

@tab npm

npm i -D vuepress-plugin-search-pro

:::

Usage

::: code-tabs#language

@tab TS

import { searchProPlugin } from "vuepress-plugin-search-pro";

export default {
  plugins: [
    searchProPlugin({
      // your options
    }),
  ],
};

@tab JS

import { searchProPlugin } from "vuepress-plugin-search-pro";

export default {
  plugins: [
    searchProPlugin({
      // your options
    }),
  ],
};

:::