Skip to main content


Less than 1 minute



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.

This plugin has been integrated into the default theme.


npm i -D @vuepress/plugin-back-to-top@next
import { backToTopPlugin } from "@vuepress/plugin-back-to-top";

export default {
  plugins: [backToTopPlugin()],


You can customize the style of the back to top button via CSS variables:

:root {
  --back-to-top-z-index: 5;

  --back-to-top-color: #3eaf7c;
  --back-to-top-color-hover: #71cda3;