docs: active-header-links

vuejs · Nov 5, 2018 · 985471b · 985471b
1 parent 3a79635
commit 985471b
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 0 deletions.
diff --git a/packages/docs/docs/.vuepress/config.js b/packages/docs/docs/.vuepress/config.js
@@ -134,6 +134,7 @@ function getPluginSidebar (pluginTitle, pluginIntro, officialPluginTitle) {
       collapsable: false,
       children: [
         'official/plugin-search',
+        'official/plugin-active-header-links',
         'official/plugin-pwa',
         'official/plugin-blog',
         'official/plugin-pagination',

diff --git a/packages/docs/docs/plugin/official/plugin-active-header-links.md b/packages/docs/docs/plugin/official/plugin-active-header-links.md
@@ -0,0 +1,35 @@
+---
+title: active-header-links
+---
+
+# @vuepress/plugin-active-header-links
+
+> A plugin of automatically update header links when page scrolls
+
+## Install
+
+```bash
+yarn add -D @vuepress/plugin-active-header-links
+# OR npm install -D @vuepress/plugin-active-header-links
+```
+
+## Usage
+
+```javascript
+module.exports = {
+  plugins: ['@vuepress/active-header-links'] 
+}
+```
+
+## Options
+
+### sidebarLinkSelector
+
+- Type: `string`
+- Default: `.sidebar-link`
+
+### headerAnchorSelector
+
+- Type: `string`
+- Default: `.header-anchor'`
+
diff --git a/packages/docs/docs/zh/plugin/official/plugin-active-header-links.md b/packages/docs/docs/zh/plugin/official/plugin-active-header-links.md
@@ -0,0 +1,34 @@
+---
+title: active-header-links
+---
+
+# @vuepress/plugin-active-header-links
+
+> 页面滚动时自动更新标题链接的插件
+## Install
+
+```bash
+yarn add -D @vuepress/plugin-active-header-links
+# OR npm install -D @vuepress/plugin-active-header-links
+```
+
+## Usage
+
+```javascript
+module.exports = {
+  plugins: ['@vuepress/active-header-links'] 
+}
+```
+
+## Options
+
+### sidebarLinkSelector
+
+- Type: `string`
+- Default: `.sidebar-link`
+
+### headerAnchorSelector
+
+- Type: `string`
+- Default: `.header-anchor'`
+