Skip to content

Commit 04be615

Browse files
Yue-plusmeteorlxy
andauthored
docs: add npm links for plugins (#96)
Co-authored-by: meteorlxy <[email protected]>
1 parent 0294b7a commit 04be615

30 files changed

+32
-28
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# active-header-links
22

3-
> @vuepress/plugin-active-header-links
3+
> [@vuepress/plugin-active-header-links](https://www.npmjs.com/package/@vuepress/plugin-active-header-links)
44
55
This plugin will listen to page scroll event. When the page scrolls to a certain _header anchor_, this plugin will change the route hash to that _header anchor_ if there is a corresponding _header link_.
66

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# back-to-top
22

3-
> @vuepress/plugin-back-to-top
3+
> [@vuepress/plugin-back-to-top](https://www.npmjs.com/package/@vuepress/plugin-back-to-top)
44
55
This plugin will add a _back to top_ button to your site. The button will be displayed in the bottom right corner of the page when scrolling down. By clicking the button, the page will scroll to the top.
66

docs/reference/plugin/container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# container
22

3-
> @vuepress/plugin-container
3+
> [@vuepress/plugin-container](https://www.npmjs.com/package/@vuepress/plugin-container)
44
55
Register markdown custom containers in your VuePress site.
66

docs/reference/plugin/debug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# debug
22

3-
> @vuepress/plugin-debug
3+
> [@vuepress/plugin-debug](https://www.npmjs.com/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.

docs/reference/plugin/docsearch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# docsearch
22

3-
> @vuepress/plugin-docsearch
3+
> [@vuepress/plugin-docsearch](https://www.npmjs.com/package/@vuepress/plugin-docsearch)
44
55
Integrate [Algolia DocSearch](https://docsearch.algolia.com/) into VuePress, which can provide search to your documentation site.
66

docs/reference/plugin/git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# git
22

3-
> @vuepress/plugin-git
3+
> [@vuepress/plugin-git](https://www.npmjs.com/package/@vuepress/plugin-git)
44
55
This plugin will collect git information of your pages, including the created and updated time, the contributors, etc.
66

docs/reference/plugin/google-analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# google-analytics
22

3-
> @vuepress/plugin-google-analytics
3+
> [@vuepress/plugin-google-analytics](https://www.npmjs.com/package/@vuepress/plugin-google-analytics)
44
55
Integrate [Google Analytics](https://analytics.google.com/) into VuePress.
66

docs/reference/plugin/medium-zoom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# medium-zoom
22

3-
> @vuepress/plugin-medium-zoom
3+
> [@vuepress/plugin-medium-zoom](https://www.npmjs.com/package/@vuepress/plugin-medium-zoom)
44
55
Integrate [medium-zoom](https://github.com/francoischalifour/medium-zoom#readme) into VuePress, which can provide the ability to zoom images.
66

docs/reference/plugin/nprogress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: nprogress
88

99
# nprogress Plugin
1010

11-
> @vuepress/plugin-nprogress
11+
> [@vuepress/plugin-nprogress](https://www.npmjs.com/package/@vuepress/plugin-nprogress)
1212
1313
Integrate [nprogress](https://github.com/rstacruz/nprogress) into VuePress, which can provide a progress bar when navigating to another page.
1414

docs/reference/plugin/palette.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# palette
22

3+
> [@vuepress/plugin-palette](https://www.npmjs.com/package/@vuepress/plugin-palette)
4+
35
Provide palette support for your theme.
46

57
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.

docs/reference/plugin/prismjs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# prismjs
22

3-
> @vuepress/plugin-prismjs
3+
> [@vuepress/plugin-prismjs](https://www.npmjs.com/package/@vuepress/plugin-prismjs)
44
55
This plugin will enable syntax highlighting for markdown code fence with [Prism.js](https://prismjs.com/).
66

docs/reference/plugin/pwa-popup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# pwa-popup
22

3-
> @vuepress/plugin-pwa-popup
3+
> [@vuepress/plugin-pwa-popup](https://www.npmjs.com/package/@vuepress/plugin-pwa-popup)
44
55
Provide a popup component for users to activate the new PWA service worker manually.
66

docs/reference/plugin/pwa.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# pwa
22

3-
> @vuepress/plugin-pwa
3+
> [@vuepress/plugin-pwa](https://www.npmjs.com/package/@vuepress/plugin-pwa)
44
55
Make your VuePress site a [Progressive Web Application (PWA)](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps).
66

docs/reference/plugin/shiki.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# shiki
22

3-
> @vuepress/plugin-shiki
3+
> [@vuepress/plugin-shiki](https://www.npmjs.com/package/@vuepress/plugin-shiki)
44
55
This plugin will enable syntax highlighting for markdown code fence with [Shiki](https://shiki.matsu.io/).
66

docs/reference/plugin/theme-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# theme-data
22

3-
> @vuepress/plugin-theme-data
3+
> [@vuepress/plugin-theme-data](https://www.npmjs.com/package/@vuepress/plugin-theme-data)
44
55
Provide client data for your theme, with VuePress [i18n](../../guide/i18n.md) support.
66

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# active-header-links
22

3-
> @vuepress/plugin-active-header-links
3+
> [@vuepress/plugin-active-header-links](https://www.npmjs.com/package/@vuepress/plugin-active-header-links)
44
55
该插件会监听页面滚动事件。当页面滚动至某个 _标题锚点_ 后,如果存在对应的 _标题链接_ ,那么该插件会将路由 Hash 更改为该 _标题锚点_
66

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# back-to-top
22

3-
> @vuepress/plugin-back-to-top
3+
> [@vuepress/plugin-back-to-top](https://www.npmjs.com/package/@vuepress/plugin-back-to-top)
44
55
该插件会给你的站点添加一个 _返回顶部_ 按钮。当页面向下滚动时,该按钮会显示在页面的右下角,点击它就会滚动到页面顶部。
66

docs/zh/reference/plugin/container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# container
22

3-
> @vuepress/plugin-container
3+
> [@vuepress/plugin-container](https://www.npmjs.com/package/@vuepress/plugin-container)
44
55
为你的 VuePress 站点注册自定义容器。
66

docs/zh/reference/plugin/debug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# debug
22

3-
> @vuepress/plugin-debug
3+
> [@vuepress/plugin-debug](https://www.npmjs.com/package/@vuepress/plugin-debug)
44
55
该插件会给你的站点添加一个 Debug 组件。该组件仅会在开发模式下生效。

docs/zh/reference/plugin/docsearch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# docsearch
22

3-
> @vuepress/plugin-docsearch
3+
> [@vuepress/plugin-docsearch](https://www.npmjs.com/package/@vuepress/plugin-docsearch)
44
55
[Algolia DocSearch](https://docsearch.algolia.com/) 集成到 VuePress 中,为你的文档网站提供搜索功能。
66

docs/zh/reference/plugin/git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# git
22

3-
> @vuepress/plugin-git
3+
> [@vuepress/plugin-git](https://www.npmjs.com/package/@vuepress/plugin-git)
44
55
该插件会收集你的页面的 Git 信息,包括创建和更新时间、贡献者等。
66

docs/zh/reference/plugin/google-analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# google-analytics
22

3-
> @vuepress/plugin-google-analytics
3+
> [@vuepress/plugin-google-analytics](https://www.npmjs.com/package/@vuepress/plugin-google-analytics)
44
55
[Google Analytics](https://analytics.google.com/) 集成到 VuePress 中。
66

docs/zh/reference/plugin/medium-zoom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# medium-zoom
22

3-
> @vuepress/plugin-medium-zoom
3+
> [@vuepress/plugin-medium-zoom](https://www.npmjs.com/package/@vuepress/plugin-medium-zoom)
44
55
[medium-zoom](https://github.com/francoischalifour/medium-zoom#readme) 集成到 VuePress 中,为图片提供可缩放的功能。
66

docs/zh/reference/plugin/nprogress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: nprogress
88

99
# nprogress 插件
1010

11-
> @vuepress/plugin-nprogress
11+
> [@vuepress/plugin-nprogress](https://www.npmjs.com/package/@vuepress/plugin-nprogress)
1212
1313
[nprogress](https://github.com/rstacruz/nprogress) 集成到 VuePress 中,在切换到另一个页面时会展示进度条。
1414

docs/zh/reference/plugin/palette.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# palette
22

3+
> [@vuepress/plugin-palette](https://www.npmjs.com/package/@vuepress/plugin-palette)
4+
35
为你的主题提供调色板功能。
46

57
该插件主要用于开发主题,并且已经集成到默认主题中。大部分情况下你不需要直接使用它。

docs/zh/reference/plugin/prismjs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# prismjs
22

3-
> @vuepress/plugin-prismjs
3+
> [@vuepress/plugin-prismjs](https://www.npmjs.com/package/@vuepress/plugin-prismjs)
44
55
该插件使用 [Prism.js](https://prismjs.com/) 来为 Markdown 代码块启用代码高亮。
66

docs/zh/reference/plugin/pwa-popup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# pwa-popup
22

3-
> @vuepress/plugin-pwa-popup
3+
> [@vuepress/plugin-pwa-popup](https://www.npmjs.com/package/@vuepress/plugin-pwa-popup)
44
55
提供一个弹窗组件,允许用户手动刷新 PWA Service Worker 。
66

docs/zh/reference/plugin/pwa.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# pwa
22

3-
> @vuepress/plugin-pwa
3+
> [@vuepress/plugin-pwa](https://www.npmjs.com/package/@vuepress/plugin-pwa)
44
55
使你的 VuePress 站点成为一个 [渐进式 Web 应用 (PWA)](https://developer.mozilla.org/zh-CN/docs/Web/Progressive_web_apps).
66

docs/zh/reference/plugin/shiki.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# shiki
22

3-
> @vuepress/plugin-shiki
3+
> [@vuepress/plugin-shiki](https://www.npmjs.com/package/@vuepress/plugin-shiki)
44
55
该插件使用 [Shiki](https://shiki.matsu.io/) 来为 Markdown 代码块启用代码高亮。
66

docs/zh/reference/plugin/theme-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# theme-data
22

3-
> @vuepress/plugin-theme-data
3+
> [@vuepress/plugin-theme-data](https://www.npmjs.com/package/@vuepress/plugin-theme-data)
44
55
为你的主题提供客户端数据,包含 VuePress 的 [多语言支持](../../guide/i18n.md)
66

0 commit comments

Comments
 (0)