Skip to content

Commit

Permalink
docs: add npm links for plugins (#96)
Browse files Browse the repository at this point in the history
Co-authored-by: meteorlxy <[email protected]>
  • Loading branch information
Yue-plus and meteorlxy authored Apr 9, 2021
1 parent 0294b7a commit 04be615
Show file tree
Hide file tree
Showing 30 changed files with 32 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/reference/plugin/active-header-links.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# active-header-links

> @vuepress/plugin-active-header-links
> [@vuepress/plugin-active-header-links](https://www.npmjs.com/package/@vuepress/plugin-active-header-links)
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_.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/back-to-top.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# back-to-top

> @vuepress/plugin-back-to-top
> [@vuepress/plugin-back-to-top](https://www.npmjs.com/package/@vuepress/plugin-back-to-top)
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.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/container.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# container

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/debug.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# debug

> @vuepress/plugin-debug
> [@vuepress/plugin-debug](https://www.npmjs.com/package/@vuepress/plugin-debug)
This plugin will add a debug component to your site. The component will only take effect in development mode.
2 changes: 1 addition & 1 deletion docs/reference/plugin/docsearch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# docsearch

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/git.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# git

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/google-analytics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# google-analytics

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/medium-zoom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# medium-zoom

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/nprogress.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: nprogress

# nprogress Plugin

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

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/plugin/palette.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# palette

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

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/prismjs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# prismjs

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/pwa-popup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pwa-popup

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/pwa.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pwa

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/shiki.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# shiki

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin/theme-data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# theme-data

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/active-header-links.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# active-header-links

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/back-to-top.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# back-to-top

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/container.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# container

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/debug.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# debug

> @vuepress/plugin-debug
> [@vuepress/plugin-debug](https://www.npmjs.com/package/@vuepress/plugin-debug)
该插件会给你的站点添加一个 Debug 组件。该组件仅会在开发模式下生效。
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/docsearch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# docsearch

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/git.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# git

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/google-analytics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# google-analytics

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/medium-zoom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# medium-zoom

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/nprogress.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: nprogress

# nprogress 插件

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

Expand Down
2 changes: 2 additions & 0 deletions docs/zh/reference/plugin/palette.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# palette

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

该插件主要用于开发主题,并且已经集成到默认主题中。大部分情况下你不需要直接使用它。
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/prismjs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# prismjs

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/pwa-popup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pwa-popup

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/pwa.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pwa

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/shiki.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# shiki

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin/theme-data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# theme-data

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

Expand Down

0 comments on commit 04be615

Please sign in to comment.