HomeLogo

vuepress-theme-hope

A vuepress theme with tons of features✨

Get Started 💡Config 🛠

# 🛠Install

Create a vuepress-theme-hope project in [dir] folder under the current project:

yarn create vuepress-theme-hope [dir]
1
npm init vuepress-theme-hope [dir]
1

# 🚀Usage


 

 

 

// .vuepress/config.ts
import theme from "vuepress-theme-hope";

export default theme.config({
  // your config here
});
1
2
3
4
5
6

 

 

 

// .vuepress/config.js
const { config } = require("vuepress-theme-hope");

module.exports = config({
  // your config here
});
1
2
3
4
5
6

Tips

config is just a helper function, it will give you config description and provide auto-completion through TS’s Interface and JSDoc.

At the same time, the config function will also complete some default configurations for your current configuration which will pass directly to VuePress. Don’t worry it will change your config! It will respect every config you make to make sure your other plugins work well.

We are also providing themeConfig, navbarConfig and sidebarConfig helper to provide similar experience in case you split your config in to several files.

You can view Config of this site (opens new window) as an example.

📢 V2 is ready

We welcome you to switch to "Next" tag using the V2 version of the theme based on VuePress2.
The V2 version has been completely refactored, with richer functions and better outlook. The theme is based on Vue3, built with Vite by default, and the performance and startup speed have been greatly improved!"