You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
This plugin provides full-text search functionality for **VuePress v2**. It is designed to address the search needs of VuePress sites, offering a fast and efficient way to search through the content of your site. The plugin automatically generates a search index from your site's pages and provides a simple way for users to search through the content.
6
6
7
-
This plugin is built to work with the latest version of VuePress, but also maintains backward compatibility for VuePress versions up to **v2.0.0-beta.43**. It ensures smooth transitions for users upgrading their VuePress projects.
7
+
This plugin is built to work with the latest version of VuePress.
8
8
9
9
##### Features
10
10
@@ -13,11 +13,31 @@ This plugin is built to work with the latest version of VuePress, but also maint
13
13
-**HMR Support**: Includes Hot Module Replacement (HMR) code to allow live updates of the search index during development.
14
14
-**Search Index Generation**: A script that generates the search index by extracting relevant data from your site's pages.
15
15
16
-
##### Installation
16
+
##### Installation & use
17
17
18
18
To install the plugin, follow these steps:
19
19
20
20
1.**Install the plugin** via npm:
21
21
22
22
```bash
23
23
npm install vuepress-serach-plugin --save
24
+
25
+
2. ***usage**in config.js
26
+
```
27
+
import fullTextSearchPlugin from "vuepress-serach-plugin";
0 commit comments