Skip to content

Commit 985471b

Browse files
committed
docs: active-header-links
1 parent 3a79635 commit 985471b

File tree

3 files changed

+70
-0
lines changed

3 files changed

+70
-0
lines changed

packages/docs/docs/.vuepress/config.js

+1
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ function getPluginSidebar (pluginTitle, pluginIntro, officialPluginTitle) {
134134
collapsable: false,
135135
children: [
136136
'official/plugin-search',
137+
'official/plugin-active-header-links',
137138
'official/plugin-pwa',
138139
'official/plugin-blog',
139140
'official/plugin-pagination',
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: active-header-links
3+
---
4+
5+
# @vuepress/plugin-active-header-links
6+
7+
> A plugin of automatically update header links when page scrolls
8+
9+
## Install
10+
11+
```bash
12+
yarn add -D @vuepress/plugin-active-header-links
13+
# OR npm install -D @vuepress/plugin-active-header-links
14+
```
15+
16+
## Usage
17+
18+
```javascript
19+
module.exports = {
20+
plugins: ['@vuepress/active-header-links']
21+
}
22+
```
23+
24+
## Options
25+
26+
### sidebarLinkSelector
27+
28+
- Type: `string`
29+
- Default: `.sidebar-link`
30+
31+
### headerAnchorSelector
32+
33+
- Type: `string`
34+
- Default: `.header-anchor'`
35+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: active-header-links
3+
---
4+
5+
# @vuepress/plugin-active-header-links
6+
7+
> 页面滚动时自动更新标题链接的插件
8+
## Install
9+
10+
```bash
11+
yarn add -D @vuepress/plugin-active-header-links
12+
# OR npm install -D @vuepress/plugin-active-header-links
13+
```
14+
15+
## Usage
16+
17+
```javascript
18+
module.exports = {
19+
plugins: ['@vuepress/active-header-links']
20+
}
21+
```
22+
23+
## Options
24+
25+
### sidebarLinkSelector
26+
27+
- Type: `string`
28+
- Default: `.sidebar-link`
29+
30+
### headerAnchorSelector
31+
32+
- Type: `string`
33+
- Default: `.header-anchor'`
34+

0 commit comments

Comments
 (0)