vitepress-plugin-nprogress

vitepress-plugin-nprogress

Nprogress plugin for Vitepress

Install

pnpm add -D vitepress-plugin-nprogress
# OR yarn add -D vitepress-plugin-nprogress
# OR npm install -D vitepress-plugin-nprogress

Usage

// .vitepress/theme/index.ts
import type { EnhanceAppContext } from 'vitepress'
import DefaultTheme from "vitepress/theme"

import vitepressNprogress from 'vitepress-plugin-nprogress'
import 'vitepress-plugin-nprogress/lib/css/index.css'

export default {
  ...DefaultTheme,
  enhanceApp: (ctx: EnhanceAppContext) => {
    vitepressNprogress(ctx)
  }
}

Tips

If got TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".css" for ***/node_modules/nprogress/nprogress.css error when you build,

you can config like this in your vite.config.ts:

// vite.config.ts
import {defineConfig} from 'vite'

export default defineConfig({
  ssr: {
    noExternal: ['vitepress-plugin-nprogress']
  },
})

Then you can use nprogress ! 🎉