refactor(plugin-nprogress): add jsdoc

Author: Mister-Hope

docs/plugins/features/nprogress.md

@@ -6,7 +6,7 @@ icon: pajamas:progress
 
 <NpmBadge package="@vuepress/plugin-nprogress" />
 
-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.
 

docs/zh/plugins/features/nprogress.md

@@ -6,7 +6,7 @@ icon: pajamas:progress
 
 <NpmBadge package="@vuepress/plugin-nprogress" />
 
-将 [nprogress](https://github.com/rstacruz/nprogress) 集成到 VuePress 中，在切换到另一个页面时会展示进度条。
+将 [nprogress](https://github.com/rstacruz/nprogress) 集成到 VuePress 中，在切换到另一个页面时提供进度条。
 
 该插件已经集成到默认主题中。
 

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

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',