---
title: nprogress
metaTitle: Nprogress Plugin | VuePress
---

# [@vuepress/plugin-nprogress](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-nprogress)

> A progress bar plugin based on [nprogress](https://github.com/rstacruz/nprogress). <Badge text="1.0.0-alpha.31+"/>

## Install

```bash
yarn add -D @vuepress/plugin-nprogress@next
# OR npm install -D @vuepress/plugin-nprogress@next
```

## Usage

```javascript
module.exports = {
  plugins: ['@vuepress/nprogress']
}
```

## Custom color

Set `$nprogressColor` in your __site__ or __theme__ `palette.styl` file to change the color of the progress bar (default is `$accentColor`).

```stylus
// .vuepress/styles/palette.styl
// or
// .vuepress/theme/styles/palette.styl

$nprogressColor = red
```

**Also see:**

- [Config Reference > Styling](../../config/README.md#styling)
