diff --git a/docs/plugins/features/nprogress.md b/docs/plugins/features/nprogress.md index 5719974a95..011cee8349 100644 --- a/docs/plugins/features/nprogress.md +++ b/docs/plugins/features/nprogress.md @@ -6,7 +6,7 @@ icon: pajamas:progress -Integrate [nprogress](https://github.com/rstacruz/nprogress) into VuePress, which can provide a progress bar when navigating to another page. +Integrate [nprogress](https://github.com/rstacruz/nprogress) into VuePress, which provides a progress bar when navigating to another page. This plugin has been integrated into the default theme. diff --git a/docs/zh/plugins/features/nprogress.md b/docs/zh/plugins/features/nprogress.md index bd220ff695..a180c17b52 100644 --- a/docs/zh/plugins/features/nprogress.md +++ b/docs/zh/plugins/features/nprogress.md @@ -6,7 +6,7 @@ icon: pajamas:progress -将 [nprogress](https://github.com/rstacruz/nprogress) 集成到 VuePress 中,在切换到另一个页面时会展示进度条。 +将 [nprogress](https://github.com/rstacruz/nprogress) 集成到 VuePress 中,在切换到另一个页面时提供进度条。 该插件已经集成到默认主题中。 diff --git a/plugins/features/plugin-nprogress/src/client/composables/useNprogress.ts b/plugins/features/plugin-nprogress/src/client/composables/useNprogress.ts index 354b55c30f..f90ea8370c 100644 --- a/plugins/features/plugin-nprogress/src/client/composables/useNprogress.ts +++ b/plugins/features/plugin-nprogress/src/client/composables/useNprogress.ts @@ -5,6 +5,11 @@ import { nprogress } from '../nprogress.js' import '../styles/vars.css' import '../styles/nprogress.css' +/** + * Use nprogress + * + * 使用 nprogress + */ export const useNprogress = (): void => { onMounted(() => { // get vue-router instance diff --git a/plugins/features/plugin-nprogress/src/node/nprogressPlugin.ts b/plugins/features/plugin-nprogress/src/node/nprogressPlugin.ts index 2491dd41c6..612d74127d 100644 --- a/plugins/features/plugin-nprogress/src/node/nprogressPlugin.ts +++ b/plugins/features/plugin-nprogress/src/node/nprogressPlugin.ts @@ -3,6 +3,20 @@ import { getDirname, path } from 'vuepress/utils' const __dirname = import.meta.dirname || getDirname(import.meta.url) +/** + * NProgress plugin for VuePress + * + * VuePress 的 NProgress 插件 + * + * @example + * ```ts + * import { nprogressPlugin } from '@vuepress/plugin-nprogress' + * + * export default { + * plugins: [nprogressPlugin()], + * } + * ``` + */ export const nprogressPlugin = (): Plugin => ({ name: '@vuepress/plugin-nprogress',