Skip to content

Commit 397dc22

Browse files
committed
docs: add plugin install command
1 parent 5e94d63 commit 397dc22

36 files changed

+216
-0
lines changed

docs/reference/plugin/active-header-links.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ This plugin will listen to page scroll event. When the page scrolls to a certain
66

77
This plugin is mainly used to develop themes, and has been integrated into the default theme. You won't need to use it directly in most cases.
88

9+
## Install
10+
11+
```bash
12+
npm i -D @vuepress/plugin-active-header-links@next
13+
```
14+
915
## Options
1016

1117
### headerLinkSelector

docs/reference/plugin/back-to-top.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ This plugin will add a _back to top_ button to your site. The button will be dis
66

77
This plugin has been integrated into the default theme.
88

9+
## Install
10+
11+
```bash
12+
npm i -D @vuepress/plugin-back-to-top@next
13+
```
14+
915
## Styles
1016

1117
You can customize the style of the _back to top_ button via CSS variables:

docs/reference/plugin/container.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ This plugin simplifies the use of [markdown-it-container](https://github.com/mar
88

99
The [Custom Containers](../default-theme/markdown.md#custom-containers) of default theme is powered by this plugin.
1010

11+
## Install
12+
13+
```bash
14+
npm i -D @vuepress/plugin-container@next
15+
```
16+
1117
## Container Syntax
1218

1319
```md

docs/reference/plugin/debug.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,9 @@
33
<NpmBadge package="@vuepress/plugin-debug" />
44

55
This plugin will add a debug component to your site. The component will only take effect in development mode.
6+
7+
## Install
8+
9+
```bash
10+
npm i -D @vuepress/plugin-debug@next
11+
```

docs/reference/plugin/docsearch.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Default theme will add DocSearch to the navbar once you configure this plugin co
1010
This plugin may not be used directly in other themes, so you'd better refer to the documentation of your theme for more details.
1111
:::
1212

13+
## Install
14+
15+
```bash
16+
npm i -D @vuepress/plugin-docsearch@next
17+
```
18+
1319
## Get Search Index
1420

1521
You need to [submit the URL of your site](https://docsearch.algolia.com/apply/) to join the DocSearch program. The DocSearch team will send [apiKey](#apikey) and [indexName](#indexname) to your email once the index is generated. Then you can configure this plugin to enable DocSearch in VuePress.

docs/reference/plugin/git.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ The [lastUpdated](../default-theme/config.md#lastupdated) and [contributors](../
88

99
This plugin is mainly used to develop themes. You won't need to use it directly in most cases.
1010

11+
## Install
12+
13+
```bash
14+
npm i -D @vuepress/plugin-git@next
15+
```
16+
1117
## Git Repository
1218

1319
This plugin requires your project to be inside a [Git Repository](https://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository), so that it can collect information from the commit history.

docs/reference/plugin/google-analytics.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Integrate [Google Analytics](https://analytics.google.com/) into VuePress.
66

77
This plugin will import [gtag.js](https://developers.google.com/analytics/devguides/collection/gtagjs) for [Google Analytics 4](https://support.google.com/analytics/answer/10089681).
88

9+
## Install
10+
11+
```bash
12+
npm i -D @vuepress/plugin-google-analytics@next
13+
```
14+
915
## Reporting Events
1016

1117
Google Analytics will [automatically collect some events](https://support.google.com/analytics/answer/9234069), such as `page_view`, `first_visit`, etc.

docs/reference/plugin/medium-zoom.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Integrate [medium-zoom](https://github.com/francoischalifour/medium-zoom#readme)
66

77
This plugin has been integrated into the default theme.
88

9+
## Install
10+
11+
```bash
12+
npm i -D @vuepress/plugin-medium-zoom@next
13+
```
14+
915
## Options
1016

1117
### selector

docs/reference/plugin/nprogress.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ Integrate [nprogress](https://github.com/rstacruz/nprogress) into VuePress, whic
1414

1515
This plugin has been integrated into the default theme.
1616

17+
## Install
18+
19+
```bash
20+
npm i -D @vuepress/plugin-nprogress@next
21+
```
22+
1723
## Styles
1824

1925
You can customize the style of the progress bar via CSS variables:

docs/reference/plugin/palette.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ This plugin is mainly used to develop themes, and has been integrated into the d
88

99
For theme authors, this plugin will help you to provide styles customization for users.
1010

11+
## Install
12+
13+
```bash
14+
npm i -D @vuepress/plugin-palette@next
15+
```
16+
1117
## Palette and Style
1218

1319
This plugin will provide a `@vuepress/plugin-palette/palette` (palette file) and a `@vuepress/plugin-palette/style` (style file) to be imported in your theme styles.

0 commit comments

Comments
 (0)